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

接口 Auth2DefaultRequest

所有已知实现类:

AuthDefaultRequestAdapter

public interface Auth2DefaultRequest

AuthDefaultRequest 的扩展, 对外曝露接口
1. authorize(String),
2. getAccessToken(AuthCallback),
3. getUserInfo(AuthToken),
4. getAuthStateCache(),
5. getAuthSource(),
6. login(AuthCallback),
7. getProviderId(),
8. refreshToken(AuthTokenPo),
10. removeStateCacheOfSessionCache(AuthStateCache, AuthSource),
11. generateState(),
12. getAuthTokenPo(Integer, Long, AuthResponse),
13. expireIn2Timestamp(Integer, Integer, AuthTokenPo),
14. responseError(Exception)

版本:

V1.0 Created by 2020/10/7 20:27

作者:

YongWu zheng

方法概要

限定符和类型	方法和说明
String	authorize(String state) 返回带state参数的授权url，授权回调时会带上这个state
static long	expireIn2Timestamp(Integer timeout, Integer expireIn) 有效期转时间戳
static <T extends AuthTokenPo> void	expireIn2Timestamp(Integer timeout, Integer expireIn, T authToken) 有效期转时间戳
default String	generateState() 生成一个用户 id.
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
static AuthTokenPo	getAuthTokenPo(Integer timeout, Long tokenId, me.zhyd.oauth.model.AuthResponse authResponse) AuthRequest.refresh(AuthToken) 返回的 AuthResponse 转换到 AuthTokenPo
String	getProviderId() 获取第三方 providerId
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 （续期）
static void	removeStateCacheOfSessionCache(me.zhyd.oauth.cache.AuthStateCache authStateCache, me.zhyd.oauth.config.AuthSource source) 移除 session stateCache 缓存
static me.zhyd.oauth.model.AuthResponse	responseError(Exception e) 处理AuthDefaultRequest.login(AuthCallback) 发生异常的情况，统一响应参数.

方法详细资料

login

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

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

参数:

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

返回:

AuthResponse

getProviderId

String getProviderId()

获取第三方 providerId

返回:

providerId

getAuthSource

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

获取 AuthSource

返回:

AuthSource

getAuthStateCache

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

获取 AuthStateCache

返回:

AuthStateCache

authorize

String authorize(String state)

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

参数:

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

返回:

返回授权地址

从以下版本开始:

1.9.3

getAccessToken

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

获取access token

参数:

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

返回:

token

抛出:

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

另请参阅:

#getAccessToken(AuthCallback), AuthDefaultRequest.authorize(String)

getUserInfo

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

使用token换取用户信息

参数:

authToken - token信息

返回:

用户信息

抛出:

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

另请参阅:

#getUserInfo(AuthToken)

refreshToken

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

刷新access token （续期）

参数:

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

返回:

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

抛出:

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

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

RefreshTokenFailureException - refresh token 时出现异常

generateState

default String generateState()

生成一个用户 id. 默认使用 UuidUtils.getUUID()

返回:

返回一个用户 Id

removeStateCacheOfSessionCache

static void removeStateCacheOfSessionCache(@NonNull
                                           me.zhyd.oauth.cache.AuthStateCache authStateCache,
                                           @NonNull
                                           me.zhyd.oauth.config.AuthSource source)

移除 session stateCache 缓存

参数:

authStateCache - AuthStateCache

source - AuthSource

getAuthTokenPo

@NonNull
static AuthTokenPo getAuthTokenPo(Integer timeout,
                                            Long tokenId,
                                            me.zhyd.oauth.model.AuthResponse authResponse)
                                     throws RefreshTokenFailureException

AuthRequest.refresh(AuthToken) 返回的 AuthResponse 转换到 AuthTokenPo

参数:

timeout - HttpConfig.getTimeout() 返回的 AuthResponse, 毫秒

tokenId - token id

authResponse - AuthRequest.refresh(AuthToken) 返回的 AuthResponse

返回:

AuthTokenPo

抛出:

RefreshTokenFailureException - refresh token 时出现异常

expireIn2Timestamp

static <T extends AuthTokenPo> void expireIn2Timestamp(@NonNull
                                                       Integer timeout,
                                                       @Nullable
                                                       Integer expireIn,
                                                       @NonNull
                                                       T authToken)

有效期转时间戳

参数:

timeout - HttpConfig.getTimeout(), 单位毫秒

expireIn - 有效期

authToken - AuthToken

expireIn2Timestamp

static long expireIn2Timestamp(@NonNull
                               Integer timeout,
                               @Nullable
                               Integer expireIn)

有效期转时间戳

参数:

timeout - HttpConfig.getTimeout(), 单位毫秒

expireIn - 有效期

返回:

时间戳

responseError

static me.zhyd.oauth.model.AuthResponse responseError(Exception e)

处理AuthDefaultRequest.login(AuthCallback) 发生异常的情况，统一响应参数. copy of AuthDefaultRequest

参数:

e - 具体的异常

返回:

AuthResponse

另请参阅:

#responseError(Exception)