Class JwksSignatureConfigurationProperties
java.lang.Object
io.micronaut.security.token.jwt.signature.jwks.JwksSignatureConfigurationProperties
- All Implemented Interfaces:
io.micronaut.core.naming.Named
,JwksSignatureConfiguration
@EachProperty("micronaut.security.token.jwt.signatures.jwks")
public class JwksSignatureConfigurationProperties
extends Object
implements JwksSignatureConfiguration
JSON Web Key Set (JWKS) Signature Configuration properties holder.
- Since:
- 1.1.0
- Author:
- Sergio del Amo
-
Field Summary
Modifier and TypeFieldDescriptionstatic final int
The default cache expiration.static final com.nimbusds.jose.jwk.KeyType
The default key type.static final String
-
Constructor Summary
ConstructorDescriptionDeprecated, for removal: This API element is subject to removal in a future version. -
Method Summary
Modifier and TypeMethodDescription@NonNull Integer
@Nullable com.nimbusds.jose.jwk.KeyType
Representation the KeyType for this JWKS signature configuration.@NonNull String
getName()
@NotNull @NonNull String
getUrl()
Json Web Key Set endpoint url.void
setCacheExpiration
(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
Remote JSON Web Key set url.
-
Field Details
-
PREFIX
- See Also:
-
DEFAULT_KEYTYPE
public static final com.nimbusds.jose.jwk.KeyType DEFAULT_KEYTYPEThe default key type. -
DEFAULT_CACHE_EXPIRATION
public static final int DEFAULT_CACHE_EXPIRATIONThe default cache expiration.- See Also:
-
-
Constructor Details
-
JwksSignatureConfigurationProperties
Deprecated, for removal: This API element is subject to removal in a future version. -
JwksSignatureConfigurationProperties
-
-
Method Details
-
getName
- Specified by:
getName
in interfaceio.micronaut.core.naming.Named
-
getCacheExpiration
- Specified by:
getCacheExpiration
in interfaceJwksSignatureConfiguration
- Returns:
- The number of seconds to cache the JWKS.
-
setCacheExpiration
JWKS cache expiration. Default value 60 seconds.- Parameters:
cacheExpiration
- The expiration
-
getUrl
Description copied from interface:JwksSignatureConfiguration
Json Web Key Set endpoint url.- Specified by:
getUrl
in interfaceJwksSignatureConfiguration
- Returns:
- URL to the remote JSON Web Key Set.
-
setUrl
Remote JSON Web Key set url. e.g. https://.../.well-known/jwks.json- Parameters:
url
- Remote JSON Web Key set url.
-
getKeyType
@Nullable public @Nullable 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 interfaceJwksSignatureConfiguration
- 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).
-
JwksSignatureConfigurationProperties(java.lang.String)
instead.