Package com.nimbusds.jose.proc
Interface JOSEProcessorConfiguration<C extends SecurityContext>
- All Known Subinterfaces:
ConfigurableJOSEProcessor<C>
,ConfigurableJWTProcessor<C>
,JWTProcessorConfiguration<C>
- All Known Implementing Classes:
DefaultJOSEProcessor
,DefaultJWTProcessor
public interface JOSEProcessorConfiguration<C extends SecurityContext>
JOSE processor configuration.
Specifies the required components to process secured JOSE objects:
- To verify JWS objects:
Verifier
for the acceptable JWS header "typ" (type) parameters.Key selector
to determine key candidate(s) for JWS verification based on the JWS header, payload and / or application-specific context information.Factory
to construct a JWS verifier for a given key candidate and JWS header information.
- To decrypt JWE objects:
Verifier
for the acceptable JWE header "typ" (type) parameters.Key selector
to determine key candidate(s) for JWE decryption based on the JWE header and / or application-specific context information.Factory
to construct a JWE decrypter for a given key candidate and JWE header information.
- Version:
- 2019-10-15
- Author:
- Vladimir Dzhuvinov
-
Method Summary
Modifier and TypeMethodDescriptionGets the factory for creating JWE decrypter instances.Gets the JWE key selector.Gets the JWE header "typ" (type) parameter verifier.Gets the JWS key selector.Gets the JWS header "typ" (type) parameter verifier.Gets the factory for creating JWS verifier instances.void
Sets the factory for creating JWE decrypter instances.void
setJWEKeySelector
(JWEKeySelector<C> jweKeySelector) Sets the JWE key selector.void
setJWETypeVerifier
(JOSEObjectTypeVerifier<C> jweTypeVerifier) Sets the JWE header "typ" (type) parameter verifier.void
setJWSKeySelector
(JWSKeySelector<C> jwsKeySelector) Sets the JWS key selector.void
setJWSTypeVerifier
(JOSEObjectTypeVerifier<C> jwsTypeVerifier) Sets the JWS header "typ" (type) parameter verifier.void
setJWSVerifierFactory
(JWSVerifierFactory factory) Sets the factory for creating JWS verifier instances.
-
Method Details
-
getJWSTypeVerifier
Gets the JWS header "typ" (type) parameter verifier. This verifier is also applied to plain (unsecured) JOSE objects. If none JWS and plain objects will be rejected.- Returns:
- The JWS type verifier,
null
if not specified. - Since:
- 8.0
-
setJWSTypeVerifier
Sets the JWS header "typ" (type) parameter verifier. This verifier is also applied to plain (unsecured) JOSE objects. If none JWS and plain objects will be rejected.- Parameters:
jwsTypeVerifier
- The JWS type verifier,null
if not specified.- Since:
- 8.0
-
getJWSKeySelector
Gets the JWS key selector. If none JWS objects will be rejected.- Returns:
- The JWS key selector,
null
if not specified.
-
setJWSKeySelector
Sets the JWS key selector. If none JWS objects will be rejected.- Parameters:
jwsKeySelector
- The JWS key selector,null
if not specified.
-
getJWETypeVerifier
Gets the JWE header "typ" (type) parameter verifier. If none JWE objects will be rejected.- Returns:
- The JWE verifier,
null
if not specified. - Since:
- 8.0
-
setJWETypeVerifier
Sets the JWE header "typ" (type) parameter verifier. If none JWE objects will be rejected.- Parameters:
jweTypeVerifier
- The JWE type verifier,null
if not specified.- Since:
- 8.0
-
getJWEKeySelector
Gets the JWE key selector. If none JWE objects will be rejected.- Returns:
- The JWE key selector,
null
if not specified.
-
setJWEKeySelector
Sets the JWE key selector. If none JWE objects will be rejected.- Parameters:
jweKeySelector
- The JWE key selector,null
if not specified.
-
getJWSVerifierFactory
Gets the factory for creating JWS verifier instances. If none JWS objects will be rejected.- Returns:
- The JWS verifier factory,
null
if not specified.
-
setJWSVerifierFactory
Sets the factory for creating JWS verifier instances. If none JWS objects will be rejected.- Parameters:
factory
- The JWS verifier factory,null
if not specified.
-
getJWEDecrypterFactory
Gets the factory for creating JWE decrypter instances. If none JWE objects will be rejected.- Returns:
- The JWE decrypter factory,
null
if not specified.
-
setJWEDecrypterFactory
Sets the factory for creating JWE decrypter instances. If none JWE objects will be rejected.- Parameters:
factory
- The JWE decrypter factory,null
if not specified.
-