top.dcenter.ums.security.core.oauth.justauth.request

类 AuthDefaultRequestAdapter

java.lang.Object

me.zhyd.oauth.request.AuthDefaultRequest

top.dcenter.ums.security.core.oauth.justauth.request.AuthDefaultRequestAdapter

所有已实现的接口:

me.zhyd.oauth.request.AuthRequest, Auth2DefaultRequest

public class AuthDefaultRequestAdapter
extends me.zhyd.oauth.request.AuthDefaultRequest
implements Auth2DefaultRequest

AuthDefaultRequest 的适配器

版本:

V2.0 Created by 2020.11.19 12:35

作者:

YongWu zheng

字段概要

从类继承的字段 me.zhyd.oauth.request.AuthDefaultRequest

authStateCache, config, source

构造器概要

构造器

构造器和说明
AuthDefaultRequestAdapter(me.zhyd.oauth.config.AuthConfig config, me.zhyd.oauth.config.AuthSource source, me.zhyd.oauth.cache.AuthStateCache authStateCache) 构造 AuthDefaultRequest 的适配器

方法概要

限定符和类型	方法和说明
String	authorize(String state) 返回带state参数的授权url，授权回调时会带上这个state
me.zhyd.oauth.model.AuthToken	getAccessToken(me.zhyd.oauth.model.AuthCallback authCallback) 获取access token
me.zhyd.oauth.config.AuthSource	getAuthSource() 获取 AuthSource
me.zhyd.oauth.cache.AuthStateCache	getAuthStateCache() 获取 AuthStateCache
String	getProviderId() 获取第三方 providerId
String	getRealState(String state)
me.zhyd.oauth.model.AuthUser	getUserInfo(me.zhyd.oauth.model.AuthToken authToken) 使用token换取用户信息
me.zhyd.oauth.model.AuthResponse	login(me.zhyd.oauth.model.AuthCallback authCallback) 统一的登录入口。
AuthTokenPo	refreshToken(AuthTokenPo authToken) 刷新access token （续期）
void	setAuthDefaultRequest(me.zhyd.oauth.request.AuthDefaultRequest authDefaultRequest)

从类继承的方法 me.zhyd.oauth.request.AuthDefaultRequest

accessTokenUrl, authorize, doGetAuthorizationCode, doGetRevoke, doGetUserInfo, doPostAuthorizationCode, doPostRevoke, doPostUserInfo, getScopes, refreshTokenUrl, revokeUrl, userInfoUrl

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

从接口继承的方法 top.dcenter.ums.security.core.api.oauth.justauth.request.Auth2DefaultRequest

expireIn2Timestamp, expireIn2Timestamp, generateState, getAuthTokenPo, removeStateCacheOfSessionCache, responseError

从接口继承的方法 me.zhyd.oauth.request.AuthRequest

refresh, revoke

构造器详细资料

AuthDefaultRequestAdapter

public AuthDefaultRequestAdapter(me.zhyd.oauth.config.AuthConfig config,
                                 me.zhyd.oauth.config.AuthSource source,
                                 me.zhyd.oauth.cache.AuthStateCache authStateCache)

构造 AuthDefaultRequest 的适配器

参数:

config - AuthDefaultRequest 的 AuthConfig

source - AuthDefaultRequest 的 AuthSource

authStateCache - AuthDefaultRequest 的 AuthStateCache

方法详细资料

setAuthDefaultRequest

public void setAuthDefaultRequest(me.zhyd.oauth.request.AuthDefaultRequest authDefaultRequest)

getRealState

public String getRealState(String state)

覆盖:

getRealState 在类中 me.zhyd.oauth.request.AuthDefaultRequest

login

public me.zhyd.oauth.model.AuthResponse login(me.zhyd.oauth.model.AuthCallback authCallback)

统一的登录入口。当通过AuthDefaultRequest.authorize(String)授权成功后，会跳转到调用方的相关回调方法中 方法的入参可以使用AuthCallback，AuthCallback类中封装好了OAuth2授权回调所需要的参数

指定者:

login 在接口中 me.zhyd.oauth.request.AuthRequest

指定者:

login 在接口中 Auth2DefaultRequest

覆盖:

login 在类中 me.zhyd.oauth.request.AuthDefaultRequest

参数:

authCallback - 用于接收回调参数的实体

返回:

AuthResponse

另请参阅:

AuthDefaultRequest.login(AuthCallback)

refreshToken

public AuthTokenPo refreshToken(AuthTokenPo authToken)
                         throws com.xkcoding.http.exception.SimpleHttpException,
                                me.zhyd.oauth.exception.AuthException,
                                RefreshTokenFailureException

从接口复制的说明: Auth2DefaultRequest

刷新access token （续期）

指定者:

refreshToken 在接口中 Auth2DefaultRequest

参数:

authToken - 登录成功后返回的Token信息

返回:

AuthTokenPo 返回 AuthTokenPo, 获取 AuthTokenPo 失败返回 null

抛出:

com.xkcoding.http.exception.SimpleHttpException - http 异常

me.zhyd.oauth.exception.AuthException - 不支持 refresh token

RefreshTokenFailureException - refresh token 时出现异常

getAuthSource

public me.zhyd.oauth.config.AuthSource getAuthSource()

从接口复制的说明: Auth2DefaultRequest

获取 AuthSource

指定者:

getAuthSource 在接口中 Auth2DefaultRequest

返回:

AuthSource

getAuthStateCache

public me.zhyd.oauth.cache.AuthStateCache getAuthStateCache()

从接口复制的说明: Auth2DefaultRequest

获取 AuthStateCache

指定者:

getAuthStateCache 在接口中 Auth2DefaultRequest

返回:

AuthStateCache

getAccessToken

public me.zhyd.oauth.model.AuthToken getAccessToken(me.zhyd.oauth.model.AuthCallback authCallback)
                                             throws com.xkcoding.http.exception.SimpleHttpException

获取access token

指定者:

getAccessToken 在接口中 Auth2DefaultRequest

指定者:

getAccessToken 在类中 me.zhyd.oauth.request.AuthDefaultRequest

参数:

authCallback - 授权成功后的回调参数

返回:

token

抛出:

com.xkcoding.http.exception.SimpleHttpException - http 异常

另请参阅:

AuthDefaultRequest.authorize(String)

getUserInfo

@Nullable
public me.zhyd.oauth.model.AuthUser getUserInfo(me.zhyd.oauth.model.AuthToken authToken)
                                                    throws com.xkcoding.http.exception.SimpleHttpException

使用token换取用户信息

指定者:

getUserInfo 在接口中 Auth2DefaultRequest

指定者:

getUserInfo 在类中 me.zhyd.oauth.request.AuthDefaultRequest

参数:

authToken - token信息

返回:

用户信息

抛出:

com.xkcoding.http.exception.SimpleHttpException - http 异常

另请参阅:

AuthDefaultRequest.getAccessToken(AuthCallback)

getProviderId

public String getProviderId()

从接口复制的说明: Auth2DefaultRequest

获取第三方 providerId

指定者:

getProviderId 在接口中 Auth2DefaultRequest

返回:

providerId

authorize

public String authorize(String state)

从接口复制的说明: Auth2DefaultRequest

返回带state参数的授权url，授权回调时会带上这个state

指定者:

authorize 在接口中 me.zhyd.oauth.request.AuthRequest

指定者:

authorize 在接口中 Auth2DefaultRequest

覆盖:

authorize 在类中 me.zhyd.oauth.request.AuthDefaultRequest

参数:

state - state 验证授权流程的参数，可以防止csrf

返回:

返回授权地址