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

Class OAuth2ClientCredentialsAuthenticationToken

java.lang.Object

org.springframework.security.authentication.AbstractAuthenticationToken

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

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

All Implemented Interfaces:

Serializable, Principal, Authentication, CredentialsContainer

public class OAuth2ClientCredentialsAuthenticationToken
extends OAuth2AuthorizationGrantAuthenticationToken

An Authentication implementation used for the OAuth 2.0 Client Credentials Grant.

Since:

7.0

See Also:

• OAuth2AuthorizationGrantAuthenticationToken
• OAuth2ClientCredentialsAuthenticationProvider
• 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
OAuth2ClientCredentialsAuthenticationToken(Authentication clientPrincipal, Set<String> scopes, Map<String,Object> additionalParameters)	Constructs an OAuth2ClientCredentialsAuthenticationToken using the provided parameters.

Method Summary

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

Methods inherited from class org.springframework.security.oauth2.server.authorization.authentication.OAuth2AuthorizationGrantAuthenticationToken

getAdditionalParameters, getCredentials, getGrantType, getPrincipal

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

OAuth2ClientCredentialsAuthenticationToken

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

Constructs an OAuth2ClientCredentialsAuthenticationToken using the provided parameters.

Parameters:

clientPrincipal - the authenticated client principal

scopes - the requested scope(s)

additionalParameters - the additional parameters

Method Details

getScopes

public Set<String> getScopes()

Returns the requested scope(s).

Returns:

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