| Package | Description |
|---|---|
| org.jose4j.jwt.consumer |
| Modifier and Type | Method and Description |
|---|---|
JwtConsumerBuilder |
JwtConsumerBuilder.registerValidator(ErrorCodeValidator validator)
Custom ErrorCodeValidator implementations, which will be invoked when the
JwtConsumer is validating the JWT claims. |
JwtConsumerBuilder |
JwtConsumerBuilder.registerValidator(Validator validator)
Custom Validator implementations, which will be invoked when the
JwtConsumer is validating the JWT claims. |
JwtConsumerBuilder |
JwtConsumerBuilder.setAllowedClockSkewInSeconds(int secondsOfAllowedClockSkew)
Set the amount of clock skew to allow for when validate the expiration time, issued at time, and not before time claims.
|
JwtConsumerBuilder |
JwtConsumerBuilder.setDecryptionKey(Key decryptionKey)
Set the key to be used for JWE decryption.
|
JwtConsumerBuilder |
JwtConsumerBuilder.setDecryptionKeyResolver(DecryptionKeyResolver decryptionKeyResolver)
Set the DecryptionKeyResolver to use to select the key for JWE decryption.
|
JwtConsumerBuilder |
JwtConsumerBuilder.setDisableRequireSignature()
Because integrity protection is needed in most usages of JWT, a signature on the JWT is required by default.
|
JwtConsumerBuilder |
JwtConsumerBuilder.setEnableLiberalContentTypeHandling()
According to section 5.2 of the JWT spec,
when nested signing or encryption is employed with a JWT, the "cty" header parameter has to be present and
have a value of "JWT" to indicate that a nested JWT is the payload of the outer JWT.
|
JwtConsumerBuilder |
JwtConsumerBuilder.setEnableRequireEncryption()
Require that the JWT be encrypted, which is not required by default.
|
JwtConsumerBuilder |
JwtConsumerBuilder.setEvaluationTime(NumericDate evaluationTime)
Set the time used to validate the expiration time, issued at time, and not before time claims.
|
JwtConsumerBuilder |
JwtConsumerBuilder.setExpectedAudience(boolean requireAudienceClaim,
String... audience)
Set the audience value(s) to use when validating the audience ("aud") claim of a JWT.
|
JwtConsumerBuilder |
JwtConsumerBuilder.setExpectedAudience(String... audience)
Set the audience value(s) to use when validating the audience ("aud") claim of a JWT
and require that an audience claim be present.
|
JwtConsumerBuilder |
JwtConsumerBuilder.setExpectedIssuer(boolean requireIssuer,
String expectedIssuer)
Indicates whether or not the issuer ("iss") claim is required and optionally what the expected value is.
|
JwtConsumerBuilder |
JwtConsumerBuilder.setExpectedIssuer(String expectedIssuer)
Indicates the expected value of the issuer ("iss") claim and that the claim is required.
|
JwtConsumerBuilder |
JwtConsumerBuilder.setExpectedIssuers(boolean requireIssuer,
String... expectedIssuers)
Indicates whether or not the issuer ("iss") claim is required and optionally what the expected values can be.
|
JwtConsumerBuilder |
JwtConsumerBuilder.setExpectedSubject(String subject)
Require that a subject ("sub") claim be present in the JWT and that its value
match that of the provided subject.
|
JwtConsumerBuilder |
JwtConsumerBuilder.setJweAlgorithmConstraints(AlgorithmConstraints constraints)
Set the JWE algorithm constraints to be applied to key management when processing the JWT.
|
JwtConsumerBuilder |
JwtConsumerBuilder.setJweContentEncryptionAlgorithmConstraints(AlgorithmConstraints constraints)
Set the JWE algorithm constraints to be applied to content encryption when processing the JWT.
|
JwtConsumerBuilder |
JwtConsumerBuilder.setJweCustomizer(JweCustomizer jweCustomizer)
Set a callback JweCustomizer that provides a hook to call arbitrary methods on the/any JsonWebEncryption prior
to the JwsConsumer using it for decryption.
|
JwtConsumerBuilder |
JwtConsumerBuilder.setJweProviderContext(ProviderContext jweProviderContext)
Sets the
ProviderContext for any JWE operations to be done by the JwtConsumer being built. |
JwtConsumerBuilder |
JwtConsumerBuilder.setJwsAlgorithmConstraints(AlgorithmConstraints constraints)
Set the JWS algorithm constraints to be applied when processing the JWT.
|
JwtConsumerBuilder |
JwtConsumerBuilder.setJwsCustomizer(JwsCustomizer jwsCustomizer)
Set a callback JwsCustomizer that provides a hook to call arbitrary methods on the/any JsonWebSignature prior
to the JwsConsumer using it to verify the signature.
|
JwtConsumerBuilder |
JwtConsumerBuilder.setJwsProviderContext(ProviderContext jwsProviderContext)
Sets the
ProviderContext for any JWS operations to be done by the JwtConsumer being built. |
JwtConsumerBuilder |
JwtConsumerBuilder.setMaxFutureValidityInMinutes(int maxFutureValidityInMinutes)
Set maximum on how far in the future the "exp" claim can be.
|
JwtConsumerBuilder |
JwtConsumerBuilder.setRelaxDecryptionKeyValidation()
Bypass the strict checks on the decryption key.
|
JwtConsumerBuilder |
JwtConsumerBuilder.setRelaxVerificationKeyValidation()
Bypass the strict checks on the verification key.
|
JwtConsumerBuilder |
JwtConsumerBuilder.setRequireExpirationTime()
Require that the JWT contain an expiration time ("exp") claim.
|
JwtConsumerBuilder |
JwtConsumerBuilder.setRequireIssuedAt()
Require that the JWT contain an issued at time ("iat") claim.
|
JwtConsumerBuilder |
JwtConsumerBuilder.setRequireJwtId()
Require that a JWT ID ("jti") claim be present in the JWT.
|
JwtConsumerBuilder |
JwtConsumerBuilder.setRequireNotBefore()
Require that the JWT contain an not before ("nbf") claim.
|
JwtConsumerBuilder |
JwtConsumerBuilder.setRequireSubject()
Require that a subject ("sub") claim be present in the JWT.
|
JwtConsumerBuilder |
JwtConsumerBuilder.setSkipAllDefaultValidators()
Skip all the default claim validation but not those provided via
registerValidator(Validator). |
JwtConsumerBuilder |
JwtConsumerBuilder.setSkipAllValidators()
Skip all claims validation.
|
JwtConsumerBuilder |
JwtConsumerBuilder.setSkipDefaultAudienceValidation()
Skip the default audience validation.
|
JwtConsumerBuilder |
JwtConsumerBuilder.setSkipSignatureVerification()
Skip signature verification.
|
JwtConsumerBuilder |
JwtConsumerBuilder.setSkipVerificationKeyResolutionOnNone()
Indicates that the JwtConsumer will not call the VerificationKeyResolver for a JWS using the
'none' algorithm.
|
JwtConsumerBuilder |
JwtConsumerBuilder.setVerificationKey(Key verificationKey)
Set the key to be used for JWS signature/MAC verification.
|
JwtConsumerBuilder |
JwtConsumerBuilder.setVerificationKeyResolver(VerificationKeyResolver verificationKeyResolver)
Set the VerificationKeyResolver to use to select the key for JWS signature/MAC verification.
|
Copyright © 2018. All rights reserved.