org.springframework.security.oauth2.client.token.grant.code
类 AuthorizationCodeAccessTokenProvider

java.lang.Object
  org.springframework.security.oauth2.client.token.OAuth2AccessTokenSupport
      org.springframework.security.oauth2.client.token.grant.code.AuthorizationCodeAccessTokenProvider

所有已实现的接口：

AccessTokenProvider

public class AuthorizationCodeAccessTokenProvider
extends OAuth2AccessTokenSupport
implements AccessTokenProvider

Provider for obtaining an oauth2 access token by using an authorization code.

作者：

Ryan Heaton, Dave Syer

字段摘要

从类 org.springframework.security.oauth2.client.token.OAuth2AccessTokenSupport 继承的字段

logger

构造方法摘要

AuthorizationCodeAccessTokenProvider()

方法摘要

protected org.springframework.web.client.ResponseExtractor<org.springframework.http.ResponseEntity<Void>>	getAuthorizationResponseExtractor()
protected UserApprovalRequiredException	getUserApprovalSignal(AuthorizationCodeResourceDetails resource, AccessTokenRequest request)
OAuth2AccessToken	obtainAccessToken(OAuth2ProtectedResourceDetails details, AccessTokenRequest request) Obtain a new access token for the specified protected resource.
String	obtainAuthorizationCode(OAuth2ProtectedResourceDetails details, AccessTokenRequest request)
OAuth2AccessToken	refreshAccessToken(OAuth2ProtectedResourceDetails resource, OAuth2RefreshToken refreshToken, AccessTokenRequest request)
void	setStateKeyGenerator(StateKeyGenerator stateKeyGenerator)
boolean	supportsRefresh(OAuth2ProtectedResourceDetails resource)
boolean	supportsResource(OAuth2ProtectedResourceDetails resource) Whether this provider supports the specified resource.

从类 org.springframework.security.oauth2.client.token.OAuth2AccessTokenSupport 继承的方法

getAccessTokenUri, getHttpMethod, getRequestCallback, getResponseErrorHandler, getResponseExtractor, getRestTemplate, retrieveToken, setAuthenticationHandler, setInterceptors, setMessageConverters, setRequestFactory

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

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

构造方法详细信息

AuthorizationCodeAccessTokenProvider

public AuthorizationCodeAccessTokenProvider()

方法详细信息

setStateKeyGenerator

public void setStateKeyGenerator(StateKeyGenerator stateKeyGenerator)

参数：

stateKeyGenerator - the stateKeyGenerator to set

supportsResource

public boolean supportsResource(OAuth2ProtectedResourceDetails resource)

从接口 AccessTokenProvider 复制的描述

Whether this provider supports the specified resource.

指定者：

接口 AccessTokenProvider 中的 supportsResource

参数：

resource - The resource.

返回：

Whether this provider supports the specified resource.

supportsRefresh

public boolean supportsRefresh(OAuth2ProtectedResourceDetails resource)

指定者：

接口 AccessTokenProvider 中的 supportsRefresh

参数：

resource - The resource to check

返回：

true if this provider can refresh an access token

obtainAuthorizationCode

public String obtainAuthorizationCode(OAuth2ProtectedResourceDetails details,
                                      AccessTokenRequest request)
                               throws UserRedirectRequiredException,
                                      UserApprovalRequiredException,
                                      org.springframework.security.access.AccessDeniedException,
                                      OAuth2AccessDeniedException

抛出：

UserRedirectRequiredException

UserApprovalRequiredException

org.springframework.security.access.AccessDeniedException

OAuth2AccessDeniedException

getAuthorizationResponseExtractor

protected org.springframework.web.client.ResponseExtractor<org.springframework.http.ResponseEntity<Void>> getAuthorizationResponseExtractor()

obtainAccessToken

public OAuth2AccessToken obtainAccessToken(OAuth2ProtectedResourceDetails details,
                                           AccessTokenRequest request)
                                    throws UserRedirectRequiredException,
                                           UserApprovalRequiredException,
                                           org.springframework.security.access.AccessDeniedException,
                                           OAuth2AccessDeniedException

从接口 AccessTokenProvider 复制的描述

Obtain a new access token for the specified protected resource.

指定者：

接口 AccessTokenProvider 中的 obtainAccessToken

参数：

details - The protected resource for which this provider is to obtain an access token.

request - The parameters of the request giving context for the token details if any.

返回：

The access token for the specified protected resource. The return value may NOT be null.

抛出：

UserRedirectRequiredException - If the provider requires the current user to be redirected for authorization.

UserApprovalRequiredException - If the provider is ready to issue a token but only if the user approves

org.springframework.security.access.AccessDeniedException - If the user denies access to the protected resource.

OAuth2AccessDeniedException

refreshAccessToken

public OAuth2AccessToken refreshAccessToken(OAuth2ProtectedResourceDetails resource,
                                            OAuth2RefreshToken refreshToken,
                                            AccessTokenRequest request)
                                     throws UserRedirectRequiredException,
                                            OAuth2AccessDeniedException

指定者：

接口 AccessTokenProvider 中的 refreshAccessToken

参数：

resource - the resource for which a token refresh is required

refreshToken - the refresh token to send

返回：

an access token

抛出：

UserRedirectRequiredException

OAuth2AccessDeniedException

getUserApprovalSignal

protected UserApprovalRequiredException getUserApprovalSignal(AuthorizationCodeResourceDetails resource,
                                                              AccessTokenRequest request)