Package me.zhyd.oauth.request

Class AbstractAuthMicrosoftRequest

java.lang.Object

me.zhyd.oauth.request.AuthDefaultRequest

me.zhyd.oauth.request.AbstractAuthMicrosoftRequest

All Implemented Interfaces:

AuthRequest

Direct Known Subclasses:

AuthMicrosoftCnRequest, AuthMicrosoftRequest

public abstract class AbstractAuthMicrosoftRequest
extends AuthDefaultRequest

微软登录抽象类,负责处理使用微软国际和微软中国账号登录第三方网站的登录方式

Since:

1.16.4

Author:

mroldx (xzfqq5201314@gmail.com)

Field Summary

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

authStateCache, config, source

Constructor Summary

Constructors

Constructor	Description
AbstractAuthMicrosoftRequest(AuthConfig config, AuthSource source)
AbstractAuthMicrosoftRequest(AuthConfig config, AuthSource source, AuthStateCache authStateCache)

Method Summary

Modifier and Type	Method	Description
protected String	accessTokenUrl(String code)	返回获取accessToken的url
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	refreshTokenUrl(String refreshToken)	返回获取accessToken的url
protected String	userInfoUrl(AuthToken authToken)	返回获取userInfo的url

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

authorize, checkCode, checkConfig, doGetAuthorizationCode, doGetRevoke, doGetUserInfo, doPostAuthorizationCode, doPostRevoke, doPostUserInfo, getRealState, getScopes, login, 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

AbstractAuthMicrosoftRequest

public AbstractAuthMicrosoftRequest(AuthConfig config,
 AuthSource source)

AbstractAuthMicrosoftRequest

public AbstractAuthMicrosoftRequest(AuthConfig config,
 AuthSource source,
 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

accessTokenUrl

protected String accessTokenUrl(String code)

返回获取accessToken的url

Overrides:

accessTokenUrl in class AuthDefaultRequest

Parameters:

code - 授权code

Returns:

返回获取accessToken的url

userInfoUrl

protected String userInfoUrl(AuthToken authToken)

返回获取userInfo的url

Overrides:

userInfoUrl in class AuthDefaultRequest

Parameters:

authToken - 用户授权后的token

Returns:

返回获取userInfo的url

refreshTokenUrl

protected String refreshTokenUrl(String refreshToken)

返回获取accessToken的url

Overrides:

refreshTokenUrl in class AuthDefaultRequest

Parameters:

refreshToken - 用户授权后的token

Returns:

返回获取accessToken的url