me.zhyd.oauth.request

Class AuthMicrosoftRequest

java.lang.Object

me.zhyd.oauth.request.AuthDefaultRequest

me.zhyd.oauth.request.AuthMicrosoftRequest

All Implemented Interfaces:

AuthRequest

public class AuthMicrosoftRequest
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 and Description
AuthMicrosoftRequest(AuthConfig config)
AuthMicrosoftRequest(AuthConfig config, AuthStateCache authStateCache)

Method Summary

Modifier and Type	Method and Description
protected String	accessTokenUrl(String code) 返回获取accessToken的url
String	authorize(String state) 返回带state参数的授权url，授权回调时会带上这个state
protected AuthToken	getAccessToken(AuthCallback authCallback) 获取access token
protected AuthUser	getUserInfo(AuthToken authToken) 使用token换取用户信息
AuthResponse	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, doGetAuthorizationCode, doGetRevoke, doGetUserInfo, doPostAuthorizationCode, doPostRevoke, doPostUserInfo, getRealState, getScopes, login, 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 Detail

AuthMicrosoftRequest

public AuthMicrosoftRequest(AuthConfig config)

AuthMicrosoftRequest

public AuthMicrosoftRequest(AuthConfig config,
                            AuthStateCache authStateCache)

Method Detail

getAccessToken

protected AuthToken getAccessToken(AuthCallback authCallback)

Description copied from class: AuthDefaultRequest

获取access token

Specified by:

getAccessToken in class AuthDefaultRequest

Parameters:

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

Returns:

token

See Also:

AuthDefaultRequest.authorize(), AuthDefaultRequest.authorize(String)

getUserInfo

protected AuthUser getUserInfo(AuthToken authToken)

Description copied from class: AuthDefaultRequest

使用token换取用户信息

Specified by:

getUserInfo in class AuthDefaultRequest

Parameters:

authToken - token信息

Returns:

用户信息

See Also:

AuthDefaultRequest.getAccessToken(AuthCallback)

refresh

public AuthResponse 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