org.springframework.security.oauth2.server.authorization.config

Class TokenSettings

java.lang.Object

org.springframework.security.oauth2.server.authorization.config.AbstractSettings

org.springframework.security.oauth2.server.authorization.config.TokenSettings

All Implemented Interfaces:

java.io.Serializable

public final class TokenSettings
extends AbstractSettings

A facility for token configuration settings.

Since:

0.0.2

See Also:

AbstractSettings, ConfigurationSettingNames.Token, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TokenSettings.Builder A builder for TokenSettings.

Nested classes/interfaces inherited from class org.springframework.security.oauth2.server.authorization.config.AbstractSettings

AbstractSettings.AbstractBuilder<T extends AbstractSettings,B extends AbstractSettings.AbstractBuilder<T,B>>

Method Summary

Modifier and Type	Method and Description
static TokenSettings.Builder	builder() Constructs a new TokenSettings.Builder with the default settings.
OAuth2TokenFormat	getAccessTokenFormat() Returns the token format for an access token.
java.time.Duration	getAccessTokenTimeToLive() Returns the time-to-live for an access token.
org.springframework.security.oauth2.jose.jws.SignatureAlgorithm	getIdTokenSignatureAlgorithm() Returns the JWS algorithm for signing the ID Token.
java.time.Duration	getRefreshTokenTimeToLive() Returns the time-to-live for a refresh token.
boolean	isReuseRefreshTokens() Returns true if refresh tokens are reused when returning the access token response, or false if a new refresh token is issued.
static TokenSettings.Builder	withSettings(java.util.Map<java.lang.String,java.lang.Object> settings) Constructs a new TokenSettings.Builder with the provided settings.

Methods inherited from class org.springframework.security.oauth2.server.authorization.config.AbstractSettings

equals, getSetting, getSettings, hashCode, toString

Methods inherited from class java.lang.Object

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

Method Detail

getAccessTokenTimeToLive

public java.time.Duration getAccessTokenTimeToLive()

Returns the time-to-live for an access token. The default is 5 minutes.

Returns:

the time-to-live for an access token

getAccessTokenFormat

public OAuth2TokenFormat getAccessTokenFormat()

Returns the token format for an access token. The default is OAuth2TokenFormat.SELF_CONTAINED.

Returns:

the token format for an access token

Since:

0.2.3

isReuseRefreshTokens

public boolean isReuseRefreshTokens()

Returns true if refresh tokens are reused when returning the access token response, or false if a new refresh token is issued. The default is true.

getRefreshTokenTimeToLive

public java.time.Duration getRefreshTokenTimeToLive()

Returns the time-to-live for a refresh token. The default is 60 minutes.

Returns:

the time-to-live for a refresh token

getIdTokenSignatureAlgorithm

public org.springframework.security.oauth2.jose.jws.SignatureAlgorithm getIdTokenSignatureAlgorithm()

Returns the JWS algorithm for signing the ID Token. The default is RS256.

Returns:

the JWS algorithm for signing the ID Token

builder

public static TokenSettings.Builder builder()

Constructs a new TokenSettings.Builder with the default settings.

Returns:

the TokenSettings.Builder

withSettings

public static TokenSettings.Builder withSettings(java.util.Map<java.lang.String,java.lang.Object> settings)

Constructs a new TokenSettings.Builder with the provided settings.

Parameters:

settings - the settings to initialize the builder

Returns:

the TokenSettings.Builder