Package io.micronaut.security.token.jwt.signature.jwks

Class JwksSignatureConfigurationProperties

java.lang.Object

io.micronaut.security.token.jwt.signature.jwks.JwksSignatureConfigurationProperties

All Implemented Interfaces:

JwksSignatureConfiguration

@EachProperty("micronaut.security.token.jwt.signatures.jwks")
public class JwksSignatureConfigurationProperties
extends java.lang.Object
implements JwksSignatureConfiguration

JSON Web Key Set (JWKS) Signature Configuration properties holder.

Since:

1.1.0

Field Summary

Fields

Modifier and Type	Field	Description
static int	DEFAULT_CACHE_EXPIRATION	The default cache expiration.
static com.nimbusds.jose.jwk.KeyType	DEFAULT_KEYTYPE	The default key type.
static java.lang.String	PREFIX

Constructor Summary

Constructors

Constructor	Description
JwksSignatureConfigurationProperties()

Method Summary

Modifier and Type	Method	Description
java.lang.Integer	getCacheExpiration()
com.nimbusds.jose.jwk.KeyType	getKeyType()	Representation the KeyType for this JWKS signature configuration.
@NotNull java.lang.String	getUrl()	Json Web Key Set endpoint url.
void	setCacheExpiration(java.lang.Integer cacheExpiration)	JWKS cache expiration.
void	setKeyType(com.nimbusds.jose.jwk.KeyType keyType)	Representation of the kty parameter in a JSON Web Key (JWK).
void	setUrl(java.lang.String url)	Remote JSON Web Key set url.

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_KEYTYPE

public static final com.nimbusds.jose.jwk.KeyType DEFAULT_KEYTYPE

The default key type.

DEFAULT_CACHE_EXPIRATION

public static final int DEFAULT_CACHE_EXPIRATION

The default cache expiration.

See Also:

Constant Field Values

Constructor Detail

JwksSignatureConfigurationProperties

public JwksSignatureConfigurationProperties()

Method Detail

getCacheExpiration

@NonNull
public java.lang.Integer getCacheExpiration()

Specified by:

getCacheExpiration in interface JwksSignatureConfiguration

Returns:

The number of seconds to cache the JWKS.

setCacheExpiration

public void setCacheExpiration(java.lang.Integer cacheExpiration)

JWKS cache expiration. Default value 60 seconds.

Parameters:

cacheExpiration - The expiration

getUrl

@NotNull
@NonNull
public @NotNull java.lang.String getUrl()

Description copied from interface: JwksSignatureConfiguration

Json Web Key Set endpoint url.

Specified by:

getUrl in interface JwksSignatureConfiguration

Returns:

URL to the remote JSON Web Key Set.

setUrl

public void setUrl(java.lang.String url)

Remote JSON Web Key set url. e.g. https://.../.well-known/jwks.json

Parameters:

url - Remote JSON Web Key set url.

getKeyType

@Nullable
public com.nimbusds.jose.jwk.KeyType getKeyType()

Description copied from interface: JwksSignatureConfiguration

Representation the KeyType for this JWKS signature configuration. KeyType is the kty parameter in a JSON Web Key (JWK).

Specified by:

getKeyType in interface JwksSignatureConfiguration

Returns:

Representation the KeyType for this JWKS signature configuration. KeyType is the kty parameter in a JSON Web Key (JWK).

setKeyType

public void setKeyType(com.nimbusds.jose.jwk.KeyType keyType)

Representation of the kty parameter in a JSON Web Key (JWK). Default value (RSA).

Parameters:

keyType - Representation of the kty parameter in a JSON Web Key (JWK).