Package me.zhyd.oauth.request

Class AuthMiRequest

java.lang.Object

me.zhyd.oauth.request.AuthDefaultRequest

me.zhyd.oauth.request.AuthMiRequest

All Implemented Interfaces:

AuthRequest

public class AuthMiRequest
extends AuthDefaultRequest

小米登录

Since:

1.5.0

Author:

yangkai.shen (https://xkcoding.com)

Field Summary

Fields inherited from class me.zhyd.oauth.request.AuthDefaultRequest

authStateCache, config, source

Constructor Summary

Constructors

Constructor	Description
AuthMiRequest(AuthConfig config)
AuthMiRequest(AuthConfig config, AuthStateCache authStateCache)

Method Summary

Modifier and Type	Method	Description
String	authorize(String state)	返回带state参数的授权url，授权回调时会带上这个state
AuthToken	getAccessToken(AuthCallback authCallback)	获取access token
AuthUser	getUserInfo(AuthToken authToken)	使用token换取用户信息
AuthResponse<AuthToken>	refresh(AuthToken authToken)	刷新access token （续期）
protected String	userInfoUrl(AuthToken authToken)	返回获取userInfo的url

Methods inherited from class me.zhyd.oauth.request.AuthDefaultRequest

accessTokenUrl, authorize, checkCode, checkConfig, doGetAuthorizationCode, doGetRevoke, doGetUserInfo, doPostAuthorizationCode, doPostRevoke, doPostUserInfo, getRealState, getScopes, login, refreshTokenUrl, responseError, revokeUrl

Methods inherited from class java.lang.Object

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

Methods inherited from interface me.zhyd.oauth.request.AuthRequest

revoke

Constructor Details

AuthMiRequest

public AuthMiRequest(AuthConfig config)

AuthMiRequest

public AuthMiRequest(AuthConfig config,
 AuthStateCache authStateCache)

Method Details

getAccessToken

public AuthToken getAccessToken(AuthCallback authCallback)

Description copied from interface: AuthRequest

获取access token

Parameters:

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

Returns:

token

See Also:

• AuthDefaultRequest.authorize()
• AuthDefaultRequest.authorize(String)

getUserInfo

public AuthUser getUserInfo(AuthToken authToken)

Description copied from interface: AuthRequest

使用token换取用户信息

Parameters:

authToken - token信息

Returns:

用户信息

See Also:

• AuthRequest.getAccessToken(AuthCallback)

refresh

public AuthResponse<AuthToken> refresh(AuthToken authToken)

刷新access token （续期）

Parameters:

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

Returns:

AuthResponse

authorize

public String authorize(String state)

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

Specified by:

authorize in interface AuthRequest

Overrides:

authorize in class AuthDefaultRequest

Parameters:

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

Returns:

返回授权地址

Since:

1.9.3

userInfoUrl

protected String userInfoUrl(AuthToken authToken)

返回获取userInfo的url

Overrides:

userInfoUrl in class AuthDefaultRequest

Parameters:

authToken - 用户授权后的token

Returns:

返回获取userInfo的url