Package com.nimbusds.jwt.proc
Interface JWTProcessorConfiguration<C extends SecurityContext>
-
- All Superinterfaces:
JOSEProcessorConfiguration<C>
- All Known Subinterfaces:
ConfigurableJWTProcessor<C>
- All Known Implementing Classes:
DefaultJWTProcessor
public interface JWTProcessorConfiguration<C extends SecurityContext> extends JOSEProcessorConfiguration<C>
JWT processor configuration.Specifies the required components to process JWTs:
- To verify signed JWTs:
- Key selector to determine key candidate(s) for JWS verification based on the JWS header and application- specific context information.
- Factory to construct a JWS verifier for a given key
candidate and JWS header information. A
default factory
implementation is provided.
- To decrypt encrypted JWTs:
- Key selector to determine key candidate(s) for JWE decryption based on the JWS header and application-specific context information.
- Factory to construct a JWE decrypter for a given key
candidate and JWE header information. A
default factory
implementation is provided.
- Optional JWT claims set verifier. Ensures that the claims set of a JWT complies with an application's requirements.
- Version:
- 2021-06-05
- Author:
- Vladimir Dzhuvinov
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description JWTClaimsSetAwareJWSKeySelector<C>
getJWTClaimsSetAwareJWSKeySelector()
Gets the JWT claims set aware JWS key selector.JWTClaimsSetVerifier<C>
getJWTClaimsSetVerifier()
Gets the optional JWT claims set verifier.void
setJWTClaimsSetAwareJWSKeySelector(JWTClaimsSetAwareJWSKeySelector<C> jwsKeySelector)
Sets the JWT claims set aware JWS key selector.void
setJWTClaimsSetVerifier(JWTClaimsSetVerifier<C> claimsVerifier)
Sets the optional JWT claims set verifier.-
Methods inherited from interface com.nimbusds.jose.proc.JOSEProcessorConfiguration
getJWEDecrypterFactory, getJWEKeySelector, getJWETypeVerifier, getJWSKeySelector, getJWSTypeVerifier, getJWSVerifierFactory, setJWEDecrypterFactory, setJWEKeySelector, setJWETypeVerifier, setJWSKeySelector, setJWSTypeVerifier, setJWSVerifierFactory
-
-
-
-
Method Detail
-
getJWTClaimsSetAwareJWSKeySelector
JWTClaimsSetAwareJWSKeySelector<C> getJWTClaimsSetAwareJWSKeySelector()
Gets the JWT claims set aware JWS key selector.- Returns:
- The JWT claims set aware JWS key selector,
null
if not specified.
-
setJWTClaimsSetAwareJWSKeySelector
void setJWTClaimsSetAwareJWSKeySelector(JWTClaimsSetAwareJWSKeySelector<C> jwsKeySelector)
Sets the JWT claims set aware JWS key selector.- Parameters:
jwsKeySelector
- The JWT claims set aware JWS key selector,null
if not specified.
-
getJWTClaimsSetVerifier
JWTClaimsSetVerifier<C> getJWTClaimsSetVerifier()
Gets the optional JWT claims set verifier. Ensures that the claims set of a JWT complies with an application's requirements.- Returns:
- The JWT claims set verifier,
null
if not specified.
-
setJWTClaimsSetVerifier
void setJWTClaimsSetVerifier(JWTClaimsSetVerifier<C> claimsVerifier)
Sets the optional JWT claims set verifier. Ensures that the claims set of a JWT complies with an application's requirements.- Parameters:
claimsVerifier
- The JWT claims set verifier,null
if not specified.
-
-