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

Class OAuth2TokenRevocationAuthenticationToken

java.lang.Object

org.springframework.security.authentication.AbstractAuthenticationToken

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

All Implemented Interfaces:

Serializable, Principal, Authentication, CredentialsContainer

public class OAuth2TokenRevocationAuthenticationToken
extends AbstractAuthenticationToken

An Authentication implementation used for OAuth 2.0 Token Revocation.

Since:

7.0

See Also:

• AbstractAuthenticationToken
• OAuth2TokenRevocationAuthenticationProvider
• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.springframework.security.authentication.AbstractAuthenticationToken

AbstractAuthenticationToken.AbstractAuthenticationBuilder<B extends AbstractAuthenticationToken.AbstractAuthenticationBuilder<B>>

Nested classes/interfaces inherited from interface org.springframework.security.core.Authentication

Authentication.Builder<B extends Authentication.Builder<B>>

Constructor Summary

Constructors

Constructor	Description
OAuth2TokenRevocationAuthenticationToken(String token, Authentication clientPrincipal, String tokenTypeHint)	Constructs an OAuth2TokenRevocationAuthenticationToken using the provided parameters.
OAuth2TokenRevocationAuthenticationToken(OAuth2Token revokedToken, Authentication clientPrincipal)	Constructs an OAuth2TokenRevocationAuthenticationToken using the provided parameters.

Method Summary

Modifier and Type	Method	Description
Object	getCredentials()	The credentials that prove the principal is correct.
Object	getPrincipal()	The identity of the principal being authenticated.
String	getToken()	Returns the token.
String	getTokenTypeHint()	Returns the token type hint.

Methods inherited from class org.springframework.security.authentication.AbstractAuthenticationToken

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.security.core.Authentication

toBuilder

Methods inherited from interface java.security.Principal

implies

Constructor Details

OAuth2TokenRevocationAuthenticationToken

public OAuth2TokenRevocationAuthenticationToken(String token,
 Authentication clientPrincipal,
 @Nullable
 String tokenTypeHint)

Constructs an OAuth2TokenRevocationAuthenticationToken using the provided parameters.

Parameters:

token - the token

clientPrincipal - the authenticated client principal

tokenTypeHint - the token type hint

OAuth2TokenRevocationAuthenticationToken

public OAuth2TokenRevocationAuthenticationToken(OAuth2Token revokedToken,
 Authentication clientPrincipal)

Constructs an OAuth2TokenRevocationAuthenticationToken using the provided parameters.

Parameters:

revokedToken - the revoked token

clientPrincipal - the authenticated client principal

Method Details

getPrincipal

public Object getPrincipal()

Description copied from interface: Authentication

The identity of the principal being authenticated. In the case of an authentication request with username and password, this would be the username. Callers are expected to populate the principal for an authentication request.

The AuthenticationManager implementation will often return an Authentication containing richer information as the principal for use by the application. Many of the authentication providers will create a UserDetails object as the principal.

Returns:

the Principal being authenticated or the authenticated principal after authentication.

getCredentials

public Object getCredentials()

Description copied from interface: Authentication

The credentials that prove the principal is correct. This is usually a password, but could be anything relevant to the AuthenticationManager. Callers are expected to populate the credentials.

Returns:

the credentials that prove the identity of the Principal

getToken

public String getToken()

Returns the token.

Returns:

the token

getTokenTypeHint

@Nullable
public String getTokenTypeHint()

Returns the token type hint.

Returns:

the token type hint