Package io.micronaut.security.token.jwt.generator

Class RefreshTokenConfigurationProperties

java.lang.Object

io.micronaut.security.token.jwt.generator.RefreshTokenConfigurationProperties

All Implemented Interfaces:

io.micronaut.core.util.Toggleable, RefreshTokenConfiguration

@Introspected
@Requires(property="micronaut.security.token.jwt.generator.refresh-token.secret") @Requires(property="micronaut.security.token.jwt.generator.refresh-token.enabled",notEquals="false")
@ConfigurationProperties("micronaut.security.token.jwt.generator.refresh-token")
public class RefreshTokenConfigurationProperties
extends Object
implements RefreshTokenConfiguration

ConfigurationProperties implementation of RefreshTokenConfiguration to configure SignedRefreshTokenGenerator.

Since:

2.0.0

Author:

James Kleeh, Sergio del Amo

Field Summary

Fields

Modifier and Type	Field	Description
static final boolean	DEFAULT_BASE64	The default base64 value.
static final boolean	DEFAULT_ENABLED	The default enable value.
static final com.nimbusds.jose.JWSAlgorithm	DEFAULT_JWS_ALGORITHM	The default secure value.
static final String	PREFIX

Constructor Summary

Constructors

Constructor	Description
RefreshTokenConfigurationProperties()

Method Summary

Modifier and Type	Method	Description
@NonNull com.nimbusds.jose.JWSAlgorithm	getJwsAlgorithm()
@NonNull String	getSecret()
boolean	isBase64()
boolean	isEnabled()
void	setBase64(boolean base64)	Indicates whether the supplied secret is base64 encoded.
void	setEnabled(boolean enabled)	Sets whether SignedRefreshTokenGenerator is enabled.
void	setJwsAlgorithm(@NonNull com.nimbusds.jose.JWSAlgorithm jwsAlgorithm)	JWSAlgorithm.
void	setSecret(@NonNull String secret)

Methods inherited from class java.lang.Object

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

Field Details

PREFIX

public static final String PREFIX

See Also:

• Constant Field Values

DEFAULT_JWS_ALGORITHM

public static final com.nimbusds.jose.JWSAlgorithm DEFAULT_JWS_ALGORITHM

The default secure value.

DEFAULT_BASE64

public static final boolean DEFAULT_BASE64

The default base64 value.

See Also:

• Constant Field Values

DEFAULT_ENABLED

public static final boolean DEFAULT_ENABLED

The default enable value.

See Also:

• Constant Field Values

Constructor Details

RefreshTokenConfigurationProperties

public RefreshTokenConfigurationProperties()

Method Details

setEnabled

public void setEnabled(boolean enabled)

Sets whether SignedRefreshTokenGenerator is enabled. Default value (true).

Parameters:

enabled - True if it is enabled

setJwsAlgorithm

public void setJwsAlgorithm(@NonNull
 @NonNull com.nimbusds.jose.JWSAlgorithm jwsAlgorithm)

JWSAlgorithm. Defaults to HS256

Parameters:

jwsAlgorithm - JWS Algorithm

setSecret

public void setSecret(@NonNull
 @NonNull String secret)

Parameters:

secret - shared secret. For HS256 must be at least 256 bits.

setBase64

public void setBase64(boolean base64)

Indicates whether the supplied secret is base64 encoded. Default value false.

Parameters:

base64 - boolean flag indicating whether the supplied secret is base64 encoded

getJwsAlgorithm

@NonNull
public @NonNull com.nimbusds.jose.JWSAlgorithm getJwsAlgorithm()

Specified by:

getJwsAlgorithm in interface RefreshTokenConfiguration

Returns:

JWS Algorithm

getSecret

@NonNull
public @NonNull String getSecret()

Specified by:

getSecret in interface RefreshTokenConfiguration

Returns:

Secret used to sign the refresh token.

isBase64

public boolean isBase64()

Specified by:

isBase64 in interface RefreshTokenConfiguration

Returns:

true if the secret is Base64 encoded

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface io.micronaut.core.util.Toggleable