Package me.zhyd.oauth.config
Interface AuthSource
- All Known Implementing Classes:
AuthDefaultSource
public interface AuthSource
OAuth平台的API地址的统一接口,提供以下方法:
1)
authorize(): 获取授权url. 必须实现
2) accessToken(): 获取accessToken的url. 必须实现
3) userInfo(): 获取用户信息的url. 必须实现
4) revoke(): 获取取消授权的url. 非必须实现接口(部分平台不支持)
5) refresh(): 获取刷新授权的url. 非必须实现接口(部分平台不支持)
注:
①、如需通过JustAuth扩展实现第三方授权,请参考AuthDefaultSource自行创建对应的枚举类并实现AuthSource接口
②、如果不是使用的枚举类,那么在授权成功后获取用户信息时,需要单独处理source字段的赋值
③、如果扩展了对应枚举类时,在AuthRequest.login(AuthCallback)中可以通过xx.toString()获取对应的source
- Since:
- 1.12.0
- Version:
- 1.0
- Author:
- yadong.zhang (yadong.zhang0415(a)gmail.com)
-
Method Summary
Modifier and TypeMethodDescription获取accessToken的api授权的apidefault StringgetName()获取Source的字符串名字Class<? extends AuthDefaultRequest>平台对应的 AuthRequest 实现类,必须继承自AuthDefaultRequestdefault Stringrefresh()刷新授权的apidefault Stringrevoke()取消授权的apiuserInfo()获取用户信息的api
-
Method Details
-
authorize
String authorize()授权的api- Returns:
- url
-
accessToken
String accessToken()获取accessToken的api- Returns:
- url
-
userInfo
String userInfo()获取用户信息的api- Returns:
- url
-
revoke
取消授权的api- Returns:
- url
-
refresh
刷新授权的api- Returns:
- url
-
getName
获取Source的字符串名字- Returns:
- name
-
getTargetClass
Class<? extends AuthDefaultRequest> getTargetClass()平台对应的 AuthRequest 实现类,必须继承自AuthDefaultRequest- Returns:
- class
-