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

Class OAuth2RefreshTokenGrantRequest

java.lang.Object

org.springframework.security.oauth2.client.endpoint.AbstractOAuth2AuthorizationGrantRequest

org.springframework.security.oauth2.client.endpoint.OAuth2RefreshTokenGrantRequest

public class OAuth2RefreshTokenGrantRequest
extends AbstractOAuth2AuthorizationGrantRequest

An OAuth 2.0 Refresh Token Grant request that holds the refresh token credential granted to the client.

Since:

5.2

See Also:

AbstractOAuth2AuthorizationGrantRequest, OAuth2RefreshToken, Section 6 Refreshing an Access Token

Constructor Summary

Constructors

Constructor	Description
OAuth2RefreshTokenGrantRequest(ClientRegistration clientRegistration, OAuth2AccessToken accessToken, OAuth2RefreshToken refreshToken)	Constructs an OAuth2RefreshTokenGrantRequest using the provided parameters.
OAuth2RefreshTokenGrantRequest(ClientRegistration clientRegistration, OAuth2AccessToken accessToken, OAuth2RefreshToken refreshToken, java.util.Set<java.lang.String> scopes)	Constructs an OAuth2RefreshTokenGrantRequest using the provided parameters.

Method Summary

Modifier and Type	Method	Description
OAuth2AccessToken	getAccessToken()	Returns the access token credential granted.
ClientRegistration	getClientRegistration()	Returns the authorized client's registration.
OAuth2RefreshToken	getRefreshToken()	Returns the refresh token credential granted.
java.util.Set<java.lang.String>	getScopes()	Returns the scope(s) to request.

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

getGrantType

Methods inherited from class java.lang.Object

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

Constructor Detail

OAuth2RefreshTokenGrantRequest

public OAuth2RefreshTokenGrantRequest(ClientRegistration clientRegistration,
                                      OAuth2AccessToken accessToken,
                                      OAuth2RefreshToken refreshToken)

Constructs an OAuth2RefreshTokenGrantRequest using the provided parameters.

Parameters:

clientRegistration - the authorized client's registration

accessToken - the access token credential granted

refreshToken - the refresh token credential granted

OAuth2RefreshTokenGrantRequest

public OAuth2RefreshTokenGrantRequest(ClientRegistration clientRegistration,
                                      OAuth2AccessToken accessToken,
                                      OAuth2RefreshToken refreshToken,
                                      java.util.Set<java.lang.String> scopes)

Constructs an OAuth2RefreshTokenGrantRequest using the provided parameters.

Parameters:

clientRegistration - the authorized client's registration

accessToken - the access token credential granted

refreshToken - the refresh token credential granted

scopes - the scopes to request

Method Detail

getClientRegistration

public ClientRegistration getClientRegistration()

Returns the authorized client's registration.

Returns:

the ClientRegistration

getAccessToken

public OAuth2AccessToken getAccessToken()

Returns the access token credential granted.

Returns:

the OAuth2AccessToken

getRefreshToken

public OAuth2RefreshToken getRefreshToken()

Returns the refresh token credential granted.

Returns:

the OAuth2RefreshToken

getScopes

public java.util.Set<java.lang.String> getScopes()

Returns the scope(s) to request.

Returns:

the scope(s) to request