Package | Description |
---|---|
io.jsonwebtoken |
Modifier and Type | Method and Description |
---|---|
JwtParserBuilder |
JwtParserBuilder.b64Url(Decoder<InputStream,InputStream> base64UrlDecoder)
Perform Base64Url decoding during parsing with the specified
InputStream Decoder. |
JwtParserBuilder |
JwtParserBuilder.base64UrlDecodeWith(Decoder<CharSequence,byte[]> base64UrlDecoder)
Deprecated.
since 0.12.0 in favor of
b64Url(Decoder) . This method will be removed
before the JJWT 1.0 release. |
JwtParserBuilder |
JwtParserBuilder.clock(Clock clock)
Sets the
Clock that determines the timestamp to use when validating the parsed JWT. |
JwtParserBuilder |
JwtParserBuilder.clockSkewSeconds(long seconds)
Sets the amount of clock skew in seconds to tolerate when verifying the local time against the
exp
and nbf claims. |
JwtParserBuilder |
JwtParserBuilder.decryptWith(PrivateKey key)
Sets the decryption PrivateKey used to decrypt all encountered JWEs.
|
JwtParserBuilder |
JwtParserBuilder.decryptWith(SecretKey key)
Sets the decryption SecretKey used to decrypt all encountered JWEs.
|
JwtParserBuilder |
JwtParserBuilder.deserializeJsonWith(Deserializer<Map<String,?>> deserializer)
Deprecated.
since 0.12.0 in favor of
json(Deserializer) .
This method will be removed before the JJWT 1.0 release. |
JwtParserBuilder |
JwtParserBuilder.json(Deserializer<Map<String,?>> deserializer)
Uses the specified JSON
Deserializer to deserialize JSON (UTF-8 byte streams) into Java Map objects. |
JwtParserBuilder |
JwtParserBuilder.keyLocator(Locator<Key> keyLocator)
Sets the
Locator used to acquire any signature verification or decryption key needed during parsing. |
static JwtParserBuilder |
Jwts.parser()
Returns a new
JwtParserBuilder instance that can be configured to create an immutable/thread-safe JwtParser . |
JwtParserBuilder |
JwtParserBuilder.provider(Provider provider)
Sets the JCA Provider to use during cryptographic signature and key decryption operations, or
null if the
JCA subsystem preferred provider should be used. |
JwtParserBuilder |
JwtParserBuilder.require(String claimName,
Object value)
Ensures that the specified
claimName exists in the parsed JWT. |
JwtParserBuilder |
JwtParserBuilder.requireAudience(String audience)
Ensures that the specified
aud exists in the parsed JWT. |
JwtParserBuilder |
JwtParserBuilder.requireExpiration(Date expiration)
Ensures that the specified
exp exists in the parsed JWT. |
JwtParserBuilder |
JwtParserBuilder.requireId(String id)
Ensures that the specified
jti exists in the parsed JWT. |
JwtParserBuilder |
JwtParserBuilder.requireIssuedAt(Date issuedAt)
Ensures that the specified
iat exists in the parsed JWT. |
JwtParserBuilder |
JwtParserBuilder.requireIssuer(String issuer)
Ensures that the specified
iss exists in the parsed JWT. |
JwtParserBuilder |
JwtParserBuilder.requireNotBefore(Date notBefore)
Ensures that the specified
nbf exists in the parsed JWT. |
JwtParserBuilder |
JwtParserBuilder.requireSubject(String subject)
Ensures that the specified
sub exists in the parsed JWT. |
JwtParserBuilder |
JwtParserBuilder.setAllowedClockSkewSeconds(long seconds)
Deprecated.
since 0.12.0 in favor of the shorter and more modern builder-style named
clockSkewSeconds(long) . This method will be removed before the JJWT 1.0 release. |
JwtParserBuilder |
JwtParserBuilder.setClock(Clock clock)
Deprecated.
since 0.12.0 for the more modern builder-style named
clock(Clock) method.
This method will be removed before the JJWT 1.0 release. |
JwtParserBuilder |
JwtParserBuilder.setCompressionCodecResolver(CompressionCodecResolver compressionCodecResolver)
Deprecated.
since 0.12.0 in favor of
zip() . This method will be removed before the
1.0 release. |
JwtParserBuilder |
JwtParserBuilder.setSigningKey(byte[] key)
Deprecated.
since 0.12.0 in favor of
verifyWith(SecretKey) for type safety and name
congruence with the decryptWith(SecretKey) method. |
JwtParserBuilder |
JwtParserBuilder.setSigningKey(Key key)
Deprecated.
since 0.12.0 in favor of
verifyWith(SecretKey) for naming congruence with the
decryptWith(SecretKey) method. |
JwtParserBuilder |
JwtParserBuilder.setSigningKey(String base64EncodedSecretKey)
Deprecated.
in favor of
verifyWith(SecretKey) as explained in the above Deprecation Notice,
and will be removed in 1.0.0. |
JwtParserBuilder |
JwtParserBuilder.setSigningKeyResolver(SigningKeyResolver signingKeyResolver)
Deprecated.
since 0.12.0 in favor of
keyLocator(Locator) |
JwtParserBuilder |
JwtParserBuilder.unsecured()
Enables parsing of Unsecured JWTs (JWTs with an 'alg' (Algorithm) header value of
'none' or missing the 'alg' header entirely).
|
JwtParserBuilder |
JwtParserBuilder.unsecuredDecompression()
If the parser is
unsecured() , calling this method additionally enables
payload decompression of Unsecured JWTs (JWTs with an 'alg' (Algorithm) header value of 'none') that also have
a 'zip' (Compression) header. |
JwtParserBuilder |
JwtParserBuilder.verifyWith(PublicKey key)
Sets the signature verification PublicKey used to verify all encountered JWS signatures.
|
JwtParserBuilder |
JwtParserBuilder.verifyWith(SecretKey key)
Sets the signature verification SecretKey used to verify all encountered JWS signatures.
|
Modifier and Type | Method and Description |
---|---|
NestedCollection<String,JwtParserBuilder> |
JwtParserBuilder.critical()
Configures the
ProtectedHeader parameter names used in JWT extensions supported by the application. |
NestedCollection<AeadAlgorithm,JwtParserBuilder> |
JwtParserBuilder.enc()
Configures the parser's supported
AeadAlgorithm s used to decrypt JWE payloads. |
NestedCollection<KeyAlgorithm<?,?>,JwtParserBuilder> |
JwtParserBuilder.key()
Configures the parser's supported
KeyAlgorithm s used to obtain a JWE's decryption key. |
NestedCollection<SecureDigestAlgorithm<?,?>,JwtParserBuilder> |
JwtParserBuilder.sig()
Configures the parser's supported
SignatureAlgorithm and
MacAlgorithm s used to verify JWS signatures. |
NestedCollection<CompressionAlgorithm,JwtParserBuilder> |
JwtParserBuilder.zip()
Configures the parser's supported
CompressionAlgorithm s used to decompress JWT payloads. |
Copyright © 2014–2025 jsonwebtoken.io. All rights reserved.