DefaultProvider (bus-all 5.6.6 API)

java.lang.Object
- org.aoju.bus.oauth.provider.DefaultProvider

All Implemented Interfaces:

Provider

Direct Known Subclasses:

AlipayProvider, BaiduProvider, CodingProvider, CsdnProvider, DingTalkProvider, DouyinProvider, ElemeProvider, FacebookProvider, GiteeProvider, GithubProvider, GitlabProvider, GoogleProvider, HuaweiProvider, KujialeProvider, LinkedinProvider, MeituanProvider, MicrosoftProvider, MiProvider, OschinaProvider, PinterestProvider, QqProvider, RenrenProvider, StackOverflowProvider, TaobaoProvider, TeambitionProvider, TencentCloudProvider, ToutiaoProvider, WeChatEEProvider, WeChatMpProvider, WeChatOPProvider, WeiboProvider
```
public abstract class DefaultProvider
extends Object
implements Provider
```
默认的request处理类

Since:

JDK 1.8+

Version:

5.6.6

Author:

Kimi Liu

Field Summary

Fields
Modifier and Type Field and Description

protected Context context

protected Complex source

protected StateCache stateCache

Fields
Modifier and Type	Field and Description
`protected Context`	`context`
`protected Complex`	`source`
`protected StateCache`	`stateCache`

Constructor Summary

Constructors
Constructor and Description
`DefaultProvider(Context context, Complex source)`
`DefaultProvider(Context context, Complex source, StateCache stateCache)`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected String`	`accessTokenUrl(String code)` 返回获取accessToken的url
`String`	`authorize(String state)` 返回带`state`参数的授权url,授权回调时会带上这个`state`
`static void`	`checkCode(Complex complex, Callback callback)` 校验回调传回的code
`static void`	`checkcontext(Context context, Complex source)` 检查配置合法性针对部分平台, 对redirect uri有特定要求一般来说redirect uri都是http://,而对于facebook平台, redirect uri 必须是https的链接
`protected void`	`checkState(String state)` 校验回调传回的state
`protected String`	`doGetAuthorizationCode(String code)` 通用的 authorizationCode 协议
`protected String`	`doGetRevoke(AccToken token)` 通用的post形式的取消授权方法
`protected String`	`doGetUserInfo(AccToken token)` 通用的用户信息
`protected String`	`doPostAuthorizationCode(String code)` 通用的 authorizationCode 协议
`static String`	`generateDingTalkSignature(String secretKey, String timestamp)` 生成钉钉请求的Signature
`static String`	`generateElemeSignature(String appKey, String secret, long timestamp, String action, String token, Map<String,Object> parameters)` 生成饿了么请求的Signature
`protected abstract AccToken`	`getAccessToken(Callback Callback)` 获取access token
`protected String`	`getRealState(String state)` 获取state,如果为空, 则默认取当前日期的时间戳
`protected abstract Object`	`getUserInfo(AccToken token)` 使用token换取用户信息
`static boolean`	`isHttpProtocol(String url)` 是否为http协议
`static boolean`	`isHttpsProtocol(String url)` 是否为https协议
`static boolean`	`isLocalHost(String url)` 是否为本地主机（域名）
`static boolean`	`isSupportedAuth(Context context, Complex source)` 是否支持第三方登录
`Message`	`login(Callback Callback)` 统一的登录入口当通过`authorize(String)`授权成功后,会跳转到调用方的相关回调方法中方法的入参可以使用`AuthCallback`,`AuthCallback`类中封装好了OAuth2授权回调所需要的参数
`static Map<String,Object>`	`parseQueryToMap(String url)` 将url的参数列表转换成map
`static Map<String,String>`	`parseStringToMap(String accessTokenStr)` string字符串转map,str格式为 `xxx=xxx&xxx=xxx`
`protected String`	`refreshTokenUrl(String refreshToken)` 返回获取accessToken的url
`protected String`	`revokeUrl(AccToken token)` 返回获取revoke authorization的url
`static String`	`urlDecode(String value)` 解码
`static String`	`urlEncode(String value)` 编码
`protected String`	`userInfoUrl(AccToken token)` 返回获取userInfo的url

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.aoju.bus.oauth.Provider
refresh, revoke

- Field Detail
  - context
```
protected Context context
```
  - source
```
protected Complex source
```
  - stateCache
```
protected StateCache stateCache
```
- Constructor Detail
  - DefaultProvider
```
public DefaultProvider(Context context,
                       Complex source)
```
  - DefaultProvider
```
public DefaultProvider(Context context,
                       Complex source,
                       StateCache stateCache)
```
- Method Detail
  - generateDingTalkSignature
```
public static String generateDingTalkSignature(String secretKey,
                                               String timestamp)
```
    生成钉钉请求的Signature
    
    Parameters:
    
    secretKey - 平台应用的授权密钥
    
    timestamp - 时间戳
    
    Returns:
    
    Signature
  - urlEncode
```
public static String urlEncode(String value)
```
    编码
    
    Parameters:
    
    value - str
    
    Returns:
    
    encode str
  - urlDecode
```
public static String urlDecode(String value)
```
    解码
    
    Parameters:
    
    value - str
    
    Returns:
    
    decode str
  - parseStringToMap
```
public static Map<String,String> parseStringToMap(String accessTokenStr)
```
    string字符串转map,str格式为 xxx=xxx&xxx=xxx
    
    Parameters:
    
    accessTokenStr - 待转换的字符串
    
    Returns:
    
    map
  - parseQueryToMap
```
public static Map<String,Object> parseQueryToMap(String url)
```
    将url的参数列表转换成map
    
    Parameters:
    
    url - 待转换的url
    
    Returns:
    
    map
  - isHttpProtocol
```
public static boolean isHttpProtocol(String url)
```
    是否为http协议
    
    Parameters:
    
    url - 待验证的url
    
    Returns:
    
    true: http协议, false: 非http协议
  - isHttpsProtocol
```
public static boolean isHttpsProtocol(String url)
```
    是否为https协议
    
    Parameters:
    
    url - 待验证的url
    
    Returns:
    
    true: https协议, false: 非https协议
  - isLocalHost
```
public static boolean isLocalHost(String url)
```
    是否为本地主机（域名）
    
    Parameters:
    
    url - 待验证的url
    
    Returns:
    
    true: 本地主机（域名）, false: 非本地主机（域名）
  - generateElemeSignature
```
public static String generateElemeSignature(String appKey,
                                            String secret,
                                            long timestamp,
                                            String action,
                                            String token,
                                            Map<String,Object> parameters)
```
    生成饿了么请求的Signature
    代码copy并修改自：https://coding.net/u/napos_openapi/p/eleme-openapi-java-sdk/git/blob/master/src/main/java/eleme/openapi/sdk/utils/SignatureUtil.java
    
    Parameters:
    
    appKey - 平台应用的授权key
    
    secret - 平台应用的授权密钥
    
    timestamp - 时间戳,单位秒 API服务端允许客户端请求最大时间误差为正负5分钟
    
    action - 饿了么请求的api方法
    
    token - 用户授权的token
    
    parameters - 加密参数
    
    Returns:
    
    Signature
  - isSupportedAuth
```
public static boolean isSupportedAuth(Context context,
                                      Complex source)
```
    是否支持第三方登录
    
    Parameters:
    
    context - context
    
    source - source
    
    Returns:
    
    true or false
    
    Since:
    
    1.6.2
  - checkcontext
```
public static void checkcontext(Context context,
                                Complex source)
```
    检查配置合法性针对部分平台, 对redirect uri有特定要求一般来说redirect uri都是http://,而对于facebook平台, redirect uri 必须是https的链接
    
    Parameters:
    
    context - context
    
    source - source
    
    Since:
    
    1.6.2
  - checkCode
```
public static void checkCode(Complex complex,
                             Callback callback)
```
    校验回调传回的code
    v1.10.0版本中改为传入source和callback,对于不同平台使用不同参数接受code的情况统一做处理
    
    Parameters:
    
    complex - 当前授权平台
    
    callback - 从第三方授权回调回来时传入的参数集合
    
    Since:
    
    1.8.0
  - getAccessToken
```
protected abstract AccToken getAccessToken(Callback Callback)
```
    获取access token
    
    Parameters:
    
    Callback - 授权成功后的回调参数
    
    Returns:
    
    token
    
    See Also:
    
    authorize(String)
  - getUserInfo
```
protected abstract Object getUserInfo(AccToken token)
```
    使用token换取用户信息
    
    Parameters:
    
    token - token信息
    
    Returns:
    
    用户信息
    
    See Also:
    
    getAccessToken(Callback)
  - login
```
public Message login(Callback Callback)
```
    统一的登录入口当通过authorize(String)授权成功后,会跳转到调用方的相关回调方法中方法的入参可以使用AuthCallback,AuthCallback类中封装好了OAuth2授权回调所需要的参数
    
    Specified by:
    
    login in interface Provider
    
    Parameters:
    
    Callback - 用于接收回调参数的实体
    
    Returns:
    
    AuthResponse
  - authorize
```
public String authorize(String state)
```
    返回带state参数的授权url,授权回调时会带上这个state
    
    Specified by:
    
    authorize in interface Provider
    
    Parameters:
    
    state - state 验证授权流程的参数,可以防止csrf
    
    Returns:
    
    返回授权地址
    
    Since:
    
    1.9.3
  - accessTokenUrl
```
protected String accessTokenUrl(String code)
```
    返回获取accessToken的url
    
    Parameters:
    
    code - 授权码
    
    Returns:
    
    返回获取accessToken的url
  - refreshTokenUrl
```
protected String refreshTokenUrl(String refreshToken)
```
    返回获取accessToken的url
    
    Parameters:
    
    refreshToken - refreshToken
    
    Returns:
    
    返回获取accessToken的url
  - userInfoUrl
```
protected String userInfoUrl(AccToken token)
```
    返回获取userInfo的url
    
    Parameters:
    
    token - token
    
    Returns:
    
    返回获取userInfo的url
  - revokeUrl
```
protected String revokeUrl(AccToken token)
```
    返回获取revoke authorization的url
    
    Parameters:
    
    token - token
    
    Returns:
    
    返回获取revoke authorization的url
  - getRealState
```
protected String getRealState(String state)
```
    获取state,如果为空, 则默认取当前日期的时间戳
    
    Parameters:
    
    state - 原始的state
    
    Returns:
    
    返回不为null的state
  - doPostAuthorizationCode
```
protected String doPostAuthorizationCode(String code)
```
    通用的 authorizationCode 协议
    
    Parameters:
    
    code - code码
    
    Returns:
    
    HttpResponse
  - doGetAuthorizationCode
```
protected String doGetAuthorizationCode(String code)
```
    通用的 authorizationCode 协议
    
    Parameters:
    
    code - code码
    
    Returns:
    
    HttpResponse
  - doGetUserInfo
```
protected String doGetUserInfo(AccToken token)
```
    通用的用户信息
    
    Parameters:
    
    token - token封装
    
    Returns:
    
    HttpResponse
  - doGetRevoke
```
protected String doGetRevoke(AccToken token)
```
    通用的post形式的取消授权方法
    
    Parameters:
    
    token - token封装
    
    Returns:
    
    HttpResponse
  - checkState
```
protected void checkState(String state)
```
    校验回调传回的state
    
    Parameters:
    
    state - state一定不为空

Class DefaultProvider

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.aoju.bus.oauth.Provider

Field Detail

context

source

stateCache

Constructor Detail

DefaultProvider

DefaultProvider

Method Detail

generateDingTalkSignature

urlEncode

urlDecode

parseStringToMap

parseQueryToMap

isHttpProtocol

isHttpsProtocol

isLocalHost

generateElemeSignature

isSupportedAuth

checkcontext

checkCode

getAccessToken

getUserInfo

login

authorize

accessTokenUrl

refreshTokenUrl

userInfoUrl

revokeUrl

getRealState

doPostAuthorizationCode

doGetAuthorizationCode

doGetUserInfo

doGetRevoke

checkState