Package org.springframework.security.oauth2.client.endpoint

Class RestClientRefreshTokenTokenResponseClient

java.lang.Object

org.springframework.security.oauth2.client.endpoint.AbstractRestClientOAuth2AccessTokenResponseClient<OAuth2RefreshTokenGrantRequest>

org.springframework.security.oauth2.client.endpoint.RestClientRefreshTokenTokenResponseClient

All Implemented Interfaces:

OAuth2AccessTokenResponseClient<OAuth2RefreshTokenGrantRequest>

public final class RestClientRefreshTokenTokenResponseClient
extends AbstractRestClientOAuth2AccessTokenResponseClient<OAuth2RefreshTokenGrantRequest>

An implementation of OAuth2AccessTokenResponseClient that "exchanges" a refresh token for an access token at the Authorization Server's Token Endpoint.

Since:

6.4

See Also:

• OAuth2AccessTokenResponseClient
• OAuth2RefreshTokenGrantRequest
• OAuth2AccessTokenResponse
• Section 6 Refreshing an Access Token

Constructor Summary

Constructors

Constructor	Description
RestClientRefreshTokenTokenResponseClient()

Method Summary

Modifier and Type	Method	Description
OAuth2AccessTokenResponse	getTokenResponse(OAuth2RefreshTokenGrantRequest grantRequest)	Exchanges the authorization grant credential, provided in the authorization grant request, for an access token credential at the Authorization Server's Token Endpoint.

Methods inherited from class org.springframework.security.oauth2.client.endpoint.AbstractRestClientOAuth2AccessTokenResponseClient

addHeadersConverter, addParametersConverter, setHeadersConverter, setParametersConverter, setParametersCustomizer, setRestClient

Methods inherited from class java.lang.Object

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

Constructor Details

RestClientRefreshTokenTokenResponseClient

public RestClientRefreshTokenTokenResponseClient()

Method Details

getTokenResponse

public OAuth2AccessTokenResponse getTokenResponse(OAuth2RefreshTokenGrantRequest grantRequest)

Description copied from interface: OAuth2AccessTokenResponseClient

Exchanges the authorization grant credential, provided in the authorization grant request, for an access token credential at the Authorization Server's Token Endpoint.

Specified by:

getTokenResponse in interface OAuth2AccessTokenResponseClient<OAuth2RefreshTokenGrantRequest>

Overrides:

getTokenResponse in class AbstractRestClientOAuth2AccessTokenResponseClient<OAuth2RefreshTokenGrantRequest>

Parameters:

grantRequest - the authorization grant request that contains the authorization grant credential

Returns:

an OAuth2AccessTokenResponse that contains the access token credential