Package io.micronaut.security.token.jwt.validator

Class JwtClaimsValidatorConfigurationProperties

java.lang.Object

io.micronaut.security.token.jwt.validator.JwtClaimsValidatorConfigurationProperties

All Implemented Interfaces:

JwtClaimsValidatorConfiguration

@ConfigurationProperties("micronaut.security.token.jwt.claims-validators")
public class JwtClaimsValidatorConfigurationProperties
extends java.lang.Object
implements JwtClaimsValidatorConfiguration

ConfigurationProperties implementation of JwtClaimsValidatorConfiguration.

Since:

2.4.0

Field Summary

Fields

Modifier and Type	Field	Description
static boolean	DEFAULT_EXPIRATION	The default expiration value.
static boolean	DEFAULT_NONCE	The default nonce value.
static boolean	DEFAULT_NOT_BEFORE	The default not-before value.
static boolean	DEFAULT_OPENID_ID_TOKEN	The default not-before value.
static boolean	DEFAULT_SUBJECT_NOT_NULL	The default subject-not-null value.
static java.lang.String	PREFIX

Constructor Summary

Constructors

Constructor	Description
JwtClaimsValidatorConfigurationProperties()

Method Summary

Modifier and Type	Method	Description
java.lang.String	getAudience()
java.lang.String	getIssuer()
boolean	isExpiration()
boolean	isNonce()
boolean	isNotBefore()
boolean	isOpenidIdtoken()
boolean	isSubjectNotNull()
void	setAudience(java.lang.String audience)
void	setExpiration(boolean expiration)
void	setIssuer(java.lang.String issuer)
void	setNonce(boolean nonce)
void	setNotBefore(boolean notBefore)
void	setOpenidIdtoken(boolean openidIdtoken)
void	setSubjectNotNull(boolean subjectNotNull)

Methods inherited from class java.lang.Object

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

Field Detail

PREFIX

public static final java.lang.String PREFIX

See Also:

Constant Field Values

DEFAULT_NONCE

public static final boolean DEFAULT_NONCE

The default nonce value.

See Also:

Constant Field Values

DEFAULT_EXPIRATION

public static final boolean DEFAULT_EXPIRATION

The default expiration value.

See Also:

Constant Field Values

DEFAULT_SUBJECT_NOT_NULL

public static final boolean DEFAULT_SUBJECT_NOT_NULL

The default subject-not-null value.

See Also:

Constant Field Values

DEFAULT_NOT_BEFORE

public static final boolean DEFAULT_NOT_BEFORE

The default not-before value.

See Also:

Constant Field Values

DEFAULT_OPENID_ID_TOKEN

public static final boolean DEFAULT_OPENID_ID_TOKEN

The default not-before value.

See Also:

Constant Field Values

Constructor Detail

JwtClaimsValidatorConfigurationProperties

public JwtClaimsValidatorConfigurationProperties()

Method Detail

getIssuer

@Nullable
public java.lang.String getIssuer()

Specified by:

getIssuer in interface JwtClaimsValidatorConfiguration

Returns:

Whether the iss claim should be validated to ensure it matches this value.

setIssuer

public void setIssuer(@Nullable
                      java.lang.String issuer)

Parameters:

issuer - Whether the iss claim should be validated to ensure it matches this value. It defaults to null, thus it is not validated.

getAudience

@Nullable
public java.lang.String getAudience()

Specified by:

getAudience in interface JwtClaimsValidatorConfiguration

Returns:

Whether the aud claim should be validated to ensure it matches this value.

setAudience

public void setAudience(@Nullable
                        java.lang.String audience)

Parameters:

audience - Whether the aud claim should be validated to ensure it matches this value. It defaults to null, thus it is not validated.

isSubjectNotNull

public boolean isSubjectNotNull()

Specified by:

isSubjectNotNull in interface JwtClaimsValidatorConfiguration

Returns:

Whether the JWT subject claim should be validated to ensure it is not null.

setSubjectNotNull

public void setSubjectNotNull(boolean subjectNotNull)

Parameters:

subjectNotNull - Whether the JWT subject claim should be validated to ensure it is not null. Default value true.

isNotBefore

public boolean isNotBefore()

Specified by:

isNotBefore in interface JwtClaimsValidatorConfiguration

Returns:

Whether it should be validated that validation time is not before the not-before claim (nbf) of a JWT token.

setNotBefore

public void setNotBefore(boolean notBefore)

Parameters:

notBefore - Whether it should be validated that validation time is not before the not-before claim (nbf) of a JWT token. Default value false.

isExpiration

public boolean isExpiration()

Specified by:

isExpiration in interface JwtClaimsValidatorConfiguration

Returns:

Whether the expiration date of the JWT should be validated.

setExpiration

public void setExpiration(boolean expiration)

Parameters:

expiration - Whether the expiration date of the JWT should be validated. Default value true.

isNonce

public boolean isNonce()

Specified by:

isNonce in interface JwtClaimsValidatorConfiguration

Returns:

Whether the nonce claim should be validated when a nonce was present.

setNonce

public void setNonce(boolean nonce)

Parameters:

nonce - Whether the nonce claim should be validated when a nonce was present. Default value true.

isOpenidIdtoken

public boolean isOpenidIdtoken()

Specified by:

isOpenidIdtoken in interface JwtClaimsValidatorConfiguration

Returns:

Whether `IdTokenClaimsValidator`, which performs some fo the verifications described in OpenID Connect Spec, is enabled. Only applies for `idtoken` authentication mode.

setOpenidIdtoken

public void setOpenidIdtoken(boolean openidIdtoken)

Parameters:

openidIdtoken - Whether `IdTokenClaimsValidator`, which performs some fo the verifications described in OpenID Connect Spec, is enabled. Default value true. Only applies for `idtoken` authentication mode.