Class OAuth2RefreshTokenAuthenticationToken

java.lang.Object

org.springframework.security.authentication.AbstractAuthenticationToken

org.springframework.security.oauth2.server.authorization.authentication.OAuth2AuthorizationGrantAuthenticationToken

org.springframework.security.oauth2.server.authorization.authentication.OAuth2RefreshTokenAuthenticationToken

All Implemented Interfaces:

Serializable, Principal, Authentication, CredentialsContainer

public class OAuth2RefreshTokenAuthenticationToken
extends OAuth2AuthorizationGrantAuthenticationToken

An Authentication implementation used for the OAuth 2.0 Refresh Token Grant.

Since:

7.0

See Also:

• OAuth2AuthorizationGrantAuthenticationToken
• OAuth2RefreshTokenAuthenticationProvider
• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class AbstractAuthenticationToken

AbstractAuthenticationToken.AbstractAuthenticationBuilder<B>

Nested classes/interfaces inherited from interface Authentication

Authentication.Builder<B>

Constructor Summary

Constructors

Constructor	Description
OAuth2RefreshTokenAuthenticationToken(String refreshToken, Authentication clientPrincipal, @Nullable Set<String> scopes, @Nullable Map<String,Object> additionalParameters)	Constructs an OAuth2RefreshTokenAuthenticationToken using the provided parameters.

Method Summary

Modifier and Type	Method	Description
String	getRefreshToken()	Returns the refresh token.
Set<String>	getScopes()	Returns the requested scope(s).

Methods inherited from class OAuth2AuthorizationGrantAuthenticationToken

getAdditionalParameters, getCredentials, getGrantType, getPrincipal

Methods inherited from class AbstractAuthenticationToken

equals, eraseCredentials, getAuthorities, getDetails, getName, hashCode, isAuthenticated, setAuthenticated, setDetails, toString

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface Authentication

toBuilder

Methods inherited from interface Principal

implies

Constructor Details

OAuth2RefreshTokenAuthenticationToken

public OAuth2RefreshTokenAuthenticationToken(String refreshToken,
 Authentication clientPrincipal,
 @Nullable Set<String> scopes,
 @Nullable Map<String,Object> additionalParameters)

Constructs an OAuth2RefreshTokenAuthenticationToken using the provided parameters.

Parameters:

refreshToken - the refresh token

clientPrincipal - the authenticated client principal

scopes - the requested scope(s)

additionalParameters - the additional parameters

Method Details

getRefreshToken

public String getRefreshToken()

Returns the refresh token.

Returns:

the refresh token

getScopes

public Set<String> getScopes()

Returns the requested scope(s).

Returns:

the requested scope(s), or an empty Set if not available