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

Class OAuth2AccessTokenGenerator

java.lang.Object

org.springframework.security.oauth2.server.authorization.token.OAuth2AccessTokenGenerator

All Implemented Interfaces:

OAuth2TokenGenerator<org.springframework.security.oauth2.core.OAuth2AccessToken>

public final class OAuth2AccessTokenGenerator
extends Object
implements OAuth2TokenGenerator<org.springframework.security.oauth2.core.OAuth2AccessToken>

An OAuth2TokenGenerator that generates a "reference" (opaque) OAuth2AccessToken.

Since:

0.2.3

See Also:

• OAuth2TokenGenerator
• OAuth2AccessToken
• OAuth2TokenCustomizer
• OAuth2TokenClaimsContext
• OAuth2TokenClaimsSet

Constructor Summary

Constructors

Constructor	Description
OAuth2AccessTokenGenerator()

Method Summary

Modifier and Type	Method	Description
org.springframework.security.oauth2.core.OAuth2AccessToken	generate(OAuth2TokenContext context)	Generate an OAuth 2.0 Token using the attributes contained in the OAuth2TokenContext, or return null if the OAuth2TokenContext.getTokenType() is not supported.
void	setAccessTokenCustomizer(OAuth2TokenCustomizer<OAuth2TokenClaimsContext> accessTokenCustomizer)	Sets the OAuth2TokenCustomizer that customizes the claims for the OAuth2AccessToken.

Methods inherited from class java.lang.Object

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

Constructor Details

OAuth2AccessTokenGenerator

public OAuth2AccessTokenGenerator()

Method Details

generate

@Nullable
public org.springframework.security.oauth2.core.OAuth2AccessToken generate(OAuth2TokenContext context)

Description copied from interface: OAuth2TokenGenerator

Generate an OAuth 2.0 Token using the attributes contained in the OAuth2TokenContext, or return null if the OAuth2TokenContext.getTokenType() is not supported.

If the returned OAuth2Token has a set of claims, it should implement ClaimAccessor in order for it to be stored with the OAuth2Authorization.

Specified by:

generate in interface OAuth2TokenGenerator<org.springframework.security.oauth2.core.OAuth2AccessToken>

Parameters:

context - the context containing the OAuth 2.0 Token attributes

Returns:

an OAuth2Token or null if the OAuth2TokenContext.getTokenType() is not supported

setAccessTokenCustomizer

public void setAccessTokenCustomizer(OAuth2TokenCustomizer<OAuth2TokenClaimsContext> accessTokenCustomizer)

Sets the OAuth2TokenCustomizer that customizes the claims for the OAuth2AccessToken.

Parameters:

accessTokenCustomizer - the OAuth2TokenCustomizer that customizes the claims for the OAuth2AccessToken