Index (JJWT :: API 0.13.0 API)

A B C D E F G H I J K L M N O P Q R S T U V W X Z

A

A128CBC_HS256 - Static variable in class io.jsonwebtoken.Jwts.ENC: AES_128_CBC_HMAC_SHA_256 authenticated encryption algorithm as defined by RFC 7518, Section 5.2.3.
A128GCM - Static variable in class io.jsonwebtoken.Jwts.ENC: "AES GCM using 128-bit key" as defined by RFC 7518, Section 5.3¹.
A128GCMKW - Static variable in class io.jsonwebtoken.Jwts.KEY: Key wrap algorithm with AES GCM using a 128-bit key, as defined by RFC 7518 (JWA), Section 4.7.
A128KW - Static variable in class io.jsonwebtoken.Jwts.KEY: AES Key Wrap algorithm with default initial value using a 128-bit key, as defined by RFC 7518 (JWA), Section 4.4.
A192CBC_HS384 - Static variable in class io.jsonwebtoken.Jwts.ENC: AES_192_CBC_HMAC_SHA_384 authenticated encryption algorithm, as defined by RFC 7518, Section 5.2.4.
A192GCM - Static variable in class io.jsonwebtoken.Jwts.ENC: "AES GCM using 192-bit key" as defined by RFC 7518, Section 5.3¹.
A192GCMKW - Static variable in class io.jsonwebtoken.Jwts.KEY: Key wrap algorithm with AES GCM using a 192-bit key, as defined by RFC 7518 (JWA), Section 4.7.
A192KW - Static variable in class io.jsonwebtoken.Jwts.KEY: AES Key Wrap algorithm with default initial value using a 192-bit key, as defined by RFC 7518 (JWA), Section 4.4.
A256CBC_HS512 - Static variable in class io.jsonwebtoken.Jwts.ENC: AES_256_CBC_HMAC_SHA_512 authenticated encryption algorithm, as defined by RFC 7518, Section 5.2.5.
A256GCM - Static variable in class io.jsonwebtoken.Jwts.ENC: "AES GCM using 256-bit key" as defined by RFC 7518, Section 5.3¹.
A256GCMKW - Static variable in class io.jsonwebtoken.Jwts.KEY: Key wrap algorithm with AES GCM using a 256-bit key, as defined by RFC 7518 (JWA), Section 4.7.
A256KW - Static variable in class io.jsonwebtoken.Jwts.KEY: AES Key Wrap algorithm with default initial value using a 256-bit key, as defined by RFC 7518 (JWA), Section 4.4.
AbstractDeserializer<T> - Class in io.jsonwebtoken.io: Convenient base class to use to implement Deserializers, with subclasses only needing to implement AbstractDeserializer.doDeserialize(Reader).
AbstractDeserializer() - Constructor for class io.jsonwebtoken.io.AbstractDeserializer: Default constructor, does not initialize any internal state.
AbstractSerializer<T> - Class in io.jsonwebtoken.io: Convenient base class to use to implement Serializers, with subclasses only needing to implement * AbstractSerializer.doSerialize(Object, OutputStream).
AbstractSerializer() - Constructor for class io.jsonwebtoken.io.AbstractSerializer: Default constructor, does not initialize any internal state.
accept(JwtVisitor<T>) - Method in interface io.jsonwebtoken.Jwt: Invokes the specified visitor's appropriate type-specific visit method based on this JWT's type.
add(E) - Method in interface io.jsonwebtoken.lang.CollectionMutator: Adds the specified element to the collection.
add(Collection<? extends E>) - Method in interface io.jsonwebtoken.lang.CollectionMutator: Adds the elements to the collection in iteration order.
add(K, V) - Method in interface io.jsonwebtoken.lang.MapMutator: Sets the specified key/value pair in the map, overwriting any existing entry with the same key.
add(Map<? extends K, ? extends V>) - Method in interface io.jsonwebtoken.lang.MapMutator: Sets the specified key/value pairs in the map, overwriting any existing entries with the same keys.
add(Jwk<?>) - Method in interface io.jsonwebtoken.security.JwkSetBuilder: Appends the specified jwk to the set.
add(Collection<Jwk<?>>) - Method in interface io.jsonwebtoken.security.JwkSetBuilder: Appends the specified Jwk collection to the JWK Set.
add(KeyOperation) - Method in interface io.jsonwebtoken.security.KeyOperationPolicyBuilder: Adds the specified key operation to the policy's total set of supported key operations used to validate a key's intended usage, replacing any existing one with an identical (CaSe-SeNsItIvE) id.
add(Collection<? extends KeyOperation>) - Method in interface io.jsonwebtoken.security.KeyOperationPolicyBuilder: Adds the specified key operations to the policy's total set of supported key operations used to validate a key's intended usage, replacing any existing ones with identical ids.
addClaims(Map<String, ?>) - Method in interface io.jsonwebtoken.JwtBuilder: Deprecated.
since 0.12.0 in favor of JwtBuilder.claims().add(Map).and(). This method will be removed before the 1.0 release.
addObjectToArray(A[], O) - Static method in class io.jsonwebtoken.lang.Objects: Append the given object to the given array, returning a new array consisting of the input array contents plus the given object.
addStringToArray(String[], String) - Static method in class io.jsonwebtoken.lang.Strings: Append the given String to the given String array, returning a new array consisting of the input array contents plus the given String.
AeadAlgorithm - Interface in io.jsonwebtoken.security: A cryptographic algorithm that performs Authenticated encryption with additional data.
AeadRequest - Interface in io.jsonwebtoken.security: A request to an AeadAlgorithm to perform authenticated encryption with a supplied symmetric SecretKey, allowing for additional data to be authenticated and integrity-protected.
AeadResult - Interface in io.jsonwebtoken.security: The result of authenticated encryption, providing access to the ciphertext output stream and resulting AAD tag and initialization vector.
agreementPartyUInfo(byte[]) - Method in interface io.jsonwebtoken.JweHeaderMutator: Sets any information about the JWE producer for use with key agreement algorithms.
agreementPartyUInfo(String) - Method in interface io.jsonwebtoken.JweHeaderMutator: Sets any information about the JWE producer for use with key agreement algorithms.
agreementPartyVInfo(byte[]) - Method in interface io.jsonwebtoken.JweHeaderMutator: Sets any information about the JWE recipient for use with key agreement algorithms.
agreementPartyVInfo(String) - Method in interface io.jsonwebtoken.JweHeaderMutator: Sets any information about the JWE recipient for use with key agreement algorithms.
ALGORITHM - Static variable in interface io.jsonwebtoken.Header: Deprecated.
since 0.12.0 in favor of Header.getAlgorithm().
ALGORITHM - Static variable in interface io.jsonwebtoken.JwsHeader: Deprecated.
since 0.12.0 in favor of Header.getAlgorithm()
algorithm(String) - Method in interface io.jsonwebtoken.security.JwkBuilder: Sets the JWK alg (Algorithm) Parameter.
and() - Method in interface io.jsonwebtoken.lang.Conjunctor: Returns the joined object.
and(K, V) - Method in interface io.jsonwebtoken.lang.Maps.MapBuilder: Add a new entry to this map builder
applyRelativePath(String, String) - Static method in class io.jsonwebtoken.lang.Strings: Apply the given relative path to the given path, assuming standard Java folder separation (i.e.
Arrays - Class in io.jsonwebtoken.lang: Utility methods to work with array instances.
arrayToCommaDelimitedString(Object[]) - Static method in class io.jsonwebtoken.lang.Strings: Convenience method to return a String array as a CSV String.
arrayToDelimitedString(Object[], String) - Static method in class io.jsonwebtoken.lang.Strings: Convenience method to return a String array as a delimited (e.g.
arrayToList(Object) - Static method in class io.jsonwebtoken.lang.Collections: Convert the supplied array into a List.
ascii(byte[]) - Static method in class io.jsonwebtoken.lang.Strings: Returns new String(asciiBytes, StandardCharsets.US_ASCII).
ascii(CharSequence) - Static method in class io.jsonwebtoken.lang.Strings: Returns the US_ASCII-encoded bytes of the specified CharSequence.
asList(T[]) - Static method in class io.jsonwebtoken.lang.Arrays: Converts the specified array to a List.
Assert - Class in io.jsonwebtoken.lang: Utility methods for providing argument and state assertions to reduce repeating these patterns and otherwise increasing cyclomatic complexity.
assertValidSigningKey(Key) - Method in enum io.jsonwebtoken.SignatureAlgorithm: Deprecated.

Returns quietly if the specified key is allowed to create signatures using this algorithm according to the JWT JWA Specification (RFC 7518) or throws an InvalidKeyException if the key is not allowed or not secure enough for this algorithm.
assertValidVerificationKey(Key) - Method in enum io.jsonwebtoken.SignatureAlgorithm: Deprecated.

Returns quietly if the specified key is allowed to verify signatures using this algorithm according to the JWT JWA Specification (RFC 7518) or throws an InvalidKeyException if the key is not allowed or not secure enough for this algorithm.
asSet(Collection<T>) - Static method in class io.jsonwebtoken.lang.Collections: Returns the specified collection as a Set instance.
AssociatedDataSupplier - Interface in io.jsonwebtoken.security: Provides any "associated data" that must be integrity protected (but not encrypted) when performing AEAD encryption or decryption.
AsymmetricJwk<K extends Key> - Interface in io.jsonwebtoken.security: JWK representation of an asymmetric (public or private) cryptographic key.
AsymmetricJwkBuilder<K extends Key,J extends AsymmetricJwk<K>,T extends AsymmetricJwkBuilder<K,J,T>> - Interface in io.jsonwebtoken.security: A JwkBuilder that builds asymmetric (public or private) JWKs.
AUDIENCE - Static variable in interface io.jsonwebtoken.Claims: JWT Audience claims parameter name: "aud"
audience() - Method in interface io.jsonwebtoken.ClaimsMutator: Configures the JWT aud (audience) Claim set, quietly ignoring any null, empty, whitespace-only, or existing value already in the set.

B

b64Url(Encoder<OutputStream, OutputStream>) - Method in interface io.jsonwebtoken.JwtBuilder: Perform Base64Url encoding during compaction with the specified OutputStream Encoder.
b64Url(Decoder<InputStream, InputStream>) - Method in interface io.jsonwebtoken.JwtParserBuilder: Perform Base64Url decoding during parsing with the specified InputStream Decoder.
BASE64 - Static variable in class io.jsonwebtoken.io.Decoders: Very fast Base64 decoder guaranteed to work in all >= Java 7 JDK and Android environments.
BASE64 - Static variable in class io.jsonwebtoken.io.Encoders: Very fast Base64 encoder guaranteed to work in all >= Java 7 JDK and Android environments.
BASE64URL - Static variable in class io.jsonwebtoken.io.Decoders: Very fast Base64Url decoder guaranteed to work in all >= Java 7 JDK and Android environments.
BASE64URL - Static variable in class io.jsonwebtoken.io.Encoders: Very fast Base64Url encoder guaranteed to work in all >= Java 7 JDK and Android environments.
base64UrlDecodeWith(Decoder<CharSequence, byte[]>) - Method in interface io.jsonwebtoken.JwtParserBuilder: Deprecated.
since 0.12.0 in favor of JwtParserBuilder.b64Url(Decoder). This method will be removed before the JJWT 1.0 release.
base64UrlEncodeWith(Encoder<byte[], String>) - Method in interface io.jsonwebtoken.JwtBuilder: Deprecated.
since 0.12.0 in favor of JwtBuilder.b64Url(Encoder).
BOUNCY_CASTLE_AVAILABLE - Static variable in class io.jsonwebtoken.lang.RuntimeEnvironment: Deprecated.
since 0.12.0. will be removed before the 1.0 final release.
build() - Method in interface io.jsonwebtoken.JwtParserBuilder: Returns an immutable/thread-safe JwtParser created from the configuration from this JwtParserBuilder.
build() - Method in interface io.jsonwebtoken.lang.Builder: Creates and returns a new instance of type T.
build() - Method in interface io.jsonwebtoken.lang.Maps.MapBuilder: Returns the resulting Map object from this MapBuilder.
builder() - Static method in class io.jsonwebtoken.Jwts: Returns a new JwtBuilder instance that can be configured and then used to create JWT compact serialized strings.
Builder<T> - Interface in io.jsonwebtoken.lang: Type-safe interface that reflects the Builder pattern.
builder() - Static method in class io.jsonwebtoken.security.Jwks: Return a new JWK builder instance, allowing for type-safe JWK builder coercion based on a specified key or key pair.
builder() - Static method in class io.jsonwebtoken.security.Jwks.OP: Creates a new KeyOperationBuilder for creating custom KeyOperation instances.
builder(SecretKey) - Static method in class io.jsonwebtoken.security.Keys: Returns a SecretKeyBuilder that produces the specified key, allowing association with a provider that must be used with the key during cryptographic operations.
builder(PrivateKey) - Static method in class io.jsonwebtoken.security.Keys: Returns a PrivateKeyBuilder that produces the specified key, allowing association with a publicKey to obtain public key data if necessary, or a provider that must be used with the key during cryptographic operations.

C

capitalize(String) - Static method in class io.jsonwebtoken.lang.Strings: Capitalize a String, changing the first letter to upper case as per Character.toUpperCase(char).
caseInsensitiveValueOf(E[], String) - Static method in class io.jsonwebtoken.lang.Objects: Case insensitive alternative to Enum.valueOf(Class, String).
chain(List<X509Certificate>) - Method in interface io.jsonwebtoken.security.DynamicJwkBuilder: Ensures the builder will create a PublicJwk for the specified Java X509Certificate chain.
claim(String, Object) - Method in interface io.jsonwebtoken.JwtBuilder: Sets a JWT claim, overwriting any existing claim with the same name.
ClaimJwtException - Exception in io.jsonwebtoken: ClaimJwtException is a subclass of the JwtException that is thrown after a validation of an JWT claim failed.
ClaimJwtException(Header, Claims, String) - Constructor for exception io.jsonwebtoken.ClaimJwtException: Creates a new instance with the specified header, claims and exception message.
ClaimJwtException(Header, Claims, String, Throwable) - Constructor for exception io.jsonwebtoken.ClaimJwtException: Creates a new instance with the specified header, claims and exception message as a result of encountering the specified cause.
Claims - Interface in io.jsonwebtoken: A JWT Claims set.
CLAIMS - Static variable in interface io.jsonwebtoken.Jwe: Visitor implementation that ensures the visited JWT is a JSON Web Encryption ('JWE') message with an authenticated and decrypted Claims payload, and rejects all others with an UnsupportedJwtException.
CLAIMS - Static variable in interface io.jsonwebtoken.Jws: Visitor implementation that ensures the visited JWT is a JSON Web Signature ('JWS') message with a cryptographically authenticated/verified Claims payload, and rejects all others with an UnsupportedJwtException.
claims() - Method in interface io.jsonwebtoken.JwtBuilder: Returns the JWT Claims payload to modify as desired.
claims(Map<String, ?>) - Method in interface io.jsonwebtoken.JwtBuilder: Adds all given name/value pairs to the JSON Claims in the payload, overwriting any existing claims with the same names.
claims() - Static method in class io.jsonwebtoken.Jwts: Returns a new Claims builder instance to be used to populate JWT claims, which in aggregate will be the JWT payload.
claims(Map<String, Object>) - Static method in class io.jsonwebtoken.Jwts: Deprecated.
since 0.12.0 in favor of Jwts.Jwts.claims().putAll(map).build(). This method will be removed before 1.0.
ClaimsBuilder - Interface in io.jsonwebtoken: Builder used to create an immutable Claims instance.
ClaimsMutator<T extends ClaimsMutator<T>> - Interface in io.jsonwebtoken: Mutation (modifications) to a Claims instance.
ClaimsMutator.AudienceCollection<P> - Interface in io.jsonwebtoken: A NestedCollection for setting ClaimsMutator.audience() values that also allows overriding the collection to be a single string value for legacy JWT recipients if necessary.
Classes - Class in io.jsonwebtoken.lang: Utility methods for working with Classes.
clean(byte[]) - Static method in class io.jsonwebtoken.lang.Arrays: Returns the byte array unaltered if it is non-null and has a positive length, otherwise null.
clean(String) - Static method in class io.jsonwebtoken.lang.Strings: Returns the specified string without leading or trailing whitespace, or null if there are no remaining characters.
clean(CharSequence) - Static method in class io.jsonwebtoken.lang.Strings: Returns the specified CharSequence without leading or trailing whitespace, or null if there are no remaining characters.
cleanPath(String) - Static method in class io.jsonwebtoken.lang.Strings: Normalize the path by suppressing sequences like "path/.." and inner simple dots.
clear() - Method in interface io.jsonwebtoken.lang.CollectionMutator: Removes all elements in the collection.
Clock - Interface in io.jsonwebtoken: A clock represents a time source that can be used when creating and verifying JWTs.
clock(Clock) - Method in interface io.jsonwebtoken.JwtParserBuilder: Sets the Clock that determines the timestamp to use when validating the parsed JWT.
clockSkewSeconds(long) - Method in interface io.jsonwebtoken.JwtParserBuilder: Sets the amount of clock skew in seconds to tolerate when verifying the local time against the exp and nbf claims.
CodecException - Exception in io.jsonwebtoken.io: An exception thrown when encountering a problem during encoding or decoding.
CodecException(String) - Constructor for exception io.jsonwebtoken.io.CodecException: Creates a new instance with the specified explanation message.
CodecException(String, Throwable) - Constructor for exception io.jsonwebtoken.io.CodecException: Creates a new instance with the specified explanation message and underlying cause.
CollectionMutator<E,M extends CollectionMutator<E,M>> - Interface in io.jsonwebtoken.lang: Mutation (modifications) to a Collection instance while also supporting method chaining.
Collections - Class in io.jsonwebtoken.lang: Utility methods for working with Collections, Lists, Sets, and Maps.
collectionToCommaDelimitedString(Collection<?>) - Static method in class io.jsonwebtoken.lang.Strings: Convenience method to return a Collection as a CSV String.
collectionToDelimitedString(Collection<?>, String, String, String) - Static method in class io.jsonwebtoken.lang.Strings: Convenience method to return a Collection as a delimited (e.g.
collectionToDelimitedString(Collection<?>, String) - Static method in class io.jsonwebtoken.lang.Strings: Convenience method to return a Collection as a delimited (e.g.
commaDelimitedListToSet(String) - Static method in class io.jsonwebtoken.lang.Strings: Convenience method to convert a CSV string list to a set.
commaDelimitedListToStringArray(String) - Static method in class io.jsonwebtoken.lang.Strings: Convert a CSV list into an array of Strings.
compact() - Method in interface io.jsonwebtoken.JwtBuilder: Actually builds the JWT and serializes it to a compact, URL-safe string according to the JWT Compact Serialization rules.
compress(byte[]) - Method in interface io.jsonwebtoken.CompressionCodec: Deprecated.
compress(OutputStream) - Method in interface io.jsonwebtoken.io.CompressionAlgorithm: Wraps the specified OutputStream to ensure any stream bytes are compressed as they are written.
COMPRESSION_ALGORITHM - Static variable in interface io.jsonwebtoken.Header: Deprecated.
since 0.12.0 in favor of Header.getCompressionAlgorithm()
CompressionAlgorithm - Interface in io.jsonwebtoken.io: Compresses and decompresses byte streams.
CompressionCodec - Interface in io.jsonwebtoken: Deprecated.
since 0.12.0 in favor of CompressionAlgorithm to equal the RFC name for this concept.
CompressionCodecResolver - Interface in io.jsonwebtoken: Deprecated.
in favor of JwtParserBuilder.zip()
CompressionCodecs - Class in io.jsonwebtoken: Deprecated.
in favor of Jwts.ZIP.
CompressionException - Exception in io.jsonwebtoken: Exception indicating that either compressing or decompressing a JWT body failed.
CompressionException(String) - Constructor for exception io.jsonwebtoken.CompressionException: Creates a new instance with the specified explanation message.
CompressionException(String, Throwable) - Constructor for exception io.jsonwebtoken.CompressionException: Creates a new instance with the specified explanation message and underlying cause.
compressWith(CompressionAlgorithm) - Method in interface io.jsonwebtoken.JwtBuilder: Compresses the JWT payload using the specified CompressionAlgorithm.
concat(Set<T>, T...) - Static method in class io.jsonwebtoken.lang.Collections: Concatenate the specified set with the specified array elements, resulting in a new LinkedHashSet with the array elements appended to the end of the existing Set.
concatenateStringArrays(String[], String[]) - Static method in class io.jsonwebtoken.lang.Strings: Concatenate the given String arrays into one, with overlapping array elements included twice.
Conjunctor<T> - Interface in io.jsonwebtoken.lang: A Conjunctor supplies a joined object.
contains(Iterator, Object) - Static method in class io.jsonwebtoken.lang.Collections: Check whether the given Iterator contains the given element.
contains(Enumeration, Object) - Static method in class io.jsonwebtoken.lang.Collections: Check whether the given Enumeration contains the given element.
containsAny(Collection, Collection) - Static method in class io.jsonwebtoken.lang.Collections: Return true if any element in 'candidates' is contained in 'source'; otherwise returns false.
containsConstant(Enum<?>[], String) - Static method in class io.jsonwebtoken.lang.Objects: Check whether the given array of enum constants contains a constant with the given name, ignoring case when determining a match.
containsConstant(Enum<?>[], String, boolean) - Static method in class io.jsonwebtoken.lang.Objects: Check whether the given array of enum constants contains a constant with the given name.
containsElement(Object[], Object) - Static method in class io.jsonwebtoken.lang.Objects: Check whether the given array contains the given element.
containsInstance(Collection, Object) - Static method in class io.jsonwebtoken.lang.Collections: Check whether the given Collection contains the given element instance.
containsWhitespace(CharSequence) - Static method in class io.jsonwebtoken.lang.Strings: Check whether the given CharSequence contains any whitespace characters.
containsWhitespace(String) - Static method in class io.jsonwebtoken.lang.Strings: Check whether the given String contains any whitespace characters.
CONTENT - Static variable in interface io.jsonwebtoken.Jwe: Visitor implementation that ensures the visited JWT is a JSON Web Encryption ('JWE') message with an authenticated and decrypted byte[] array payload, and rejects all others with an UnsupportedJwtException.
CONTENT - Static variable in interface io.jsonwebtoken.Jws: Visitor implementation that ensures the visited JWT is a JSON Web Signature ('JWS') message with a cryptographically authenticated/verified byte[] array payload, and rejects all others with an UnsupportedJwtException.
content(String) - Method in interface io.jsonwebtoken.JwtBuilder: Sets the JWT payload to be the specified string's UTF-8 bytes.
content(byte[]) - Method in interface io.jsonwebtoken.JwtBuilder: Sets the JWT payload to be the specified content byte array.
content(InputStream) - Method in interface io.jsonwebtoken.JwtBuilder: Sets the JWT payload to be the bytes in the specified content stream.
content(String, String) - Method in interface io.jsonwebtoken.JwtBuilder: Sets the JWT payload to be the specified String's UTF-8 bytes, and also sets the contentType header value to a compact cty IANA Media Type identifier to indicate the data format of the resulting byte array.
content(byte[], String) - Method in interface io.jsonwebtoken.JwtBuilder: Sets the JWT payload to be the specified byte array, and also sets the contentType header value to a compact cty IANA Media Type identifier to indicate the data format of the byte array.
content(InputStream, String) - Method in interface io.jsonwebtoken.JwtBuilder: Sets the JWT payload to be the specified content byte stream and also sets the contentType header value to a compact cty IANA Media Type identifier to indicate the data format of the byte array.
CONTENT_TYPE - Static variable in interface io.jsonwebtoken.Header: Deprecated.
since 0.12.0 in favor of Header.getContentType().
contentType(String) - Method in interface io.jsonwebtoken.HeaderMutator: Sets the compact cty (Content Type) header parameter value, used by applications to declare the IANA MediaType of the JWT payload.
copy(Object) - Static method in class io.jsonwebtoken.lang.Arrays: Creates a shallow copy of the specified object or array.
countOccurrencesOf(String, String) - Static method in class io.jsonwebtoken.lang.Strings: Returns the number of occurrences the substring sub appears in string str.
CRITICAL - Static variable in interface io.jsonwebtoken.JwsHeader: Deprecated.
since 0.12.0 in favor of ProtectedHeader.getCritical()
critical() - Method in interface io.jsonwebtoken.JwtParserBuilder: Configures the ProtectedHeader parameter names used in JWT extensions supported by the application.
critical() - Method in interface io.jsonwebtoken.ProtectedHeaderMutator: Configures names of header parameters used by JWT or JWA specification extensions that MUST be understood and supported by the JWT recipient.
Curve - Interface in io.jsonwebtoken.security: A cryptographic Elliptic Curve for use with digital signature or key agreement algorithms.

D

DateFormats - Class in io.jsonwebtoken.lang: Utility methods to format and parse date strings.
decode(T) - Method in interface io.jsonwebtoken.io.Decoder: Convert the specified encoded data value into the desired data type.
Decoder<T,R> - Interface in io.jsonwebtoken.io: A decoder converts an already-encoded data value to a desired data type.
Decoders - Class in io.jsonwebtoken.io: Constant definitions for various decoding algorithms.
DecodingException - Exception in io.jsonwebtoken.io: An exception thrown when encountering a problem during decoding.
DecodingException(String) - Constructor for exception io.jsonwebtoken.io.DecodingException: Creates a new instance with the specified explanation message.
DecodingException(String, Throwable) - Constructor for exception io.jsonwebtoken.io.DecodingException: Creates a new instance with the specified explanation message and underlying cause.
decompress(byte[]) - Method in interface io.jsonwebtoken.CompressionCodec: Deprecated.
decompress(InputStream) - Method in interface io.jsonwebtoken.io.CompressionAlgorithm: Wraps the specified InputStream to ensure any stream bytes are decompressed as they are read.
decrypt(DecryptAeadRequest, OutputStream) - Method in interface io.jsonwebtoken.security.AeadAlgorithm: Decrypts ciphertext and authenticates any associated data, writing the decrypted plaintext to the provided output stream.
DECRYPT - Static variable in class io.jsonwebtoken.security.Jwks.OP: decrypt operation indicating a key is intended to be used to decrypt content.
DecryptAeadRequest - Interface in io.jsonwebtoken.security: A request to an AeadAlgorithm to decrypt ciphertext and perform integrity-protection with a supplied decryption SecretKey.
DecryptionKeyRequest<K extends Key> - Interface in io.jsonwebtoken.security: A KeyRequest to obtain a decryption key that will be used to decrypt a JWE using an AeadAlgorithm.
decryptWith(SecretKey) - Method in interface io.jsonwebtoken.JwtParserBuilder: Sets the decryption SecretKey used to decrypt all encountered JWEs.
decryptWith(PrivateKey) - Method in interface io.jsonwebtoken.JwtParserBuilder: Sets the decryption PrivateKey used to decrypt all encountered JWEs.
DEF - Static variable in class io.jsonwebtoken.Jwts.ZIP: The JWE-standard DEFLATE compression algorithm with a zip header value of "DEF".
DEFLATE - Static variable in class io.jsonwebtoken.CompressionCodecs: Deprecated.
in favor of Jwts.ZIP.DEF.
delete(K) - Method in interface io.jsonwebtoken.lang.MapMutator: Removes the map entry with the specified key.
delete(String, String) - Static method in class io.jsonwebtoken.lang.Strings: Delete all occurrences of the given substring.
deleteAny(String, String) - Static method in class io.jsonwebtoken.lang.Strings: Delete any character in a given String.
delimitedListToStringArray(String, String) - Static method in class io.jsonwebtoken.lang.Strings: Take a String which is a delimited list and convert it to a String array.
delimitedListToStringArray(String, String, String) - Static method in class io.jsonwebtoken.lang.Strings: Take a String which is a delimited list and convert it to a String array.
DEPRECATED_COMPRESSION_ALGORITHM - Static variable in interface io.jsonwebtoken.Header: Deprecated.
use Header.COMPRESSION_ALGORITHM instead.
DERIVE_BITS - Static variable in class io.jsonwebtoken.security.Jwks.OP: deriveBits operation indicating a key is intended to be used to derive bits that are not to be used as key.
DERIVE_KEY - Static variable in class io.jsonwebtoken.security.Jwks.OP: deriveKey operation indicating a key is intended to be used to derive another key.
description(String) - Method in interface io.jsonwebtoken.security.KeyOperationBuilder: Sets the key operation description.
DeserializationException - Exception in io.jsonwebtoken.io: Exception thrown when reconstituting a serialized byte array into a Java object.
DeserializationException(String) - Constructor for exception io.jsonwebtoken.io.DeserializationException: Creates a new instance with the specified explanation message.
DeserializationException(String, Throwable) - Constructor for exception io.jsonwebtoken.io.DeserializationException: Creates a new instance with the specified explanation message and underlying cause.
deserialize(byte[]) - Method in class io.jsonwebtoken.io.AbstractDeserializer: Convert the specified formatted data byte array into a Java object.
deserialize(Reader) - Method in class io.jsonwebtoken.io.AbstractDeserializer: Reads the specified character stream and returns the corresponding Java object.
deserialize(byte[]) - Method in interface io.jsonwebtoken.io.Deserializer: Deprecated.
since 0.12.0 in favor of Deserializer.deserialize(Reader)
deserialize(Reader) - Method in interface io.jsonwebtoken.io.Deserializer: Reads the specified character stream and returns the corresponding Java object.
deserializeJsonWith(Deserializer<Map<String, ?>>) - Method in interface io.jsonwebtoken.JwtParserBuilder: Deprecated.
since 0.12.0 in favor of JwtParserBuilder.json(Deserializer). This method will be removed before the JJWT 1.0 release.
Deserializer<T> - Interface in io.jsonwebtoken.io: A Deserializer is able to convert serialized byte streams into Java objects.
digest(R) - Method in interface io.jsonwebtoken.security.DigestAlgorithm: Returns a cryptographic digest of the request payload.
DigestAlgorithm<R extends Request<InputStream>,V extends VerifyDigestRequest> - Interface in io.jsonwebtoken.security: A DigestAlgorithm is a Cryptographic Hash Function that computes and verifies cryptographic digests.
DigestSupplier - Interface in io.jsonwebtoken.security: A DigestSupplier provides access to the result of a cryptographic digest algorithm, such as a Message Digest, MAC, Signature, or Authentication Tag.
DIRECT - Static variable in class io.jsonwebtoken.Jwts.KEY: Key algorithm reflecting direct use of a shared symmetric key as the JWE AEAD encryption key, as defined by RFC 7518 (JWA), Section 4.5.
doDeserialize(Reader) - Method in class io.jsonwebtoken.io.AbstractDeserializer: Reads the specified character stream and returns the corresponding Java object.
doesNotContain(String, String, String) - Static method in class io.jsonwebtoken.lang.Assert: Assert that the given text does not contain the given substring.
doesNotContain(String, String) - Static method in class io.jsonwebtoken.lang.Assert: Assert that the given text does not contain the given substring.
doLocate(Header) - Method in class io.jsonwebtoken.LocatorAdapter: Returns an object referenced in the specified unprotected JWT header, or null if the referenced object cannot be found or does not exist.
doSerialize(T, OutputStream) - Method in class io.jsonwebtoken.io.AbstractSerializer: Converts the specified Java object into a formatted data byte stream, writing the bytes to the specified output stream.
DynamicJwkBuilder<K extends Key,J extends Jwk<K>> - Interface in io.jsonwebtoken.security: A JwkBuilder that coerces to a more type-specific builder based on the Key that will be represented as a JWK.

E

ecChain(List<X509Certificate>) - Method in interface io.jsonwebtoken.security.DynamicJwkBuilder: Ensures the builder will create an EcPublicJwk for the specified Java X509Certificate chain.
ECDH_ES - Static variable in class io.jsonwebtoken.Jwts.KEY: Key Agreement with ECDH-ES using Concat KDF as defined by RFC 7518 (JWA), Section 4.6.
ECDH_ES_A128KW - Static variable in class io.jsonwebtoken.Jwts.KEY: Key Agreement with Key Wrapping via ECDH-ES using Concat KDF and CEK wrapped with "A128KW" as defined by RFC 7518 (JWA), Section 4.6.
ECDH_ES_A192KW - Static variable in class io.jsonwebtoken.Jwts.KEY: Key Agreement with Key Wrapping via ECDH-ES using Concat KDF and CEK wrapped with "A192KW" as defined by RFC 7518 (JWA), Section 4.6.
ECDH_ES_A256KW - Static variable in class io.jsonwebtoken.Jwts.KEY: Key Agreement with Key Wrapping via ECDH-ES using Concat KDF and CEK wrapped with "A256KW" as defined by RFC 7518 (JWA), Section 4.6.
ecKeyPair(KeyPair) - Method in interface io.jsonwebtoken.security.DynamicJwkBuilder: Ensures the builder will create an EcPrivateJwk for the specified Java Elliptic Curve KeyPair.
EcPrivateJwk - Interface in io.jsonwebtoken.security: JWK representation of an ECPrivateKey as defined by the JWA (RFC 7518) specification sections on Parameters for Elliptic Curve Keys and Parameters for Elliptic Curve Private Keys.
EcPrivateJwkBuilder - Interface in io.jsonwebtoken.security: A PrivateJwkBuilder that creates EcPrivateJwks.
EcPublicJwk - Interface in io.jsonwebtoken.security: JWK representation of an ECPublicKey as defined by the JWA (RFC 7518) specification sections on Parameters for Elliptic Curve Keys and Parameters for Elliptic Curve Public Keys.
EcPublicJwkBuilder - Interface in io.jsonwebtoken.security: A PublicJwkBuilder that creates EcPublicJwks.
Ed25519 - Static variable in class io.jsonwebtoken.security.Jwks.CRV: Ed25519 Elliptic Curve defined by RFC 8037, Section 3.1 using the native Java JCA Ed25519¹ algorithm.
Ed448 - Static variable in class io.jsonwebtoken.security.Jwks.CRV: Ed448 Elliptic Curve defined by RFC 8037, Section 3.1 using the native Java JCA Ed448¹ algorithm.
EdDSA - Static variable in class io.jsonwebtoken.Jwts.SIG: EdDSA signature algorithm defined by RFC 8037, Section 3.1 that requires either Ed25519 or Ed448 Edwards Elliptic Curve¹ keys.
empty() - Method in interface io.jsonwebtoken.lang.MapMutator: Removes all entries from the map.
EMPTY - Static variable in class io.jsonwebtoken.lang.Strings: Empty String, equal to "".
emptyList() - Static method in class io.jsonwebtoken.lang.Collections: Returns a type-safe immutable empty List.
emptyMap() - Static method in class io.jsonwebtoken.lang.Collections: Returns a type-safe immutable empty Map.
emptySet() - Static method in class io.jsonwebtoken.lang.Collections: Returns a type-safe immutable empty Set.
enableBouncyCastleIfPossible() - Static method in class io.jsonwebtoken.lang.RuntimeEnvironment: Deprecated.
since 0.12.0. will be removed before the 1.0 final release.
enc() - Method in interface io.jsonwebtoken.JwtParserBuilder: Configures the parser's supported AeadAlgorithms used to decrypt JWE payloads.
encode(T) - Method in interface io.jsonwebtoken.io.Encoder: Convert the specified data into another formatted data value.
encodePayload(boolean) - Method in interface io.jsonwebtoken.JwtBuilder: Enables RFC 7797: JSON Web Signature (JWS) Unencoded Payload Option if false, or standard JWT/JWS/JWE payload encoding otherwise.
Encoder<T,R> - Interface in io.jsonwebtoken.io: An encoder converts data of one type into another formatted data value.
Encoders - Class in io.jsonwebtoken.io: Constant definitions for various encoding algorithms.
EncodingException - Exception in io.jsonwebtoken.io: An exception thrown when encountering a problem during encoding.
EncodingException(String, Throwable) - Constructor for exception io.jsonwebtoken.io.EncodingException: Creates a new instance with the specified explanation message and underlying cause.
encrypt(AeadRequest, AeadResult) - Method in interface io.jsonwebtoken.security.AeadAlgorithm: Encrypts plaintext and signs any associated data, placing the resulting ciphertext, initialization vector and authentication tag in the provided result.
ENCRYPT - Static variable in class io.jsonwebtoken.security.Jwks.OP: encrypt operation indicating a key is intended to be used to encrypt content.
encryptWith(SecretKey, AeadAlgorithm) - Method in interface io.jsonwebtoken.JwtBuilder: Encrypts the constructed JWT with the specified symmetric key using the provided encryption algorithm, producing a JWE.
encryptWith(K, KeyAlgorithm<? super K, ?>, AeadAlgorithm) - Method in interface io.jsonwebtoken.JwtBuilder: Encrypts the constructed JWT using the specified enc algorithm with the symmetric key produced by the keyAlg when invoked with the given key, producing a JWE.
endsWithIgnoreCase(String, String) - Static method in class io.jsonwebtoken.lang.Strings: Returns true if the given string ends with the specified case-insensitive suffix, false otherwise.
EOF - Static variable in class io.jsonwebtoken.io.AbstractDeserializer: EOF (End of File) marker, equal to -1.
eq(T, T, String) - Static method in class io.jsonwebtoken.lang.Assert: Asserts that a specified value is equal to the given requirement, throwing an IllegalArgumentException with the given message if not.
ES256 - Static variable in class io.jsonwebtoken.Jwts.SIG: ECDSA using P-256 and SHA-256 signature algorithm as defined by RFC 7518, Section 3.4.
ES384 - Static variable in class io.jsonwebtoken.Jwts.SIG: ECDSA using P-384 and SHA-384 signature algorithm as defined by RFC 7518, Section 3.4.
ES512 - Static variable in class io.jsonwebtoken.Jwts.SIG: ECDSA using P-521 and SHA-512 signature algorithm as defined by RFC 7518, Section 3.4.
EXPIRATION - Static variable in interface io.jsonwebtoken.Claims: JWT Expiration claims parameter name: "exp"
expiration(Date) - Method in interface io.jsonwebtoken.ClaimsMutator: Sets the JWT exp (expiration) timestamp claim.
expiration(Date) - Method in interface io.jsonwebtoken.JwtBuilder: Sets the JWT Claims exp (expiration) claim.
ExpiredJwtException - Exception in io.jsonwebtoken: Exception indicating that a JWT was accepted after it expired and must be rejected.
ExpiredJwtException(Header, Claims, String) - Constructor for exception io.jsonwebtoken.ExpiredJwtException: Creates a new instance with the specified header, claims, and explanation message.
ExpiredJwtException(Header, Claims, String, Throwable) - Constructor for exception io.jsonwebtoken.ExpiredJwtException: Creates a new instance with the specified header, claims, explanation message and underlying cause.

F

findCommonElementType(Collection) - Static method in class io.jsonwebtoken.lang.Collections: Find the common element type of the given Collection, if any.
findFirstMatch(Collection, Collection) - Static method in class io.jsonwebtoken.lang.Collections: Return the first element in 'candidates' that is contained in 'source'.
findValueOfType(Collection<?>, Class<T>) - Static method in class io.jsonwebtoken.lang.Collections: Find a single value of the given type in the given Collection.
findValueOfType(Collection<?>, Class<?>[]) - Static method in class io.jsonwebtoken.lang.Collections: Find a single value of one of the given types in the given Collection: searching the Collection for a value of the first type, then searching for a value of the second type, etc.
forKey(K) - Method in interface io.jsonwebtoken.lang.Registry: Returns the value assigned the specified key or throws an IllegalArgumentException if there is no associated value.
formatIso8601(Date) - Static method in class io.jsonwebtoken.lang.DateFormats: Return an ISO-8601-formatted string with millisecond precision representing the specified date.
formatIso8601(Date, boolean) - Static method in class io.jsonwebtoken.lang.DateFormats: Returns an ISO-8601-formatted string with optional millisecond precision for the specified date.
forName(String) - Static method in class io.jsonwebtoken.lang.Classes: Attempts to load the specified class name from the current thread's context class loader, then the current ClassLoader (Classes.class.getClassLoader()), then the system/application ClassLoader (ClassLoader.getSystemClassLoader(), in that order.
forName(String) - Static method in enum io.jsonwebtoken.SignatureAlgorithm: Deprecated.

Looks up and returns the corresponding SignatureAlgorithm enum instance based on a case-insensitive name comparison.
forSigningKey(Key) - Static method in enum io.jsonwebtoken.SignatureAlgorithm: Deprecated.

Returns the recommended signature algorithm to be used with the specified key according to the following heuristics: Key Signature Algorithm If the Key is a: And: With a key size of: The returned SignatureAlgorithm will be: SecretKey getAlgorithm().equals("HmacSHA256")¹ 256 <= size <= 383 ² HS256 SecretKey getAlgorithm().equals("HmacSHA384")¹ 384 <= size <= 511 HS384 SecretKey getAlgorithm().equals("HmacSHA512")¹ 512 <= size HS512 ECKey instanceof PrivateKey 256 <= size <= 383 ³ ES256 ECKey instanceof PrivateKey 384 <= size <= 511 ES384 ECKey instanceof PrivateKey 4096 <= size ES512 RSAKey instanceof PrivateKey 2048 <= size <= 3071 ^4,5 RS256 RSAKey instanceof PrivateKey 3072 <= size <= 4095 ⁵ RS384 RSAKey instanceof PrivateKey 4096 <= size ⁵ RS512

G

get(String, Class<T>) - Method in interface io.jsonwebtoken.Claims: Returns the JWTs claim (claimName) value as a requiredType instance, or null if not present.
get() - Static method in class io.jsonwebtoken.Jwts.ENC: Returns all standard JWA Cryptographic Algorithms for Content Encryption defined in the JSON Web Signature and Encryption Algorithms Registry.
get() - Static method in class io.jsonwebtoken.Jwts.KEY: Returns all standard JWA standard Cryptographic Algorithms for Key Management..
get() - Static method in class io.jsonwebtoken.Jwts.SIG: Returns all standard JWA Cryptographic Algorithms for Digital Signatures and MACs defined in the JSON Web Signature and Encryption Algorithms Registry.
get() - Static method in class io.jsonwebtoken.Jwts.ZIP: Returns various useful Compression Algorithms.
get() - Method in interface io.jsonwebtoken.lang.Supplier: Returns a result.
get() - Static method in class io.jsonwebtoken.security.Jwks.CRV: Returns a registry of all standard Elliptic Curves in the JSON Web Key Elliptic Curve Registry defined by RFC 7518, Section 7.6 (for Weierstrass Elliptic Curves) and RFC 8037, Section 5 (for Edwards Elliptic Curves).
get() - Static method in class io.jsonwebtoken.security.Jwks.HASH: Returns a registry of various (but not all) IANA Hash Algorithms commonly used to compute JWK Thumbprints and ensure valid JWK Thumbprint URIs.
get() - Static method in class io.jsonwebtoken.security.Jwks.OP: Returns a registry of all standard Key Operations in the JSON Web Key Operations Registry defined by RFC 7517, Section 8.3.
getAgreementPartyUInfo() - Method in interface io.jsonwebtoken.JweHeader: Returns any information about the JWE producer for use with key agreement algorithms, or null if not present.
getAgreementPartyVInfo() - Method in interface io.jsonwebtoken.JweHeader: Returns any information about the JWE recipient for use with key agreement algorithms, or null if not present.
getAlgorithm() - Method in interface io.jsonwebtoken.Header: Returns the JWT alg (Algorithm) header value or null if not present.
getAlgorithm() - Method in interface io.jsonwebtoken.security.Jwk: Returns the JWK alg (Algorithm) value or null if not present.
getAlgorithmName() - Method in interface io.jsonwebtoken.CompressionCodec: Deprecated.
since 0.12.0 in favor of Identifiable.getId() to ensure congruence with all other identifiable algorithms.
getAssociatedData() - Method in interface io.jsonwebtoken.security.AssociatedDataSupplier: Returns any data that must be integrity protected (but not encrypted) when performing AEAD encryption or decryption, or null if no additional data must be integrity protected.
getAudience() - Method in interface io.jsonwebtoken.Claims: Returns the JWT aud (audience) value or null if not present.
getAuthenticationTag() - Method in interface io.jsonwebtoken.JweHeader: Returns the 128-bit "tag" (Authentication Tag) resulting from key encryption, or null if not present.
getBody() - Method in interface io.jsonwebtoken.Jwt: Deprecated.
since 0.12.0 because it has been renamed to Jwt.getPayload(). 'Payload' (not body) is what the JWT specifications call this property, so it has been renamed to reflect the correct JWT nomenclature/taxonomy.
getClaimName() - Method in exception io.jsonwebtoken.InvalidClaimException: Returns the name of the invalid claim.
getClaims() - Method in exception io.jsonwebtoken.ClaimJwtException: Returns the Claims that failed validation.
getClaimValue() - Method in exception io.jsonwebtoken.InvalidClaimException: Returns the claim value that could not be validated.
getCompressionAlgorithm() - Method in interface io.jsonwebtoken.Header: Returns the JWT zip (Compression Algorithm) header parameter value or null if not present.
getConstructor(Class<T>, Class<?>...) - Static method in class io.jsonwebtoken.lang.Classes: Returns the Constructor for the specified Class with arguments matching the specified argTypes.
getContentType() - Method in interface io.jsonwebtoken.Header: Returns the cty (Content Type) header value or null if not present.
getCritical() - Method in interface io.jsonwebtoken.ProtectedHeader: Returns the header parameter names that use extensions to the JWT or JWA specification(s) that MUST be understood and supported by the JWT recipient, or null if not present.
getDecryptionKey(DecryptionKeyRequest<D>) - Method in interface io.jsonwebtoken.security.KeyAlgorithm: Return the SecretKey that should be used to decrypt a JWE via the request's specified AeadAlgorithm.
getDescription() - Method in interface io.jsonwebtoken.security.KeyOperation: Returns a brief description of the key operation behavior.
getDescription() - Method in enum io.jsonwebtoken.SignatureAlgorithm: Deprecated.

Returns the JWA algorithm description.
getDigest() - Method in interface io.jsonwebtoken.security.DigestSupplier: Returns a cryptographic digest result, such as a Message Digest, MAC, Signature, or Authentication Tag depending on the cryptographic algorithm that produced it.
getDisplayString(Object) - Static method in class io.jsonwebtoken.lang.Objects: Return a content-based String representation if obj is not null; otherwise returns an empty String.
getEncryptionAlgorithm() - Method in interface io.jsonwebtoken.JweHeader: Returns the JWE enc (Encryption Algorithm) header value or null if not present.
getEncryptionAlgorithm() - Method in interface io.jsonwebtoken.security.KeyRequest: Returns the AeadAlgorithm that will be called for encryption or decryption after processing the KeyRequest.
getEncryptionKey(KeyRequest<E>) - Method in interface io.jsonwebtoken.security.KeyAlgorithm: Return the SecretKey that should be used to encrypt a JWE via the request's specified AeadAlgorithm.
getEphemeralPublicKey() - Method in interface io.jsonwebtoken.JweHeader: Returns the epk (Ephemeral Public Key) header value created by the JWE originator for use with key agreement algorithms, or null if not present.
getExpiration() - Method in interface io.jsonwebtoken.Claims: Returns the JWT exp (expiration) timestamp or null if not present.
getFamilyName() - Method in enum io.jsonwebtoken.SignatureAlgorithm: Deprecated.

Returns the cryptographic family name of the signature algorithm.
getFieldValue(Object, String, Class<T>) - Static method in class io.jsonwebtoken.lang.Classes: Returns the instance's named (declared) field value.
getFilename(String) - Static method in class io.jsonwebtoken.lang.Strings: Extract the filename from the given path, e.g.
getFilenameExtension(String) - Static method in class io.jsonwebtoken.lang.Strings: Extract the filename extension from the given path, e.g.
getHashAlgorithm() - Method in interface io.jsonwebtoken.security.JwkThumbprint: Returns the HashAlgorithm used to compute the thumbprint.
getHeader() - Method in exception io.jsonwebtoken.ClaimJwtException: Returns the header associated with the claims that failed validation.
getHeader() - Method in interface io.jsonwebtoken.Jwt: Returns the JWT Header or null if not present.
getHeader() - Method in interface io.jsonwebtoken.security.KeyRequest: Returns the JweHeader that will be used to construct the final JWE header, available for reading or writing any KeyAlgorithm-specific information.
getId() - Method in interface io.jsonwebtoken.Claims: Returns the JWTs jti (JWT ID) value or null if not present.
getId() - Method in interface io.jsonwebtoken.Identifiable: Returns the unique string identifier of the associated object.
getIdentityHexString(Object) - Static method in class io.jsonwebtoken.lang.Objects: Return a hex String form of an object's identity hash code.
getInitializationVector() - Method in interface io.jsonwebtoken.Jwe: Returns the Initialization Vector used during JWE encryption and decryption.
getInitializationVector() - Method in interface io.jsonwebtoken.JweHeader: Returns the 96-bit "iv" (Initialization Vector) generated during key encryption, or null if not present.
getIssuedAt() - Method in interface io.jsonwebtoken.Claims: Returns the JWT iat (issued at) timestamp or null if not present.
getIssuer() - Method in interface io.jsonwebtoken.Claims: Returns the JWT iss (issuer) value or null if not present.
getIv() - Method in interface io.jsonwebtoken.security.IvSupplier: Returns the secure-random Initialization Vector used during encryption, which must in turn be presented for use during decryption.
getJcaName() - Method in enum io.jsonwebtoken.SignatureAlgorithm: Deprecated.

Returns the name of the JCA algorithm used to compute the signature.
getJwk() - Method in interface io.jsonwebtoken.ProtectedHeader: Returns the jwk (JSON Web Key) associated with the JWT.
getJwkSetUrl() - Method in interface io.jsonwebtoken.ProtectedHeader: Returns the jku (JWK Set URL) value that refers to a JWK Set resource containing JSON-encoded Public Keys, or null if not present.
getKey() - Method in interface io.jsonwebtoken.security.KeySupplier: Returns the key to use for signing, wrapping, encryption or decryption depending on the type of operation.
getKeyBitLength() - Method in interface io.jsonwebtoken.security.KeyLengthSupplier: Returns the required length in bits (not bytes) of keys usable with the associated algorithm.
getKeyId() - Method in interface io.jsonwebtoken.ProtectedHeader: Returns the JWT case-sensitive kid (Key ID) header value or null if not present.
getKeys() - Method in interface io.jsonwebtoken.security.JwkSet: Returns the non-null, non-empty set of JWKs contained within the JwkSet.
getMinKeyLength() - Method in enum io.jsonwebtoken.SignatureAlgorithm: Deprecated.

Returns the minimum key length in bits (not bytes) that may be used with this algorithm according to the JWT JWA Specification (RFC 7518).
getNotBefore() - Method in interface io.jsonwebtoken.Claims: Returns the JWT nbf (not before) timestamp or null if not present.
getOperations() - Method in interface io.jsonwebtoken.security.Jwk: Returns the JWK key_ops (Key Operations) parameter values or null if not present.
getOperations() - Method in interface io.jsonwebtoken.security.KeyOperationPolicy: Returns all supported KeyOperations that may be assigned to a JWK.
getOutputStream() - Method in interface io.jsonwebtoken.security.AeadResult: Returns the OutputStream the AeadAlgorithm will use to write the resulting ciphertext during encryption or plaintext during decryption.
getPayload() - Method in interface io.jsonwebtoken.Jwt: Returns the JWT payload, either a byte[] or a Claims instance.
getPayload() - Method in interface io.jsonwebtoken.security.Message: Returns the message payload used as input to or output from a cryptographic algorithm.
getPbes2Count() - Method in interface io.jsonwebtoken.JweHeader: Returns the number of PBKDF2 iterations necessary to derive the key used during JWE encryption, or null if not present.
getPbes2Salt() - Method in interface io.jsonwebtoken.JweHeader: Returns the PBKDF2 Salt Input value necessary to derive the key used during JWE encryption, or null if not present.
getPrivate() - Method in interface io.jsonwebtoken.security.KeyPair: Returns the pair's private key.
getProvider() - Method in interface io.jsonwebtoken.security.Request: Returns the JCA provider that should be used for cryptographic operations during the request or null if the JCA subsystem preferred provider should be used.
getPublic() - Method in interface io.jsonwebtoken.security.KeyPair: Returns the pair's public key.
getPublicKeyUse() - Method in interface io.jsonwebtoken.security.AsymmetricJwk: Returns the JWK use (Public Key Use) parameter value or null if not present.
getResourceAsStream(String) - Static method in class io.jsonwebtoken.lang.Classes: Returns the specified resource by checking the current thread's context class loader, then the current ClassLoader (Classes.class.getClassLoader()), then the system/application ClassLoader (ClassLoader.getSystemClassLoader(), in that order, using getResourceAsStream(name).
getSecureRandom() - Method in interface io.jsonwebtoken.security.Request: Returns the SecureRandom to use when performing cryptographic operations during the request, or null if a default SecureRandom should be used.
getSignature() - Method in interface io.jsonwebtoken.Jws: Deprecated.
since 0.12.0 in favor of getDigest().
getSubject() - Method in interface io.jsonwebtoken.Claims: Returns the JWT sub (subject) value or null if not present.
getType() - Method in interface io.jsonwebtoken.Header: Returns the typ (Type) header value or null if not present.
getType() - Method in interface io.jsonwebtoken.security.Jwk: Returns the required JWK kty (Key Type) parameter value.
getValue() - Method in enum io.jsonwebtoken.SignatureAlgorithm: Deprecated.

Returns the JWA algorithm name constant.
getX509Chain() - Method in interface io.jsonwebtoken.security.X509Accessor: Returns the associated x5c (X.509 Certificate Chain), or null if not present.
getX509Sha1Thumbprint() - Method in interface io.jsonwebtoken.security.X509Accessor: Returns the x5t (X.509 Certificate SHA-1 Thumbprint) (a.k.a.
getX509Sha256Thumbprint() - Method in interface io.jsonwebtoken.security.X509Accessor: Returns the x5t#S256 (X.509 Certificate SHA-256 Thumbprint) (a.k.a.
getX509Url() - Method in interface io.jsonwebtoken.security.X509Accessor: Returns the x5u (X.509 URL) that refers to a resource for the associated X.509 public key certificate or certificate chain, or null if not present.
gt(T, T, String) - Static method in class io.jsonwebtoken.lang.Assert: Asserts that a specified value is greater than the given requirement, throwing an IllegalArgumentException with the given message if not.
GZIP - Static variable in class io.jsonwebtoken.CompressionCodecs: Deprecated.
in favor of Jwts.ZIP.GZIP
GZIP - Static variable in class io.jsonwebtoken.Jwts.ZIP: A commonly used, but NOT JWA-STANDARD gzip compression algorithm with a zip header value of "GZIP".

H

HashAlgorithm - Interface in io.jsonwebtoken.security: A DigestAlgorithm that computes and verifies digests without the use of a cryptographic key, such as for thumbprints and digital fingerprints.
hashCode(boolean) - Static method in class io.jsonwebtoken.lang.Objects: Return the same value as Boolean.hashCode().
hashCode(double) - Static method in class io.jsonwebtoken.lang.Objects: Return the same value as Double.hashCode().
hashCode(float) - Static method in class io.jsonwebtoken.lang.Objects: Return the same value as Float.hashCode().
hashCode(long) - Static method in class io.jsonwebtoken.lang.Objects: Return the same value as Long.hashCode().
hasLength(String, String) - Static method in class io.jsonwebtoken.lang.Assert: Assert that the given String is not empty; that is, it must not be null and not the empty String.
hasLength(String) - Static method in class io.jsonwebtoken.lang.Assert: Assert that the given String is not empty; that is, it must not be null and not the empty String.
hasLength(CharSequence) - Static method in class io.jsonwebtoken.lang.Strings: Check that the given CharSequence is neither null nor of length 0.
hasLength(String) - Static method in class io.jsonwebtoken.lang.Strings: Check that the given String is neither null nor of length 0.
hasText(T, String) - Static method in class io.jsonwebtoken.lang.Assert: Assert that the given String has valid text content; that is, it must not be null and must contain at least one non-whitespace character.
hasText(String) - Static method in class io.jsonwebtoken.lang.Assert: Assert that the given String has valid text content; that is, it must not be null and must contain at least one non-whitespace character.
hasText(CharSequence) - Static method in class io.jsonwebtoken.lang.Strings: Check whether the given CharSequence has actual text.
hasText(String) - Static method in class io.jsonwebtoken.lang.Strings: Check whether the given String has actual text.
hasUniqueObject(Collection) - Static method in class io.jsonwebtoken.lang.Collections: Determine whether the given Collection only contains a single unique object.
Header - Interface in io.jsonwebtoken: A JWT JOSE header.
header() - Method in interface io.jsonwebtoken.JwtBuilder: Returns the Header to use to modify the constructed JWT's header name/value pairs as desired.
header() - Static method in class io.jsonwebtoken.Jwts: Returns a new Jwts.HeaderBuilder that can build any type of Header instance depending on which builder properties are set.
HeaderMutator<T extends HeaderMutator<T>> - Interface in io.jsonwebtoken: Mutation (modifications) to a Header instance.
hmacShaKeyFor(byte[]) - Static method in class io.jsonwebtoken.security.Keys: Creates a new SecretKey instance for use with HMAC-SHA algorithms based on the specified key byte array.
HS256 - Static variable in class io.jsonwebtoken.Jwts.SIG: HMAC using SHA-256 message authentication algorithm as defined by RFC 7518, Section 3.2.
HS384 - Static variable in class io.jsonwebtoken.Jwts.SIG: HMAC using SHA-384 message authentication algorithm as defined by RFC 7518, Section 3.2.
HS512 - Static variable in class io.jsonwebtoken.Jwts.SIG: HMAC using SHA-512 message authentication algorithm as defined by RFC 7518, Section 3.2.

I

ID - Static variable in interface io.jsonwebtoken.Claims: JWT JWT ID claims parameter name: "jti"
id(String) - Method in interface io.jsonwebtoken.ClaimsMutator: Sets the JWT jti (JWT ID) claim.
id(String) - Method in interface io.jsonwebtoken.JwtBuilder: Sets the JWT Claims jti (JWT ID) claim.
id(String) - Method in interface io.jsonwebtoken.security.JwkBuilder: Sets the JWK kid (Key ID) Parameter.
id(String) - Method in interface io.jsonwebtoken.security.KeyOperationBuilder: Sets the CaSe-SeNsItIvE id expected to be unique compared to all other KeyOperations.
Identifiable - Interface in io.jsonwebtoken: An object that may be uniquely identified by an id relative to other instances of the same type.
identityToString(Object) - Static method in class io.jsonwebtoken.lang.Objects: Return a String representation of an object's overall identity.
idFromThumbprint() - Method in interface io.jsonwebtoken.security.JwkBuilder: Sets the JWK's kid value to be the Base64URL-encoding of its SHA-256 thumbprint.
idFromThumbprint(HashAlgorithm) - Method in interface io.jsonwebtoken.security.JwkBuilder: Sets the JWK's kid value to be the Base64URL-encoding of its thumbprint using the specified HashAlgorithm.
ignoreUnsupported(boolean) - Method in interface io.jsonwebtoken.security.JwkSetParserBuilder: Sets whether the parser should ignore any encountered JWK it does not support, either because the JWK has an unrecognized key type or the JWK was malformed (missing required parameters, etc).
immutable(Map<K, V>) - Static method in class io.jsonwebtoken.lang.Collections: Shorter null-safe convenience alias for Collections.unmodifiableList(List) so both classes don't need to be imported.
immutable(Set<T>) - Static method in class io.jsonwebtoken.lang.Collections: Shorter null-safe convenience alias for Collections.unmodifiableSet(Set) so both classes don't need to be imported.
immutable(List<T>) - Static method in class io.jsonwebtoken.lang.Collections: Shorter null-safe convenience alias for Collections.unmodifiableList(List) so both classes don't need to be imported.
immutable(C) - Static method in class io.jsonwebtoken.lang.Collections: Null-safe factory method that returns an immutable/unmodifiable view of the specified collection instance.
INCORRECT_EXPECTED_CLAIM_MESSAGE_TEMPLATE - Static variable in exception io.jsonwebtoken.ClaimJwtException: Deprecated.
will be removed in a future release.
IncorrectClaimException - Exception in io.jsonwebtoken: Exception thrown when discovering that a required claim does not equal the required value, indicating the JWT is invalid and may not be used.
IncorrectClaimException(Header, Claims, String, Object, String) - Constructor for exception io.jsonwebtoken.IncorrectClaimException: Creates a new instance with the specified header, claims and explanation message.
IncorrectClaimException(Header, Claims, String, Object, String, Throwable) - Constructor for exception io.jsonwebtoken.IncorrectClaimException: Creates a new instance with the specified header, claims, explanation message and underlying cause.
instantiate(Constructor<T>, Object...) - Static method in class io.jsonwebtoken.lang.Classes: Creates a new object using the specified Constructor, invoking it with the specified constructor args arguments.
InstantiationException - Exception in io.jsonwebtoken.lang: RuntimeException equivalent of InstantiationException.
InstantiationException(String, Throwable) - Constructor for exception io.jsonwebtoken.lang.InstantiationException: Creates a new instance with the specified explanation message and underlying cause.
InvalidClaimException - Exception in io.jsonwebtoken: Exception indicating a parsed claim is invalid in some way.
InvalidClaimException(Header, Claims, String, Object, String) - Constructor for exception io.jsonwebtoken.InvalidClaimException: Creates a new instance with the specified header, claims and explanation message.
InvalidClaimException(Header, Claims, String, Object, String, Throwable) - Constructor for exception io.jsonwebtoken.InvalidClaimException: Creates a new instance with the specified header, claims, explanation message and underlying cause.
InvalidKeyException - Exception in io.jsonwebtoken.security: A KeyException thrown when encountering a key that is not suitable for the required functionality, or when attempting to use a Key in an incorrect or prohibited manner.
InvalidKeyException(String) - Constructor for exception io.jsonwebtoken.security.InvalidKeyException: Creates a new instance with the specified explanation message.
InvalidKeyException(String, Throwable) - Constructor for exception io.jsonwebtoken.security.InvalidKeyException: Creates a new instance with the specified explanation message and underlying cause.
invokeStatic(String, String, Class<?>[], Object...) - Static method in class io.jsonwebtoken.lang.Classes: Invokes the fully qualified class name's method named methodName with parameters of type argTypes using the args as the method arguments.
invokeStatic(Class<?>, String, Class<?>[], Object...) - Static method in class io.jsonwebtoken.lang.Classes: Invokes the clazz's matching static method (named methodName with exact argument types of argTypes) with the given args arguments, and returns the method return value.
io.jsonwebtoken - package io.jsonwebtoken
io.jsonwebtoken.io - package io.jsonwebtoken.io
io.jsonwebtoken.lang - package io.jsonwebtoken.lang
io.jsonwebtoken.security - package io.jsonwebtoken.security
IOException - Exception in io.jsonwebtoken.io: JJWT's base exception for problems during data input or output operations, such as serialization, deserialization, marshalling, unmarshalling, etc.
IOException(String) - Constructor for exception io.jsonwebtoken.io.IOException: Creates a new instance with the specified explanation message.
IOException(String, Throwable) - Constructor for exception io.jsonwebtoken.io.IOException: Creates a new instance with the specified explanation message and underlying cause.
isArray(Object) - Static method in class io.jsonwebtoken.lang.Objects: Returns true if the specified argument is an Object or primitive array, false otherwise.
isAssignable(Class, Class) - Static method in class io.jsonwebtoken.lang.Assert: Assert that superType.isAssignableFrom(subType) is true.
isAssignable(Class, Class, String) - Static method in class io.jsonwebtoken.lang.Assert: Assert that superType.isAssignableFrom(subType) is true.
isAvailable(String) - Static method in class io.jsonwebtoken.lang.Classes: Returns true if the specified fullyQualifiedClassName can be found in any of the thread context, class, or system classloaders, or false otherwise.
isCheckedException(Throwable) - Static method in class io.jsonwebtoken.lang.Objects: Return whether the given throwable is a checked exception: that is, neither a RuntimeException nor an Error.
isCompatibleWithThrowsClause(Throwable, Class[]) - Static method in class io.jsonwebtoken.lang.Objects: Check whether the given exception is compatible with the exceptions declared in a throws clause.
isEllipticCurve() - Method in enum io.jsonwebtoken.SignatureAlgorithm: Deprecated.

Returns true if the enum instance represents an Elliptic Curve ECDSA signature algorithm, false otherwise.
isEmpty(Collection<?>) - Static method in class io.jsonwebtoken.lang.Collections: Return true if the supplied Collection is null or empty.
isEmpty(Map<?, ?>) - Static method in class io.jsonwebtoken.lang.Collections: Return true if the supplied Map is null or empty.
isEmpty(Object) - Static method in class io.jsonwebtoken.lang.Objects: Returns true if the specified argument: is null, or is a CharSequence and Strings.hasText(CharSequence) is false, or is a Collection or Map with zero size, or is an empty array
isEmpty(Object[]) - Static method in class io.jsonwebtoken.lang.Objects: true if the specified array is null or zero length, false if populated.
isEmpty(byte[]) - Static method in class io.jsonwebtoken.lang.Objects: Returns true if the specified byte array is null or of zero length, false if populated.
isEmpty(char[]) - Static method in class io.jsonwebtoken.lang.Objects: Returns true if the specified character array is null or of zero length, false otherwise.
isHmac() - Method in enum io.jsonwebtoken.SignatureAlgorithm: Deprecated.

Returns true if the enum instance represents an HMAC signature algorithm, false otherwise.
isInstanceOf(Class<T>, Object) - Static method in class io.jsonwebtoken.lang.Assert: Assert that the provided object is an instance of the provided class.
isInstanceOf(Class<T>, Object, String) - Static method in class io.jsonwebtoken.lang.Assert: Assert that the provided object is an instance of the provided class.
isJdkStandard() - Method in enum io.jsonwebtoken.SignatureAlgorithm: Deprecated.

Returns true if the algorithm is supported by standard JDK distributions or false if the algorithm implementation is not in the JDK and must be provided by a separate runtime JCA Provider (like BouncyCastle for example).
isNull(Object, String) - Static method in class io.jsonwebtoken.lang.Assert: Assert that an object is null .
isNull(Object) - Static method in class io.jsonwebtoken.lang.Assert: Assert that an object is null .
isPayloadEncoded() - Method in interface io.jsonwebtoken.JwsHeader: Returns true if the payload is Base64Url-encoded per standard JWS rules, or false if the RFC 7797: JSON Web Signature (JWS) Unencoded Payload Option has been specified.
isRelated(KeyOperation) - Method in interface io.jsonwebtoken.security.KeyOperation: Returns true if the specified operation is an acceptable use case for the key already assigned this operation, false otherwise.
isRsa() - Method in enum io.jsonwebtoken.SignatureAlgorithm: Deprecated.

Returns true if the enum instance represents an RSA public/private key pair signature algorithm, false otherwise.
isSigned(CharSequence) - Method in interface io.jsonwebtoken.JwtParser: Returns true if the specified JWT compact string represents a signed JWT (aka a 'JWS'), false otherwise.
ISSUED_AT - Static variable in interface io.jsonwebtoken.Claims: JWT Issued At claims parameter name: "iat"
issuedAt(Date) - Method in interface io.jsonwebtoken.ClaimsMutator: Sets the JWT iat (issued at) timestamp claim.
issuedAt(Date) - Method in interface io.jsonwebtoken.JwtBuilder: Sets the JWT Claims iat (issued at) claim.
ISSUER - Static variable in interface io.jsonwebtoken.Claims: JWT Issuer claims parameter name: "iss"
issuer(String) - Method in interface io.jsonwebtoken.ClaimsMutator: Sets the JWT iss (issuer) claim.
issuer(String) - Method in interface io.jsonwebtoken.JwtBuilder: Sets the JWT Claims iss (issuer) claim.
isTrue(boolean, String) - Static method in class io.jsonwebtoken.lang.Assert: Assert a boolean expression, throwing IllegalArgumentException if the test result is false.
isTrue(boolean) - Static method in class io.jsonwebtoken.lang.Assert: Assert a boolean expression, throwing IllegalArgumentException if the test result is false.
IvSupplier - Interface in io.jsonwebtoken.security: An IvSupplier provides access to the secure-random Initialization Vector used during encryption, which must in turn be presented for use during decryption.

J

json(Deserializer<Map<String, ?>>) - Method in interface io.jsonwebtoken.io.ParserBuilder: Uses the specified Deserializer to convert JSON Strings (UTF-8 byte streams) into Java Map objects.
json(Serializer<Map<String, ?>>) - Method in interface io.jsonwebtoken.JwtBuilder: Perform Map-to-JSON serialization with the specified Serializer.
json(Deserializer<Map<String, ?>>) - Method in interface io.jsonwebtoken.JwtParserBuilder: Uses the specified JSON Deserializer to deserialize JSON (UTF-8 byte streams) into Java Map objects.
json(PublicJwk<?>) - Static method in class io.jsonwebtoken.security.Jwks: Converts the specified PublicJwk into JSON.
JSON_WEB_KEY - Static variable in interface io.jsonwebtoken.JwsHeader: Deprecated.
since 0.12.0 in favor of ProtectedHeader.getJwk()
Jwe<B> - Interface in io.jsonwebtoken: An encrypted JWT, called a "JWE", per the JWE (RFC 7516) Specification.
JweHeader - Interface in io.jsonwebtoken: A JWE header.
JweHeaderMutator<T extends JweHeaderMutator<T>> - Interface in io.jsonwebtoken: Mutation (modifications) to a JweHeader instance.
jwk(PublicJwk<?>) - Method in interface io.jsonwebtoken.ProtectedHeaderMutator: Sets the jwk (JSON Web Key) associated with the JWT.
Jwk<K extends Key> - Interface in io.jsonwebtoken.security: A JWK is an immutable set of name/value pairs that represent a cryptographic key as defined by RFC 7517: JSON Web Key (JWK).
JWK_SET_URL - Static variable in interface io.jsonwebtoken.JwsHeader: Deprecated.
since 0.12.0 in favor of ProtectedHeader.getJwkSetUrl()
JwkBuilder<K extends Key,J extends Jwk<K>,T extends JwkBuilder<K,J,T>> - Interface in io.jsonwebtoken.security: A SecurityBuilder that produces a JWK.
JwkParserBuilder - Interface in io.jsonwebtoken.security: A builder to construct a Parser that can parse Jwks.
Jwks - Class in io.jsonwebtoken.security: Utility methods for creating JWKs (JSON Web Keys) with a type-safe builder.
Jwks.CRV - Class in io.jsonwebtoken.security: Constants for all standard JWK crv (Curve) parameter values defined in the JSON Web Key Elliptic Curve Registry (including its Edwards Elliptic Curve additions).
Jwks.HASH - Class in io.jsonwebtoken.security: Various (but not all) IANA Hash Algorithms commonly used to compute JWK Thumbprints and ensure valid JWK Thumbprint URIs.
Jwks.OP - Class in io.jsonwebtoken.security: Constants for all standard JWK key_ops (Key Operations) parameter values defined in the JSON Web Key Operations Registry.
JwkSet - Interface in io.jsonwebtoken.security: A JWK Set is an immutable JSON Object that represents a Set of Jwks as defined by RFC 7517 JWK Set Format.
JwkSetBuilder - Interface in io.jsonwebtoken.security: A builder that produces JwkSets containing Jwks.
JwkSetParserBuilder - Interface in io.jsonwebtoken.security: A builder to construct a Parser that can parse JwkSets.
jwkSetUrl(URI) - Method in interface io.jsonwebtoken.ProtectedHeaderMutator: Sets the jku (JWK Set URL) value that refers to a JWK Set resource containing JSON-encoded Public Keys, or null if not present.
JwkThumbprint - Interface in io.jsonwebtoken.security: A canonical cryptographic digest of a JWK as defined by the JSON Web Key (JWK) Thumbprint specification.
Jws<P> - Interface in io.jsonwebtoken: An expanded (not compact/serialized) Signed JSON Web Token.
JwsHeader - Interface in io.jsonwebtoken: A JWS header.
Jwt<H extends Header,P> - Interface in io.jsonwebtoken: An expanded (not compact/serialized) JSON Web Token.
JWT_TYPE - Static variable in interface io.jsonwebtoken.Header: Deprecated.
since 0.12.0 - this constant is never used within the JJWT codebase.
JwtBuilder - Interface in io.jsonwebtoken: A builder for constructing Unprotected JWTs, Signed JWTs (aka 'JWS's) and Encrypted JWTs (aka 'JWE's).
JwtBuilder.BuilderClaims - Interface in io.jsonwebtoken: Claims for use with a JwtBuilder that supports method chaining for standard JWT Claims parameters.
JwtBuilder.BuilderHeader - Interface in io.jsonwebtoken: Header for use with a JwtBuilder that supports method chaining for standard JWT, JWS and JWE header parameters.
JwtException - Exception in io.jsonwebtoken: Base class for JWT-related runtime exceptions.
JwtException(String) - Constructor for exception io.jsonwebtoken.JwtException: Creates a new instance with the specified explanation message.
JwtException(String, Throwable) - Constructor for exception io.jsonwebtoken.JwtException: Creates a new instance with the specified explanation message and underlying cause.
JwtHandler<T> - Interface in io.jsonwebtoken: Deprecated.
since 0.12.0 in favor of calling Jwt.accept(JwtVisitor).
JwtHandlerAdapter<T> - Class in io.jsonwebtoken: An Adapter implementation of the JwtHandler interface that allows for anonymous subclasses to process only the JWT results that are known/expected for a particular use case.
JwtHandlerAdapter() - Constructor for class io.jsonwebtoken.JwtHandlerAdapter: Default constructor, does not initialize any internal state.
JwtParser - Interface in io.jsonwebtoken: A parser for reading JWT strings, used to convert them into a Jwt object representing the expanded JWT.
JwtParserBuilder - Interface in io.jsonwebtoken: A builder to construct a JwtParser.
Jwts - Class in io.jsonwebtoken: Factory class useful for creating instances of JWT interfaces.
Jwts.ENC - Class in io.jsonwebtoken: Constants for all standard JWA Cryptographic Algorithms for Content Encryption defined in the JSON Web Signature and Encryption Algorithms Registry.
Jwts.HeaderBuilder - Interface in io.jsonwebtoken: A Builder that dynamically determines the type of Header to create based on builder state.
Jwts.KEY - Class in io.jsonwebtoken: Constants for all standard JWA (RFC 7518) Cryptographic Algorithms for Key Management.
Jwts.SIG - Class in io.jsonwebtoken: Constants for all JWA (RFC 7518) standard Cryptographic Algorithms for Digital Signatures and MACs defined in the JSON Web Signature and Encryption Algorithms Registry.
Jwts.ZIP - Class in io.jsonwebtoken: Constants for JWA (RFC 7518) compression algorithms referenced in the zip header defined in the JSON Web Encryption Compression Algorithms Registry.
JwtVisitor<T> - Interface in io.jsonwebtoken: A JwtVisitor supports the Visitor design pattern for Jwt instances.

K

key() - Method in interface io.jsonwebtoken.JwtParserBuilder: Configures the parser's supported KeyAlgorithms used to obtain a JWE's decryption key.
key(SecretKey) - Method in interface io.jsonwebtoken.security.DynamicJwkBuilder: Ensures the builder will create a SecretJwk for the specified Java SecretKey.
key(RSAPublicKey) - Method in interface io.jsonwebtoken.security.DynamicJwkBuilder: Ensures the builder will create an RsaPublicJwk for the specified Java RSAPublicKey.
key(RSAPrivateKey) - Method in interface io.jsonwebtoken.security.DynamicJwkBuilder: Ensures the builder will create an RsaPrivateJwk for the specified Java RSAPrivateKey.
key(ECPublicKey) - Method in interface io.jsonwebtoken.security.DynamicJwkBuilder: Ensures the builder will create an EcPublicJwk for the specified Java ECPublicKey.
key(ECPrivateKey) - Method in interface io.jsonwebtoken.security.DynamicJwkBuilder: Ensures the builder will create an EcPrivateJwk for the specified Java ECPrivateKey.
key(A) - Method in interface io.jsonwebtoken.security.DynamicJwkBuilder: Ensures the builder will create a PublicJwk for the specified Java PublicKey argument.
key(B) - Method in interface io.jsonwebtoken.security.DynamicJwkBuilder: Ensures the builder will create a PrivateJwk for the specified Java PrivateKey argument.
key() - Method in interface io.jsonwebtoken.security.KeyBuilderSupplier: Returns a new KeyBuilder instance that will produce new secure-random keys with a length sufficient to be used by the component's associated cryptographic algorithm.
KEY_ID - Static variable in interface io.jsonwebtoken.JwsHeader: Deprecated.
since 0.12.0 in favor of ProtectedHeader.getKeyId()
KeyAlgorithm<E extends Key,D extends Key> - Interface in io.jsonwebtoken.security: A KeyAlgorithm produces the SecretKey used to encrypt or decrypt a JWE.
KeyBuilder<K extends Key,B extends KeyBuilder<K,B>> - Interface in io.jsonwebtoken.security: A KeyBuilder produces new Keys suitable for use with an associated cryptographic algorithm.
KeyBuilderSupplier<K extends Key,B extends KeyBuilder<K,B>> - Interface in io.jsonwebtoken.security: Interface implemented by components that support building/creating new Keys suitable for use with their associated cryptographic algorithm implementation.
KeyException - Exception in io.jsonwebtoken.security: General-purpose exception when encountering a problem with a cryptographic Key or Jwk.
KeyException(String) - Constructor for exception io.jsonwebtoken.security.KeyException: Creates a new instance with the specified explanation message.
KeyException(String, Throwable) - Constructor for exception io.jsonwebtoken.security.KeyException: Creates a new instance with the specified explanation message and underlying cause.
keyId(String) - Method in interface io.jsonwebtoken.ProtectedHeaderMutator: Sets the JWT case-sensitive kid (Key ID) header value.
KeyLengthSupplier - Interface in io.jsonwebtoken.security: Provides access to the required length in bits (not bytes) of keys usable with the associated algorithm.
keyLocator(Locator<Key>) - Method in interface io.jsonwebtoken.JwtParserBuilder: Sets the Locator used to acquire any signature verification or decryption key needed during parsing.
KeyOperation - Interface in io.jsonwebtoken.security: A KeyOperation identifies a behavior for which a key may be used.
KeyOperationBuilder - Interface in io.jsonwebtoken.security: A KeyOperationBuilder produces KeyOperation instances that may be added to a JWK's key operations parameter.
KeyOperationPolicied<T extends KeyOperationPolicied<T>> - Interface in io.jsonwebtoken.security: A marker interface that indicates the implementing instance supports the ability to configure a KeyOperationPolicy used to validate JWK instances.
KeyOperationPolicy - Interface in io.jsonwebtoken.security: A key operation policy determines which KeyOperations may be assigned to a JWK.
KeyOperationPolicyBuilder - Interface in io.jsonwebtoken.security: A KeyOperationPolicyBuilder produces a KeyOperationPolicy that determines which KeyOperations may be assigned to a JWK.
keyPair(KeyPair) - Method in interface io.jsonwebtoken.security.DynamicJwkBuilder: Ensures the builder will create a PrivateJwk for the specified Java KeyPair argument.
KeyPair<A extends PublicKey,B extends PrivateKey> - Interface in io.jsonwebtoken.security: Generics-capable and type-safe alternative to KeyPair.
keyPair() - Method in interface io.jsonwebtoken.security.KeyPairBuilderSupplier: Returns a new KeyPairBuilder that will create new secure-random KeyPairs with a length and parameters sufficient for use with the component's associated cryptographic algorithm.
KeyPairBuilder - Interface in io.jsonwebtoken.security: A KeyPairBuilder produces new KeyPairs suitable for use with an associated cryptographic algorithm.
KeyPairBuilderSupplier - Interface in io.jsonwebtoken.security: Interface implemented by components that support building/creating new KeyPairs suitable for use with their associated cryptographic algorithm implementation.
keyPairFor(SignatureAlgorithm) - Static method in class io.jsonwebtoken.security.Keys: Deprecated.
since 0.12.0 in favor of your preferred SignatureAlgorithm instance's keyPair() builder method directly.
KeyRequest<T> - Interface in io.jsonwebtoken.security: A request to a KeyAlgorithm to obtain the key necessary for AEAD encryption or decryption.
KeyResult - Interface in io.jsonwebtoken.security: The result of a KeyAlgorithm encryption key request, containing the resulting JWE encrypted key and JWE Content Encryption Key (CEK), concepts defined in JWE Terminology.
keys(Collection<Jwk<?>>) - Method in interface io.jsonwebtoken.security.JwkSetBuilder: Sets the JwkSet keys parameter value; per standard Java setter idioms, this is a full replacement operation, removing any previous keys from the set.
Keys - Class in io.jsonwebtoken.security: Utility class for securely generating SecretKeys and KeyPairs.
KeySupplier<K extends Key> - Interface in io.jsonwebtoken.security: Provides access to a cryptographic Key necessary for signing, wrapping, encryption or decryption algorithms.

L

length(T[]) - Static method in class io.jsonwebtoken.lang.Arrays: Returns the length of the array, or 0 if the array is null.
length(byte[]) - Static method in class io.jsonwebtoken.lang.Arrays: Returns the length of the specified byte array, or 0 if the byte array is null.
locate(Header) - Method in interface io.jsonwebtoken.Locator: Returns an object referenced in the specified header, or null if the object couldn't be found.
locate(Header) - Method in class io.jsonwebtoken.LocatorAdapter: Inspects the specified header, and delegates to the LocatorAdapter.locate(ProtectedHeader) method if the header is protected (either a JwsHeader or JweHeader), or the LocatorAdapter.doLocate(Header) method if the header is not integrity protected.
locate(ProtectedHeader) - Method in class io.jsonwebtoken.LocatorAdapter: Returns an object referenced in the specified ProtectedHeader, or null if the referenced object cannot be found or does not exist.
locate(JweHeader) - Method in class io.jsonwebtoken.LocatorAdapter: Returns an object referenced in the specified JWE header, or null if the referenced object cannot be found or does not exist.
locate(JwsHeader) - Method in class io.jsonwebtoken.LocatorAdapter: Returns an object referenced in the specified JWS header, or null if the referenced object cannot be found or does not exist.
Locator<T> - Interface in io.jsonwebtoken: A Locator can return an object referenced in a JWT Header that is necessary to process the associated JWT.
LocatorAdapter<T> - Class in io.jsonwebtoken: Adapter pattern implementation for the Locator interface.
LocatorAdapter() - Constructor for class io.jsonwebtoken.LocatorAdapter: Constructs a new instance, where all default method implementations return null.
lte(T, T, String) - Static method in class io.jsonwebtoken.lang.Assert: Asserts that a specified value is less than or equal to the given requirement, throwing an IllegalArgumentException with the given message if not.

M

MacAlgorithm - Interface in io.jsonwebtoken.security: A SecureDigestAlgorithm that uses symmetric SecretKeys to both compute and verify digests as message authentication codes (MACs).
MalformedJwtException - Exception in io.jsonwebtoken: Exception indicating that a JWT was not correctly constructed and should be rejected.
MalformedJwtException(String) - Constructor for exception io.jsonwebtoken.MalformedJwtException: Creates a new instance with the specified explanation message.
MalformedJwtException(String, Throwable) - Constructor for exception io.jsonwebtoken.MalformedJwtException: Creates a new instance with the specified explanation message and underlying cause.
MalformedKeyException - Exception in io.jsonwebtoken.security: Exception thrown when encountering a key or key material that is incomplete or improperly configured or formatted and cannot be used as expected.
MalformedKeyException(String) - Constructor for exception io.jsonwebtoken.security.MalformedKeyException: Creates a new instance with the specified explanation message.
MalformedKeyException(String, Throwable) - Constructor for exception io.jsonwebtoken.security.MalformedKeyException: Creates a new instance with the specified explanation message and underlying cause.
MalformedKeySetException - Exception in io.jsonwebtoken.security: Exception thrown when encountering a JwkSet that is incomplete or improperly configured or formatted and cannot be used as expected.
MalformedKeySetException(String) - Constructor for exception io.jsonwebtoken.security.MalformedKeySetException: Creates a new instance with the specified explanation message.
MalformedKeySetException(String, Throwable) - Constructor for exception io.jsonwebtoken.security.MalformedKeySetException: Creates a new instance with the specified explanation message and underlying cause.
MapMutator<K,V,T extends MapMutator<K,V,T>> - Interface in io.jsonwebtoken.lang: Mutation (modifications) to a Map instance while also supporting method chaining.
Maps - Class in io.jsonwebtoken.lang: Utility class to help with the manipulation of working with Maps.
Maps.MapBuilder<K,V> - Interface in io.jsonwebtoken.lang: Utility Builder class for fluently building maps:
mergeArrayIntoCollection(Object, Collection) - Static method in class io.jsonwebtoken.lang.Collections: Merge the given array into the given Collection.
mergePropertiesIntoMap(Properties, Map) - Static method in class io.jsonwebtoken.lang.Collections: Merge the given Properties instance into the given Map, copying all properties (key-value pairs) over.
mergeStringArrays(String[], String[]) - Static method in class io.jsonwebtoken.lang.Strings: Merge the given String arrays into one, with overlapping array elements only included once.
Message<T> - Interface in io.jsonwebtoken.security: A message contains a payload used as input to or output from a cryptographic algorithm.
MISSING_EXPECTED_CLAIM_MESSAGE_TEMPLATE - Static variable in exception io.jsonwebtoken.ClaimJwtException: Deprecated.
will be removed in a future release.
MissingClaimException - Exception in io.jsonwebtoken: Exception thrown when discovering that a required claim is not present, indicating the JWT is invalid and may not be used.
MissingClaimException(Header, Claims, String, Object, String) - Constructor for exception io.jsonwebtoken.MissingClaimException: Creates a new instance with the specified explanation message.
MissingClaimException(Header, Claims, String, Object, String, Throwable) - Constructor for exception io.jsonwebtoken.MissingClaimException: Deprecated.
since 0.12.0 since it is not used in JJWT's codebase

N

nespace(StringBuilder) - Static method in class io.jsonwebtoken.lang.Strings: Appends a space character (' ') if the argument is not empty, otherwise does nothing.
NestedCollection<E,P> - Interface in io.jsonwebtoken.lang: A CollectionMutator that can return access to its parent via the and() method for continued configuration.
newInstance(String) - Static method in class io.jsonwebtoken.lang.Classes: Creates and returns a new instance of the class with the specified fully qualified class name using the classes default no-argument constructor.
newInstance(String, Class<?>[], Object...) - Static method in class io.jsonwebtoken.lang.Classes: Creates and returns a new instance of the specified fully qualified class name using the specified args arguments provided to the constructor with ctorArgTypes
newInstance(String, Object...) - Static method in class io.jsonwebtoken.lang.Classes: Creates and returns a new instance of the specified fully qualified class name using a constructor that matches the specified args arguments.
newInstance(Class<T>) - Static method in class io.jsonwebtoken.lang.Classes: Creates a new instance of the specified clazz via clazz.newInstance().
newInstance(Class<T>, Object...) - Static method in class io.jsonwebtoken.lang.Classes: Returns a new instance of the specified clazz, invoking the associated constructor with the specified args arguments.
NONE - Static variable in class io.jsonwebtoken.Jwts.SIG: The "none" signature algorithm as defined by RFC 7518, Section 3.6.
noNullElements(Object[], String) - Static method in class io.jsonwebtoken.lang.Assert: Assert that an array has no null elements.
noNullElements(Object[]) - Static method in class io.jsonwebtoken.lang.Assert: Assert that an array has no null elements.
NOT_BEFORE - Static variable in interface io.jsonwebtoken.Claims: JWT Not Before claims parameter name: "nbf"
notBefore(Date) - Method in interface io.jsonwebtoken.ClaimsMutator: Sets the JWT nbf (not before) timestamp claim.
notBefore(Date) - Method in interface io.jsonwebtoken.JwtBuilder: Sets the JWT Claims nbf (not before) claim.
notEmpty(Object[], String) - Static method in class io.jsonwebtoken.lang.Assert: Assert that an array has elements; that is, it must not be null and must have at least one element.
notEmpty(Object[]) - Static method in class io.jsonwebtoken.lang.Assert: Assert that an array has elements; that is, it must not be null and must have at least one element.
notEmpty(byte[], String) - Static method in class io.jsonwebtoken.lang.Assert: Assert that the specified byte array is not null and has at least one byte element.
notEmpty(char[], String) - Static method in class io.jsonwebtoken.lang.Assert: Assert that the specified character array is not null and has at least one byte element.
notEmpty(T, String) - Static method in class io.jsonwebtoken.lang.Assert: Assert that a collection has elements; that is, it must not be null and must have at least one element.
notEmpty(Collection<?>) - Static method in class io.jsonwebtoken.lang.Assert: Assert that a collection has elements; that is, it must not be null and must have at least one element.
notEmpty(T, String) - Static method in class io.jsonwebtoken.lang.Assert: Assert that a Map has entries; that is, it must not be null and must have at least one entry.
notEmpty(Map) - Static method in class io.jsonwebtoken.lang.Assert: Assert that a Map has entries; that is, it must not be null and must have at least one entry.
notNull(T, String) - Static method in class io.jsonwebtoken.lang.Assert: Assert that an object is not null .
notNull(Object) - Static method in class io.jsonwebtoken.lang.Assert: Assert that an object is not null .
now() - Method in interface io.jsonwebtoken.Clock: Returns the clock's current timestamp at the instant the method is invoked.
nullSafe(Set<T>) - Static method in class io.jsonwebtoken.lang.Collections: Returns a non-null set, either s if it is not null, or Collections.emptySet() otherwise.
nullSafe(Collection<T>) - Static method in class io.jsonwebtoken.lang.Collections: Returns a non-null collection, either c if it is not null, or Collections.emptyList() otherwise.
nullSafeClassName(Object) - Static method in class io.jsonwebtoken.lang.Objects: Determine the class name for the given object.
nullSafeClose(Closeable...) - Static method in class io.jsonwebtoken.lang.Objects: Iterate over the specified Closeable instances, invoking Closeable.close() on each one, ignoring any potential IOExceptions.
nullSafeEquals(Object, Object) - Static method in class io.jsonwebtoken.lang.Objects: Determine if the given objects are equal, returning true if both are null or false if only one is null.
nullSafeFlush(Flushable...) - Static method in class io.jsonwebtoken.lang.Objects: Iterate over the specified Flushable instances, invoking Flushable.flush() on each one, ignoring any potential IOExceptions.
nullSafeHashCode(Object) - Static method in class io.jsonwebtoken.lang.Objects: Return as hash code for the given object; typically the value of Object.hashCode().
nullSafeHashCode(Object...) - Static method in class io.jsonwebtoken.lang.Objects: Return a hash code based on the contents of the specified array.
nullSafeHashCode(boolean[]) - Static method in class io.jsonwebtoken.lang.Objects: Return a hash code based on the contents of the specified array.
nullSafeHashCode(byte[]) - Static method in class io.jsonwebtoken.lang.Objects: Return a hash code based on the contents of the specified array.
nullSafeHashCode(char[]) - Static method in class io.jsonwebtoken.lang.Objects: Return a hash code based on the contents of the specified array.
nullSafeHashCode(double[]) - Static method in class io.jsonwebtoken.lang.Objects: Return a hash code based on the contents of the specified array.
nullSafeHashCode(float[]) - Static method in class io.jsonwebtoken.lang.Objects: Return a hash code based on the contents of the specified array.
nullSafeHashCode(int[]) - Static method in class io.jsonwebtoken.lang.Objects: Return a hash code based on the contents of the specified array.
nullSafeHashCode(long[]) - Static method in class io.jsonwebtoken.lang.Objects: Return a hash code based on the contents of the specified array.
nullSafeHashCode(short[]) - Static method in class io.jsonwebtoken.lang.Objects: Return a hash code based on the contents of the specified array.
nullSafeToString(Object) - Static method in class io.jsonwebtoken.lang.Objects: Return a String representation of the specified Object.
nullSafeToString(Object[]) - Static method in class io.jsonwebtoken.lang.Objects: Return a String representation of the contents of the specified array.
nullSafeToString(boolean[]) - Static method in class io.jsonwebtoken.lang.Objects: Return a String representation of the contents of the specified array.
nullSafeToString(byte[]) - Static method in class io.jsonwebtoken.lang.Objects: Return a String representation of the contents of the specified array.
nullSafeToString(char[]) - Static method in class io.jsonwebtoken.lang.Objects: Return a String representation of the contents of the specified array.
nullSafeToString(double[]) - Static method in class io.jsonwebtoken.lang.Objects: Return a String representation of the contents of the specified array.
nullSafeToString(float[]) - Static method in class io.jsonwebtoken.lang.Objects: Return a String representation of the contents of the specified array.
nullSafeToString(int[]) - Static method in class io.jsonwebtoken.lang.Objects: Return a String representation of the contents of the specified array.
nullSafeToString(long[]) - Static method in class io.jsonwebtoken.lang.Objects: Return a String representation of the contents of the specified array.
nullSafeToString(short[]) - Static method in class io.jsonwebtoken.lang.Objects: Return a String representation of the contents of the specified array.

O

Objects - Class in io.jsonwebtoken.lang: Utility methods for working with object instances to reduce pattern repetition and otherwise increased cyclomatic complexity.
octetChain(List<X509Certificate>) - Method in interface io.jsonwebtoken.security.DynamicJwkBuilder: Ensures the builder will create an OctetPublicJwk for the specified Java X509Certificate chain.
octetKey(A) - Method in interface io.jsonwebtoken.security.DynamicJwkBuilder: Ensures the builder will create an OctetPublicJwk for the specified Edwards-curve PublicKey argument.
octetKey(A) - Method in interface io.jsonwebtoken.security.DynamicJwkBuilder: Ensures the builder will create an OctetPrivateJwk for the specified Edwards-curve PrivateKey argument.
octetKeyPair(KeyPair) - Method in interface io.jsonwebtoken.security.DynamicJwkBuilder: Ensures the builder will create an OctetPrivateJwk for the specified Java Edwards-curve KeyPair.
OctetPrivateJwk<K extends PrivateKey,L extends PublicKey> - Interface in io.jsonwebtoken.security: JWK representation of an Edwards Curve PrivateKey as defined by RFC 8037, Section 2: Key Type "OKP".
OctetPrivateJwkBuilder<K extends PrivateKey,L extends PublicKey> - Interface in io.jsonwebtoken.security: A PrivateJwkBuilder that creates OctetPrivateJwk instances.
OctetPublicJwk<K extends PublicKey> - Interface in io.jsonwebtoken.security: JWK representation of an Edwards Curve PublicKey as defined by RFC 8037, Section 2: Key Type "OKP".
OctetPublicJwkBuilder<A extends PublicKey,B extends PrivateKey> - Interface in io.jsonwebtoken.security: A PublicJwkBuilder that creates OctetPublicJwk instances.
of(T...) - Static method in class io.jsonwebtoken.lang.Collections: Returns a type-safe immutable List containing the specified array elements.
of(K, V) - Static method in class io.jsonwebtoken.lang.Maps: Creates a new map builder with a single entry.
onClaimsJwe(Jwe<Claims>) - Method in interface io.jsonwebtoken.JwtHandler: Deprecated.

This method is invoked when a JwtParser determines that the parsed JWT is a valid Claims JWE.
onClaimsJwe(Jwe<Claims>) - Method in class io.jsonwebtoken.JwtHandlerAdapter
onClaimsJws(Jws<Claims>) - Method in interface io.jsonwebtoken.JwtHandler: Deprecated.

This method is invoked when a JwtParser determines that the parsed JWT is a valid Claims JWS.
onClaimsJws(Jws<Claims>) - Method in class io.jsonwebtoken.JwtHandlerAdapter
onClaimsJwt(Jwt<Header, Claims>) - Method in interface io.jsonwebtoken.JwtHandler: Deprecated.

This method is invoked when a JwtParser determines that the parsed JWT is a Claims JWT.
onClaimsJwt(Jwt<Header, Claims>) - Method in class io.jsonwebtoken.JwtHandlerAdapter
onContentJwe(Jwe<byte[]>) - Method in interface io.jsonwebtoken.JwtHandler: Deprecated.

This method is invoked when a JwtParser determines that the parsed JWT is a content JWE.
onContentJwe(Jwe<byte[]>) - Method in class io.jsonwebtoken.JwtHandlerAdapter
onContentJws(Jws<byte[]>) - Method in interface io.jsonwebtoken.JwtHandler: Deprecated.

This method is invoked when a JwtParser determines that the parsed JWT is a content JWS.
onContentJws(Jws<byte[]>) - Method in class io.jsonwebtoken.JwtHandlerAdapter
onContentJwt(Jwt<Header, byte[]>) - Method in interface io.jsonwebtoken.JwtHandler: Deprecated.

This method is invoked when a JwtParser determines that the parsed JWT is an unsecured content JWT.
onContentJwt(Jwt<Header, byte[]>) - Method in class io.jsonwebtoken.JwtHandlerAdapter
onDecryptedClaims(Jwe<Claims>) - Method in class io.jsonwebtoken.JwtHandlerAdapter
onDecryptedClaims(Jwe<Claims>) - Method in class io.jsonwebtoken.SupportedJwtVisitor: Handles an encountered JWE message that has been authenticated and decrypted, and has a Claims payload.
onDecryptedContent(Jwe<byte[]>) - Method in class io.jsonwebtoken.JwtHandlerAdapter
onDecryptedContent(Jwe<byte[]>) - Method in class io.jsonwebtoken.SupportedJwtVisitor: Handles an encountered JWE message that has been authenticated and decrypted, and has byte[] array payload.
onUnsecuredClaims(Jwt<Header, Claims>) - Method in class io.jsonwebtoken.JwtHandlerAdapter
onUnsecuredClaims(Jwt<Header, Claims>) - Method in class io.jsonwebtoken.SupportedJwtVisitor: Handles an encountered unsecured Claims JWT - one that is not cryptographically signed nor encrypted, and has a Claims payload.
onUnsecuredContent(Jwt<Header, byte[]>) - Method in class io.jsonwebtoken.JwtHandlerAdapter
onUnsecuredContent(Jwt<Header, byte[]>) - Method in class io.jsonwebtoken.SupportedJwtVisitor: Handles an encountered unsecured content JWT - one that is not cryptographically signed nor encrypted, and has a byte[] array payload.
onVerifiedClaims(Jws<Claims>) - Method in class io.jsonwebtoken.JwtHandlerAdapter
onVerifiedClaims(Jws<Claims>) - Method in class io.jsonwebtoken.SupportedJwtVisitor: Handles an encountered JWS message that has been cryptographically verified/authenticated and has a Claims payload.
onVerifiedContent(Jws<byte[]>) - Method in class io.jsonwebtoken.JwtHandlerAdapter
onVerifiedContent(Jws<byte[]>) - Method in class io.jsonwebtoken.SupportedJwtVisitor: Handles an encountered JWS message that has been cryptographically verified/authenticated and has a byte[] array payload.
operationPolicy(KeyOperationPolicy) - Method in interface io.jsonwebtoken.security.KeyOperationPolicied: Sets the key operation policy that determines which KeyOperations may be assigned to a JWK.
operations() - Method in interface io.jsonwebtoken.security.JwkBuilder: Configures the key operations for which the key is intended to be used.

P

P256 - Static variable in class io.jsonwebtoken.security.Jwks.CRV: P-256 Elliptic Curve defined by RFC 7518, Section 6.2.1.1 using the native Java JCA secp256r1 algorithm.
P384 - Static variable in class io.jsonwebtoken.security.Jwks.CRV: P-384 Elliptic Curve defined by RFC 7518, Section 6.2.1.1 using the native Java JCA secp384r1 algorithm.
P521 - Static variable in class io.jsonwebtoken.security.Jwks.CRV: P-521 Elliptic Curve defined by RFC 7518, Section 6.2.1.1 using the native Java JCA secp521r1 algorithm.
parse(CharSequence) - Method in interface io.jsonwebtoken.io.Parser: Parse the specified character sequence into a Java object.
parse(CharSequence, int, int) - Method in interface io.jsonwebtoken.io.Parser: Parse the specified character sequence with the specified bounds into a Java object.
parse(Reader) - Method in interface io.jsonwebtoken.io.Parser: Parse the specified character sequence into a Java object.
parse(InputStream) - Method in interface io.jsonwebtoken.io.Parser: Parses the specified InputStream assuming UTF_8 encoding.
parse(CharSequence) - Method in interface io.jsonwebtoken.JwtParser: Parses the specified compact serialized JWT string based on the builder's current configuration state and returns the resulting JWT, JWS, or JWE instance.
parse(CharSequence, JwtHandler<T>) - Method in interface io.jsonwebtoken.JwtParser: Deprecated.
since 0.12.0 in favor of JwtParser.parse(CharSequence).accept(visitor);
parseClaimsJws(CharSequence) - Method in interface io.jsonwebtoken.JwtParser: Deprecated.
since 0.12.0 in favor of JwtParser.parseSignedClaims(CharSequence).
parseClaimsJwt(CharSequence) - Method in interface io.jsonwebtoken.JwtParser: Deprecated.
since 0.12.0 in favor of JwtParser.parseUnsecuredClaims(CharSequence).
parseContentJws(CharSequence) - Method in interface io.jsonwebtoken.JwtParser: Deprecated.
since 0.12.0 in favor of JwtParser.parseSignedContent(CharSequence).
parseContentJwt(CharSequence) - Method in interface io.jsonwebtoken.JwtParser: Deprecated.
since 0.12.0 in favor of JwtParser.parseUnsecuredContent(CharSequence).
parseEncryptedClaims(CharSequence) - Method in interface io.jsonwebtoken.JwtParser: Parses the jwe argument, expected to be an encrypted Claims JWE.
parseEncryptedContent(CharSequence) - Method in interface io.jsonwebtoken.JwtParser: Parses the jwe argument, expected to be an encrypted content JWE.
parseIso8601Date(String) - Static method in class io.jsonwebtoken.lang.DateFormats: Parse the specified ISO-8601-formatted date string and return the corresponding Date instance.
parseLocaleString(String) - Static method in class io.jsonwebtoken.lang.Strings: Parse the given localeString value into a Locale.
Parser<T> - Interface in io.jsonwebtoken.io: A Parser converts a character stream into a Java object.
parser() - Static method in class io.jsonwebtoken.Jwts: Returns a new JwtParserBuilder instance that can be configured to create an immutable/thread-safe JwtParser.
parser() - Static method in class io.jsonwebtoken.security.Jwks: Returns a new builder used to create Parsers that parse JSON into Jwk instances.
ParserBuilder<T,B extends ParserBuilder<T,B>> - Interface in io.jsonwebtoken.io: A ParserBuilder configures and creates new Parser instances.
parseSignedClaims(CharSequence) - Method in interface io.jsonwebtoken.JwtParser: Parses the jws argument, expected to be a cryptographically-signed Claims JWS.
parseSignedClaims(CharSequence, byte[]) - Method in interface io.jsonwebtoken.JwtParser: Parses a JWS known to use the RFC 7797: JSON Web Signature (JWS) Unencoded Payload Option, using the specified unencodedPayload for signature verification.
parseSignedClaims(CharSequence, InputStream) - Method in interface io.jsonwebtoken.JwtParser: Parses a JWS known to use the RFC 7797: JSON Web Signature (JWS) Unencoded Payload Option, using the bytes from the specified unencodedPayload stream for signature verification and Claims creation.
parseSignedContent(CharSequence) - Method in interface io.jsonwebtoken.JwtParser: Parses the jws argument, expected to be a cryptographically-signed content JWS.
parseSignedContent(CharSequence, byte[]) - Method in interface io.jsonwebtoken.JwtParser: Parses a JWS known to use the RFC 7797: JSON Web Signature (JWS) Unencoded Payload Option, using the specified unencodedPayload for signature verification.
parseSignedContent(CharSequence, InputStream) - Method in interface io.jsonwebtoken.JwtParser: Parses a JWS known to use the RFC 7797: JSON Web Signature (JWS) Unencoded Payload Option, using the bytes from the specified unencodedPayload stream for signature verification.
parseUnsecuredClaims(CharSequence) - Method in interface io.jsonwebtoken.JwtParser: Parses the jwt argument, expected to be an unsecured Claims JWT.
parseUnsecuredContent(CharSequence) - Method in interface io.jsonwebtoken.JwtParser: Parses the jwt argument, expected to be an unsecured content JWT.
password(char[]) - Static method in class io.jsonwebtoken.security.Keys: Returns a new Password instance suitable for use with password-based key derivation algorithms.
Password - Interface in io.jsonwebtoken.security: A Key suitable for use with password-based key derivation algorithms.
pathEquals(String, String) - Static method in class io.jsonwebtoken.lang.Strings: Compare two paths after normalization of them.
PBES2_HS256_A128KW - Static variable in class io.jsonwebtoken.Jwts.KEY: Key encryption algorithm using PBES2 with HMAC SHA-256 and "A128KW" wrapping as defined by RFC 7518 (JWA), Section 4.8.
PBES2_HS384_A192KW - Static variable in class io.jsonwebtoken.Jwts.KEY: Key encryption algorithm using PBES2 with HMAC SHA-384 and "A192KW" wrapping as defined by RFC 7518 (JWA), Section 4.8.
PBES2_HS512_A256KW - Static variable in class io.jsonwebtoken.Jwts.KEY: Key encryption algorithm using PBES2 with HMAC SHA-512 and "A256KW" wrapping as defined by RFC 7518 (JWA), Section 4.8.
pbes2Count(int) - Method in interface io.jsonwebtoken.JweHeaderMutator: Sets the number of PBKDF2 iterations necessary to derive the key used during JWE encryption.
policy() - Static method in class io.jsonwebtoken.security.Jwks.OP: Creates a new KeyOperationPolicyBuilder for creating custom KeyOperationPolicy instances.
PrematureJwtException - Exception in io.jsonwebtoken: Exception indicating that a JWT was accepted before it is allowed to be accessed and must be rejected.
PrematureJwtException(Header, Claims, String) - Constructor for exception io.jsonwebtoken.PrematureJwtException: Creates a new instance with the specified explanation message.
PrematureJwtException(Header, Claims, String, Throwable) - Constructor for exception io.jsonwebtoken.PrematureJwtException: Deprecated.
since 0.12.0 since it is not used in JJWT's codebase
PrivateJwk<K extends PrivateKey,L extends PublicKey,M extends PublicJwk<L>> - Interface in io.jsonwebtoken.security: JWK representation of a PrivateKey.
PrivateJwkBuilder<K extends PrivateKey,L extends PublicKey,J extends PublicJwk<L>,M extends PrivateJwk<K,L,J>,T extends PrivateJwkBuilder<K,L,J,M,T>> - Interface in io.jsonwebtoken.security: An AsymmetricJwkBuilder that creates PrivateJwk instances.
privateKey(L) - Method in interface io.jsonwebtoken.security.PublicJwkBuilder: Sets the PrivateKey that pairs with the builder's existing PublicKey, converting this builder into a PrivateJwkBuilder which will produce a corresponding PrivateJwk instance.
PrivateKeyBuilder - Interface in io.jsonwebtoken.security: A builder that allows a PrivateKey to be transparently associated with a SecurityBuilder.provider(Provider) or PrivateKeyBuilder.publicKey(PublicKey) if necessary for algorithms that require them.
ProtectedHeader - Interface in io.jsonwebtoken: A JWT header that is integrity protected, either by JWS digital signature or JWE AEAD encryption.
ProtectedHeaderMutator<T extends ProtectedHeaderMutator<T>> - Interface in io.jsonwebtoken: Mutation (modifications) to a Header instance.
ProtectedJwt<H extends ProtectedHeader,P> - Interface in io.jsonwebtoken: A ProtectedJwt is a Jwt that is integrity protected via a cryptographic algorithm that produces a cryptographic digest, such as a MAC, Digital Signature or Authentication Tag.
provider(Provider) - Method in interface io.jsonwebtoken.io.ParserBuilder: Sets the JCA Provider to use during cryptographic operations, or null if the JCA subsystem preferred provider should be used.
provider(Provider) - Method in interface io.jsonwebtoken.JwtBuilder: Sets the JCA Provider to use during cryptographic signing or encryption operations, or null if the JCA subsystem preferred provider should be used.
provider(Provider) - Method in interface io.jsonwebtoken.JwtParserBuilder: Sets the JCA Provider to use during cryptographic signature and key decryption operations, or null if the JCA subsystem preferred provider should be used.
provider(Provider) - Method in interface io.jsonwebtoken.security.SecurityBuilder: Sets the JCA Security Provider to use if necessary when calling Builder.build().
PS256 - Static variable in class io.jsonwebtoken.Jwts.SIG: RSASSA-PSS using SHA-256 and MGF1 with SHA-256 signature algorithm as defined by RFC 7518, Section 3.5¹.
PS384 - Static variable in class io.jsonwebtoken.Jwts.SIG: RSASSA-PSS using SHA-384 and MGF1 with SHA-384 signature algorithm as defined by RFC 7518, Section 3.5¹.
PS512 - Static variable in class io.jsonwebtoken.Jwts.SIG: RSASSA-PSS using SHA-512 and MGF1 with SHA-512 signature algorithm as defined by RFC 7518, Section 3.5¹.
PublicJwk<K extends PublicKey> - Interface in io.jsonwebtoken.security: JWK representation of a PublicKey.
PublicJwkBuilder<K extends PublicKey,L extends PrivateKey,J extends PublicJwk<K>,M extends PrivateJwk<L,K,J>,P extends PrivateJwkBuilder<L,K,J,M,P>,T extends PublicJwkBuilder<K,L,J,M,P,T>> - Interface in io.jsonwebtoken.security: An AsymmetricJwkBuilder that creates PublicJwk instances.
publicKey(L) - Method in interface io.jsonwebtoken.security.PrivateJwkBuilder: Allows specifying of the PublicKey associated with the builder's existing PrivateKey, offering a reasonable performance enhancement when building the final private JWK.
publicKey(PublicKey) - Method in interface io.jsonwebtoken.security.PrivateKeyBuilder: Sets the private key's corresponding PublicKey so that its public key material will be available to algorithms that require it.
publicKeyUse(String) - Method in interface io.jsonwebtoken.security.AsymmetricJwkBuilder: Sets the JWK use (Public Key Use) parameter value.

Q

quote(String) - Static method in class io.jsonwebtoken.lang.Strings: Quote the given String with single quotes.
quoteIfString(Object) - Static method in class io.jsonwebtoken.lang.Strings: Turn the given Object into a String with single quotes if it is a String; keeping the Object as-is else.

R

random(SecureRandom) - Method in interface io.jsonwebtoken.JwtBuilder: Sets the SecureRandom to use during cryptographic signing or encryption operations, or null if a default SecureRandom should be used.
random(SecureRandom) - Method in interface io.jsonwebtoken.security.SecurityBuilder: Sets the SecureRandom to use if necessary when calling Builder.build().
Registry<K,V> - Interface in io.jsonwebtoken.lang: An immutable (read-only) repository of key-value pairs.
related(String) - Method in interface io.jsonwebtoken.security.KeyOperationBuilder: Indicates that the KeyOperation with the given id is cryptographically related (and complementary) to this one, and may be specified together in a JWK's operations set.
remove(E) - Method in interface io.jsonwebtoken.lang.CollectionMutator: Removes the specified element from the collection.
removeDuplicateStrings(String[]) - Static method in class io.jsonwebtoken.lang.Strings: Remove duplicate Strings from the given array.
replace(String, String, String) - Static method in class io.jsonwebtoken.lang.Strings: Replace all occurrences of a substring within a string with another string.
Request<T> - Interface in io.jsonwebtoken.security: A Request aggregates various parameters that may be used by a particular cryptographic algorithm.
require(String, Object) - Method in interface io.jsonwebtoken.JwtParserBuilder: Ensures that the specified claimName exists in the parsed JWT.
requireAudience(String) - Method in interface io.jsonwebtoken.JwtParserBuilder: Ensures that the specified aud exists in the parsed JWT.
RequiredTypeException - Exception in io.jsonwebtoken: Exception thrown when attempting to obtain a value from a JWT or JWK and the existing value does not match the expected type.
RequiredTypeException(String) - Constructor for exception io.jsonwebtoken.RequiredTypeException: Creates a new instance with the specified explanation message.
RequiredTypeException(String, Throwable) - Constructor for exception io.jsonwebtoken.RequiredTypeException: Creates a new instance with the specified explanation message and underlying cause.
requireExpiration(Date) - Method in interface io.jsonwebtoken.JwtParserBuilder: Ensures that the specified exp exists in the parsed JWT.
requireId(String) - Method in interface io.jsonwebtoken.JwtParserBuilder: Ensures that the specified jti exists in the parsed JWT.
requireIssuedAt(Date) - Method in interface io.jsonwebtoken.JwtParserBuilder: Ensures that the specified iat exists in the parsed JWT.
requireIssuer(String) - Method in interface io.jsonwebtoken.JwtParserBuilder: Ensures that the specified iss exists in the parsed JWT.
requireNotBefore(Date) - Method in interface io.jsonwebtoken.JwtParserBuilder: Ensures that the specified nbf exists in the parsed JWT.
requireSubject(String) - Method in interface io.jsonwebtoken.JwtParserBuilder: Ensures that the specified sub exists in the parsed JWT.
resolveCompressionCodec(Header) - Method in interface io.jsonwebtoken.CompressionCodecResolver: Deprecated.

Looks for a JWT zip header, and if found, returns the corresponding CompressionCodec the parser can use to decompress the JWT body.
resolveSigningKey(JwsHeader, Claims) - Method in interface io.jsonwebtoken.SigningKeyResolver: Deprecated.

Returns the signing key that should be used to validate a digital signature for the Claims JWS with the specified header and claims.
resolveSigningKey(JwsHeader, byte[]) - Method in interface io.jsonwebtoken.SigningKeyResolver: Deprecated.

Returns the signing key that should be used to validate a digital signature for the content JWS with the specified header and byte array payload.
resolveSigningKey(JwsHeader, Claims) - Method in class io.jsonwebtoken.SigningKeyResolverAdapter: Deprecated.
resolveSigningKey(JwsHeader, byte[]) - Method in class io.jsonwebtoken.SigningKeyResolverAdapter: Deprecated.
resolveSigningKeyBytes(JwsHeader, Claims) - Method in class io.jsonwebtoken.SigningKeyResolverAdapter: Deprecated.

Convenience method invoked by SigningKeyResolverAdapter.resolveSigningKey(JwsHeader, Claims) that obtains the necessary signing key bytes.
resolveSigningKeyBytes(JwsHeader, byte[]) - Method in class io.jsonwebtoken.SigningKeyResolverAdapter: Deprecated.

Convenience method invoked by SigningKeyResolverAdapter.resolveSigningKey(JwsHeader, byte[]) that obtains the necessary signing key bytes.
RS256 - Static variable in class io.jsonwebtoken.Jwts.SIG: RSASSA-PKCS1-v1_5 using SHA-256 signature algorithm as defined by RFC 7518, Section 3.3.
RS384 - Static variable in class io.jsonwebtoken.Jwts.SIG: RSASSA-PKCS1-v1_5 using SHA-384 signature algorithm as defined by RFC 7518, Section 3.3.
RS512 - Static variable in class io.jsonwebtoken.Jwts.SIG: RSASSA-PKCS1-v1_5 using SHA-512 signature algorithm as defined by RFC 7518, Section 3.3.
RSA1_5 - Static variable in class io.jsonwebtoken.Jwts.KEY: Key Encryption with RSAES-PKCS1-v1_5, as defined by RFC 7518 (JWA), Section 4.2.
RSA_OAEP - Static variable in class io.jsonwebtoken.Jwts.KEY: Key Encryption with RSAES OAEP using default parameters, as defined by RFC 7518 (JWA), Section 4.3.
RSA_OAEP_256 - Static variable in class io.jsonwebtoken.Jwts.KEY: Key Encryption with RSAES OAEP using SHA-256 and MGF1 with SHA-256, as defined by RFC 7518 (JWA), Section 4.3.
rsaChain(List<X509Certificate>) - Method in interface io.jsonwebtoken.security.DynamicJwkBuilder: Ensures the builder will create an RsaPublicJwk for the specified Java X509Certificate chain.
rsaKeyPair(KeyPair) - Method in interface io.jsonwebtoken.security.DynamicJwkBuilder: Ensures the builder will create an RsaPrivateJwk for the specified Java RSA KeyPair.
RsaPrivateJwk - Interface in io.jsonwebtoken.security: JWK representation of an RSAPrivateKey as defined by the JWA (RFC 7518) specification sections on Parameters for RSA Keys and Parameters for RSA Private Keys.
RsaPrivateJwkBuilder - Interface in io.jsonwebtoken.security: A PrivateJwkBuilder that creates RsaPrivateJwks.
RsaPublicJwk - Interface in io.jsonwebtoken.security: JWK representation of an RSAPublicKey as defined by the JWA (RFC 7518) specification sections on Parameters for RSA Keys and Parameters for RSA Public Keys.
RsaPublicJwkBuilder - Interface in io.jsonwebtoken.security: A PublicJwkBuilder that creates RsaPublicJwks.
RuntimeEnvironment - Class in io.jsonwebtoken.lang: Deprecated.
since 0.12.0. will be removed before the 1.0 final release.

S

SecretJwk - Interface in io.jsonwebtoken.security: JWK representation of a SecretKey as defined by the JWA (RFC 7518) specification section on Parameters for Symmetric Keys.
SecretJwkBuilder - Interface in io.jsonwebtoken.security: A JwkBuilder that creates SecretJwks.
SecretKeyAlgorithm - Interface in io.jsonwebtoken.security: A KeyAlgorithm that uses symmetric SecretKeys to obtain AEAD encryption and decryption keys.
SecretKeyBuilder - Interface in io.jsonwebtoken.security: A KeyBuilder that creates new secure-random SecretKeys with a length sufficient to be used by the security algorithm that produced this builder.
secretKeyFor(SignatureAlgorithm) - Static method in class io.jsonwebtoken.security.Keys: Deprecated.
since 0.12.0. Use your preferred MacAlgorithm instance's key() builder method directly.
SecureDigestAlgorithm<S extends Key,V extends Key> - Interface in io.jsonwebtoken.security: A DigestAlgorithm that requires a Key to compute and verify the authenticity of digests using either digital signature or message authentication code algorithms.
SecureRequest<T,K extends Key> - Interface in io.jsonwebtoken.security: A request to a cryptographic algorithm requiring a Key.
SecurityBuilder<T,B extends SecurityBuilder<T,B>> - Interface in io.jsonwebtoken.security: A Security-specific Builder that allows configuration of common JCA API parameters that might be used during instance creation, such as a Provider or SecureRandom.
SecurityException - Exception in io.jsonwebtoken.security: A JwtException attributed to a problem with security-related elements, such as cryptographic keys, algorithms, or the underlying Java JCA API.
SecurityException(String) - Constructor for exception io.jsonwebtoken.security.SecurityException: Creates a new instance with the specified explanation message.
SecurityException(String, Throwable) - Constructor for exception io.jsonwebtoken.security.SecurityException: Creates a new instance with the specified explanation message and underlying cause.
SerialException - Exception in io.jsonwebtoken.io: An exception thrown during serialization or deserialization.
SerialException(String) - Constructor for exception io.jsonwebtoken.io.SerialException: Creates a new instance with the specified explanation message.
SerialException(String, Throwable) - Constructor for exception io.jsonwebtoken.io.SerialException: Creates a new instance with the specified explanation message and underlying cause.
SerializationException - Exception in io.jsonwebtoken.io: Exception thrown when converting a Java object to a formatted byte array.
SerializationException(String) - Constructor for exception io.jsonwebtoken.io.SerializationException: Creates a new instance with the specified explanation message.
SerializationException(String, Throwable) - Constructor for exception io.jsonwebtoken.io.SerializationException: Creates a new instance with the specified explanation message and underlying cause.
serialize(T) - Method in class io.jsonwebtoken.io.AbstractSerializer: Converts the specified Java object into a formatted data byte array.
serialize(T, OutputStream) - Method in class io.jsonwebtoken.io.AbstractSerializer: Converts the specified Java object into a formatted data byte stream, writing the bytes to the specified output stream.
serialize(T) - Method in interface io.jsonwebtoken.io.Serializer: Deprecated.
since 0.12.0 in favor of Serializer.serialize(Object, OutputStream)
serialize(T, OutputStream) - Method in interface io.jsonwebtoken.io.Serializer: Converts the specified Java object into a formatted data byte stream, writing the bytes to the specified output stream.
Serializer<T> - Interface in io.jsonwebtoken.io: A Serializer is able to convert a Java object into a formatted byte stream.
serializeToJsonWith(Serializer<Map<String, ?>>) - Method in interface io.jsonwebtoken.JwtBuilder: Deprecated.
since 0.12.0 in favor of JwtBuilder.json(Serializer)
set() - Static method in class io.jsonwebtoken.security.Jwks: Return a new builder used to create JwkSets.
setAlgorithm(String) - Method in interface io.jsonwebtoken.ProtectedHeaderMutator: Deprecated.
since 0.12.0 and will be removed before the 1.0 release.
setAllowedClockSkewSeconds(long) - Method in interface io.jsonwebtoken.JwtParserBuilder: Deprecated.
since 0.12.0 in favor of the shorter and more modern builder-style named JwtParserBuilder.clockSkewSeconds(long). This method will be removed before the JJWT 1.0 release.
setAudience(String) - Method in interface io.jsonwebtoken.ClaimsMutator: Deprecated.
since 0.12.0 in favor of ClaimsMutator.audience(). This method will be removed before the JJWT 1.0 release.
setClaims(Map<String, ?>) - Method in interface io.jsonwebtoken.JwtBuilder: Deprecated.
since 0.12.0 in favor of using the JwtBuilder.claims() builder.
setClock(Clock) - Method in interface io.jsonwebtoken.JwtParserBuilder: Deprecated.
since 0.12.0 for the more modern builder-style named JwtParserBuilder.clock(Clock) method. This method will be removed before the JJWT 1.0 release.
setCompressionAlgorithm(String) - Method in interface io.jsonwebtoken.HeaderMutator: Deprecated.
since 0.12.0 and will be removed before the 1.0 release.
setCompressionCodecResolver(CompressionCodecResolver) - Method in interface io.jsonwebtoken.JwtParserBuilder: Deprecated.
since 0.12.0 in favor of JwtParserBuilder.zip(). This method will be removed before the 1.0 release.
setContentType(String) - Method in interface io.jsonwebtoken.HeaderMutator: Deprecated.
since 0.12.0 in favor of the more modern builder-style HeaderMutator.contentType(String).
setExpiration(Date) - Method in interface io.jsonwebtoken.ClaimsMutator: Deprecated.
since 0.12.0 in favor of the shorter and more modern builder-style named ClaimsMutator.expiration(Date). This method will be removed before the JJWT 1.0 release.
setHeader(Map<String, ?>) - Method in interface io.jsonwebtoken.JwtBuilder: Deprecated.
since 0.12.0 in favor of JwtBuilder.header().empty().add(map).and() (to replace all header parameters) or JwtBuilder.header().add(map).and() to only append the map entries. This method will be removed before the 1.0 release.
setHeaderParam(String, Object) - Method in interface io.jsonwebtoken.JwtBuilder: Deprecated.
since 0.12.0 in favor of JwtBuilder.header().add(name, value).and(). This method will be removed before the 1.0 release.
setHeaderParams(Map<String, ?>) - Method in interface io.jsonwebtoken.JwtBuilder: Deprecated.
since 0.12.0 in favor of JwtBuilder.header().add(map).and(). This method will be removed before the 1.0 release.
setId(String) - Method in interface io.jsonwebtoken.ClaimsMutator: Deprecated.
since 0.12.0 in favor of the shorter and more modern builder-style named ClaimsMutator.id(String). This method will be removed before the JJWT 1.0 release.
setIssuedAt(Date) - Method in interface io.jsonwebtoken.ClaimsMutator: Deprecated.
since 0.12.0 in favor of the shorter and more modern builder-style named ClaimsMutator.issuedAt(Date). This method will be removed before the JJWT 1.0 release.
setIssuer(String) - Method in interface io.jsonwebtoken.ClaimsMutator: Deprecated.
since 0.12.0 in favor of the shorter and more modern builder-style named ClaimsMutator.issuer(String). This method will be removed before the JJWT 1.0 release.
setIv(byte[]) - Method in interface io.jsonwebtoken.security.AeadResult: Sets the initialization vector used during encryption.
setKeyId(String) - Method in interface io.jsonwebtoken.ProtectedHeaderMutator: Deprecated.
since 0.12.0 in favor of the more modern builder-style ProtectedHeaderMutator.keyId(String) method.
setNotBefore(Date) - Method in interface io.jsonwebtoken.ClaimsMutator: Deprecated.
since 0.12.0 in favor of the shorter and more modern builder-style named ClaimsMutator.notBefore(Date). This method will be removed before the JJWT 1.0 release.
setOf(T...) - Static method in class io.jsonwebtoken.lang.Collections: Returns a type-safe immutable Set containing the specified array elements.
setParser() - Static method in class io.jsonwebtoken.security.Jwks: Returns a new builder used to create Parsers that parse JSON into JwkSet instances.
setPayload(String) - Method in interface io.jsonwebtoken.JwtBuilder: Deprecated.
since 0.12.0 in favor of JwtBuilder.content(String) because both Claims and Content are technically 'payloads', so this method name is misleading. This method will be removed before the 1.0 release.
setSigningKey(byte[]) - Method in interface io.jsonwebtoken.JwtParserBuilder: Deprecated.
since 0.12.0 in favor of JwtParserBuilder.verifyWith(SecretKey) for type safety and name congruence with the JwtParserBuilder.decryptWith(SecretKey) method.
setSigningKey(String) - Method in interface io.jsonwebtoken.JwtParserBuilder: Deprecated.
in favor of JwtParserBuilder.verifyWith(SecretKey) as explained in the above Deprecation Notice, and will be removed in 1.0.0.
setSigningKey(Key) - Method in interface io.jsonwebtoken.JwtParserBuilder: Deprecated.
since 0.12.0 in favor of JwtParserBuilder.verifyWith(SecretKey) for naming congruence with the JwtParserBuilder.decryptWith(SecretKey) method.
setSigningKeyResolver(SigningKeyResolver) - Method in interface io.jsonwebtoken.JwtParserBuilder: Deprecated.
since 0.12.0 in favor of JwtParserBuilder.keyLocator(Locator)
setSubject(String) - Method in interface io.jsonwebtoken.ClaimsMutator: Deprecated.
since 0.12.0 in favor of the shorter and more modern builder-style named ClaimsMutator.subject(String). This method will be removed before the JJWT 1.0 release.
setTag(byte[]) - Method in interface io.jsonwebtoken.security.AeadResult: Sets the AEAD authentication tag.
setType(String) - Method in interface io.jsonwebtoken.HeaderMutator: Deprecated.
since 0.12.0 in favor of the more modern builder-style HeaderMutator.type(String) method. This method will be removed before the 1.0 release.
SHA256 - Static variable in class io.jsonwebtoken.security.Jwks.HASH: IANA hash algorithm with an id (aka IANA "Hash Name String") value of sha-256.
SHA384 - Static variable in class io.jsonwebtoken.security.Jwks.HASH: IANA hash algorithm with an id (aka IANA "Hash Name String") value of sha-384.
SHA3_256 - Static variable in class io.jsonwebtoken.security.Jwks.HASH: IANA hash algorithm with an id (aka IANA "Hash Name String") value of sha3-256.
SHA3_384 - Static variable in class io.jsonwebtoken.security.Jwks.HASH: IANA hash algorithm with an id (aka IANA "Hash Name String") value of sha3-384.
SHA3_512 - Static variable in class io.jsonwebtoken.security.Jwks.HASH: IANA hash algorithm with an id (aka IANA "Hash Name String") value of sha3-512.
SHA512 - Static variable in class io.jsonwebtoken.security.Jwks.HASH: IANA hash algorithm with an id (aka IANA "Hash Name String") value of sha-512.
sig() - Method in interface io.jsonwebtoken.JwtParserBuilder: Configures the parser's supported SignatureAlgorithm and MacAlgorithms used to verify JWS signatures.
SIGN - Static variable in class io.jsonwebtoken.security.Jwks.OP: sign operation indicating a key is intended to be used to compute digital signatures or MACs.
SignatureAlgorithm - Interface in io.jsonwebtoken.security: A digital signature algorithm computes and verifies digests using asymmetric public/private key cryptography.
SignatureAlgorithm - Enum in io.jsonwebtoken: Deprecated.
since 0.12.0; use Jwts.SIG instead.
SignatureException - Exception in io.jsonwebtoken.security: Exception thrown if there is problem calculating or verifying a digital signature or message authentication code.
SignatureException(String) - Constructor for exception io.jsonwebtoken.security.SignatureException: Creates a new instance with the specified explanation message.
SignatureException(String, Throwable) - Constructor for exception io.jsonwebtoken.security.SignatureException: Creates a new instance with the specified explanation message and underlying cause.
SignatureException - Exception in io.jsonwebtoken: Deprecated.
in favor of SignatureException; this class will be removed before 1.0
SignatureException(String) - Constructor for exception io.jsonwebtoken.SignatureException: Deprecated.

Creates a new instance with the specified explanation message.
SignatureException(String, Throwable) - Constructor for exception io.jsonwebtoken.SignatureException: Deprecated.

Creates a new instance with the specified explanation message and underlying cause.
SigningKeyResolver - Interface in io.jsonwebtoken: Deprecated.
since 0.12.0. Implement Locator instead.
SigningKeyResolverAdapter - Class in io.jsonwebtoken: Deprecated.
since 0.12.0. Use LocatorAdapter with JwtParserBuilder.keyLocator(Locator)
SigningKeyResolverAdapter() - Constructor for class io.jsonwebtoken.SigningKeyResolverAdapter: Deprecated.

Default constructor.
signWith(Key) - Method in interface io.jsonwebtoken.JwtBuilder: Signs the constructed JWT with the specified key using the key's recommended signature algorithm as defined below, producing a JWS.
signWith(SignatureAlgorithm, byte[]) - Method in interface io.jsonwebtoken.JwtBuilder: Deprecated.
as of 0.10.0: use Keys.hmacShaKeyFor(bytes) to obtain the Key and then invoke JwtBuilder.signWith(Key) or JwtBuilder.signWith(Key, SecureDigestAlgorithm). This method will be removed in the 1.0 release.
signWith(SignatureAlgorithm, String) - Method in interface io.jsonwebtoken.JwtBuilder: Deprecated.
as of 0.10.0: use JwtBuilder.signWith(Key) or JwtBuilder.signWith(Key, SignatureAlgorithm) instead. This method will be removed in the 1.0 release.
signWith(SignatureAlgorithm, Key) - Method in interface io.jsonwebtoken.JwtBuilder: Deprecated.
since 0.10.0. Use JwtBuilder.signWith(Key, SecureDigestAlgorithm) instead. This method will be removed before the 1.0 release.
signWith(Key, SignatureAlgorithm) - Method in interface io.jsonwebtoken.JwtBuilder: Deprecated.
since 0.12.0 to use the more flexible JwtBuilder.signWith(Key, SecureDigestAlgorithm).
signWith(K, SecureDigestAlgorithm<? super K, ?>) - Method in interface io.jsonwebtoken.JwtBuilder: Signs the constructed JWT with the specified key using the specified algorithm, producing a JWS.
single(String) - Method in interface io.jsonwebtoken.ClaimsMutator.AudienceCollection: Deprecated.
This is technically not deprecated because the JWT RFC mandates support for single string values, but it is marked as deprecated to discourage its use when possible.
size(Collection<?>) - Static method in class io.jsonwebtoken.lang.Collections: Returns the collection's size or 0 if the collection is null.
size(Map<?, ?>) - Static method in class io.jsonwebtoken.lang.Collections: Returns the map's size or 0 if the map is null.
sortStringArray(String[]) - Static method in class io.jsonwebtoken.lang.Strings: Turn given source String array into sorted array.
split(String, String) - Static method in class io.jsonwebtoken.lang.Strings: Split a String at the first occurrence of the delimiter.
splitArrayElementsIntoProperties(String[], String) - Static method in class io.jsonwebtoken.lang.Strings: Take an array Strings and split each element based on the given delimiter.
splitArrayElementsIntoProperties(String[], String, String) - Static method in class io.jsonwebtoken.lang.Strings: Take an array Strings and split each element based on the given delimiter.
startsWithIgnoreCase(String, String) - Static method in class io.jsonwebtoken.lang.Strings: Returns true if the given string starts with the specified case-insensitive prefix, false otherwise.
state(boolean, String) - Static method in class io.jsonwebtoken.lang.Assert: Assert a boolean expression, throwing IllegalStateException if the test result is false.
state(boolean) - Static method in class io.jsonwebtoken.lang.Assert: Assert a boolean expression, throwing IllegalStateException if the test result is false.
stateIsInstance(Class<T>, Object, String) - Static method in class io.jsonwebtoken.lang.Assert: Asserts that the provided object is an instance of the provided class, throwing an IllegalStateException otherwise.
stateNotNull(T, String) - Static method in class io.jsonwebtoken.lang.Assert: Asserts that the specified value is not null, otherwise throws an IllegalStateException with the specified msg.
Strings - Class in io.jsonwebtoken.lang: Utility methods for working with Strings to reduce pattern repetition and otherwise increased cyclomatic complexity.
stripFilenameExtension(String) - Static method in class io.jsonwebtoken.lang.Strings: Strip the filename extension from the given path, e.g.
SUBJECT - Static variable in interface io.jsonwebtoken.Claims: JWT Subject claims parameter name: "sub"
subject(String) - Method in interface io.jsonwebtoken.ClaimsMutator: Sets the JWT sub (subject) claim.
subject(String) - Method in interface io.jsonwebtoken.JwtBuilder: Sets the JWT Claims sub (subject) claim.
substringMatch(CharSequence, int, CharSequence) - Static method in class io.jsonwebtoken.lang.Strings: Returns true if the given string matches the given substring at the given index, false otherwise.
Supplier<T> - Interface in io.jsonwebtoken.lang: Represents a supplier of results.
SupportedJwtVisitor<T> - Class in io.jsonwebtoken: A JwtVisitor that guarantees only supported JWT instances are handled, rejecting all other (unsupported) JWTs with UnsupportedJwtExceptions.
SupportedJwtVisitor() - Constructor for class io.jsonwebtoken.SupportedJwtVisitor: Default constructor, does not initialize any internal state.

T

thumbprint() - Method in interface io.jsonwebtoken.security.Jwk: Computes and returns the canonical JWK Thumbprint of this JWK using the SHA-256 hash algorithm.
thumbprint(HashAlgorithm) - Method in interface io.jsonwebtoken.security.Jwk: Computes and returns the canonical JWK Thumbprint of this JWK using the specified hash algorithm.
toArray(Enumeration<E>, A[]) - Static method in class io.jsonwebtoken.lang.Collections: Marshal the elements from the given enumeration into an array of the given type.
toBinary(byte) - Static method in class io.jsonwebtoken.lang.Strings: Returns a String representation (1s and 0s) of the specified byte.
toBinary(byte[]) - Static method in class io.jsonwebtoken.lang.Strings: Returns a String representation (1s and 0s) of the specified byte array.
toByteArray() - Method in interface io.jsonwebtoken.security.JwkThumbprint: Returns the actual thumbprint (aka digest) byte array value.
toCharArray() - Method in interface io.jsonwebtoken.security.Password: Returns a new clone of the underlying password character array for use during derivation algorithms.
toHex(byte[]) - Static method in class io.jsonwebtoken.lang.Strings: Returns a hexadecimal String representation of the specified byte array.
toIterator(Enumeration<E>) - Static method in class io.jsonwebtoken.lang.Collections: Adapt an enumeration to an iterator.
toJavaKeyPair() - Method in interface io.jsonwebtoken.security.KeyPair: Returns this instance as a KeyPair instance.
tokenizeToStringArray(String, String) - Static method in class io.jsonwebtoken.lang.Strings: Tokenize the given String into a String array via a StringTokenizer.
tokenizeToStringArray(String, String, boolean, boolean) - Static method in class io.jsonwebtoken.lang.Strings: Tokenize the given String into a String array via a StringTokenizer.
toKey() - Method in interface io.jsonwebtoken.security.Jwk: Represents the JWK as its corresponding Java Key instance for use with Java cryptographic APIs.
toKeyPair() - Method in interface io.jsonwebtoken.security.PrivateJwk: Returns the key's corresponding Java PrivateKey and PublicKey in aggregate as a type-safe KeyPair instance.
toLanguageTag(Locale) - Static method in class io.jsonwebtoken.lang.Strings: Determine the RFC 3066 compliant language tag, as used for the HTTP "Accept-Language" header.
toObjectArray(Object) - Static method in class io.jsonwebtoken.lang.Objects: Convert the given array (which may be a primitive array) to an object array (if necessary of primitive wrapper objects).
toPublicJwk() - Method in interface io.jsonwebtoken.security.PrivateJwk: Returns the private JWK's corresponding PublicJwk, containing only the key's public properties.
toString() - Method in interface io.jsonwebtoken.security.JwkThumbprint: Returns the JwkThumbprint.toByteArray() value as a Base64URL-encoded string.
toStringArray(Collection<String>) - Static method in class io.jsonwebtoken.lang.Strings: Copy the given Collection into a String array.
toStringArray(Enumeration<String>) - Static method in class io.jsonwebtoken.lang.Strings: Copy the given Enumeration into a String array.
toURI() - Method in interface io.jsonwebtoken.security.JwkThumbprint: Returns the canonical URI representation of this thumbprint as defined by the JWK Thumbprint URI specification.
trimAllWhitespace(String) - Static method in class io.jsonwebtoken.lang.Strings: Trim all whitespace from the given String: leading, trailing, and intermediate characters.
trimArrayElements(String[]) - Static method in class io.jsonwebtoken.lang.Strings: Trim the elements of the given String array, calling String.trim() on each of them.
trimLeadingCharacter(String, char) - Static method in class io.jsonwebtoken.lang.Strings: Trim all occurrences of the supplied leading character from the given String.
trimLeadingWhitespace(String) - Static method in class io.jsonwebtoken.lang.Strings: Trim leading whitespace from the given String.
trimTrailingCharacter(String, char) - Static method in class io.jsonwebtoken.lang.Strings: Trim all occurrences of the supplied trailing character from the given String.
trimTrailingWhitespace(String) - Static method in class io.jsonwebtoken.lang.Strings: Trim trailing whitespace from the given String.
trimWhitespace(String) - Static method in class io.jsonwebtoken.lang.Strings: Trim leading and trailing whitespace from the given String.
TYPE - Static variable in interface io.jsonwebtoken.Header: Deprecated.
since 0.12.0 in favor of Header.getType().
type(String) - Method in interface io.jsonwebtoken.HeaderMutator: Sets the JWT typ (Type) header value.

U

uncapitalize(String) - Static method in class io.jsonwebtoken.lang.Strings: Uncapitalize a String, changing the first letter to lower case as per Character.toLowerCase(char).
UnknownClassException - Exception in io.jsonwebtoken.lang: A RuntimeException equivalent of the JDK's ClassNotFoundException, to maintain a RuntimeException paradigm.
UnknownClassException(String) - Constructor for exception io.jsonwebtoken.lang.UnknownClassException: Constructs a new UnknownClassException.
UnknownClassException(String, Throwable) - Constructor for exception io.jsonwebtoken.lang.UnknownClassException: Constructs a new UnknownClassException.
unqualify(String) - Static method in class io.jsonwebtoken.lang.Strings: Unqualify a string qualified by a '.' dot character.
unqualify(String, char) - Static method in class io.jsonwebtoken.lang.Strings: Unqualify a string qualified by a separator character.
unrelated() - Method in interface io.jsonwebtoken.security.KeyOperationPolicyBuilder: Allows a JWK to have unrelated KeyOperations in its key_ops parameter values.
UNSAFE_JSON(Jwk<?>) - Static method in class io.jsonwebtoken.security.Jwks: WARNING - UNSAFE OPERATION - RETURN VALUES CONTAIN RAW KEY MATERIAL, DO NOT LOG OR PRINT TO SYSTEM.OUT. Converts the specified JWK into JSON, including raw key material.
unsecured() - Method in interface io.jsonwebtoken.JwtParserBuilder: Enables parsing of Unsecured JWTs (JWTs with an 'alg' (Algorithm) header value of 'none' or missing the 'alg' header entirely).
UNSECURED_CLAIMS - Static variable in interface io.jsonwebtoken.Jwt: Visitor implementation that ensures the visited JWT is an unsecured Claims JWT (one not cryptographically signed or encrypted) and rejects all others with an UnsupportedJwtException.
UNSECURED_CONTENT - Static variable in interface io.jsonwebtoken.Jwt: Visitor implementation that ensures the visited JWT is an unsecured content JWT (one not cryptographically signed or encrypted) and rejects all others with an UnsupportedJwtException.
unsecuredDecompression() - Method in interface io.jsonwebtoken.JwtParserBuilder: If the parser is JwtParserBuilder.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.
UnsupportedJwtException - Exception in io.jsonwebtoken: Exception thrown when receiving a JWT in a particular format/configuration that does not match the format expected by the application.
UnsupportedJwtException(String) - Constructor for exception io.jsonwebtoken.UnsupportedJwtException: Creates a new instance with the specified explanation message.
UnsupportedJwtException(String, Throwable) - Constructor for exception io.jsonwebtoken.UnsupportedJwtException: Creates a new instance with the specified explanation message and underlying cause.
UnsupportedKeyException - Exception in io.jsonwebtoken.security: Exception thrown when encountering a key or key material that is not supported or recognized.
UnsupportedKeyException(String) - Constructor for exception io.jsonwebtoken.security.UnsupportedKeyException: Creates a new instance with the specified explanation message.
UnsupportedKeyException(String, Throwable) - Constructor for exception io.jsonwebtoken.security.UnsupportedKeyException: Creates a new instance with the specified explanation message and underlying cause.
UNWRAP_KEY - Static variable in class io.jsonwebtoken.security.Jwks.OP: unwrapKey operation indicating a key is intended to be used to decrypt another key and validate decryption, if applicable.
utf8(CharSequence) - Static method in class io.jsonwebtoken.lang.Strings: Returns the specified string's UTF-8 bytes, or null if the string is null.
utf8(byte[]) - Static method in class io.jsonwebtoken.lang.Strings: Returns new String(utf8Bytes, StandardCharsets.UTF_8).
UTF_8 - Static variable in class io.jsonwebtoken.lang.Strings: Convenience alias for StandardCharsets.UTF_8.

V

validate(Collection<? extends KeyOperation>) - Method in interface io.jsonwebtoken.security.KeyOperationPolicy: Returns quietly if all of the specified key operations are allowed to be assigned to a JWK, or throws an IllegalArgumentException otherwise.
valueOf(String) - Static method in enum io.jsonwebtoken.SignatureAlgorithm: Deprecated.

Returns the enum constant of this type with the specified name.
values() - Static method in enum io.jsonwebtoken.SignatureAlgorithm: Deprecated.

Returns an array containing the constants of this enum type, in the order they are declared.
verify(V) - Method in interface io.jsonwebtoken.security.DigestAlgorithm: Returns true if the provided digest matches the expected value for the given payload, false otherwise.
VERIFY - Static variable in class io.jsonwebtoken.security.Jwks.OP: verify operation indicating a key is intended to be used to verify digital signatures or MACs.
VerifyDigestRequest - Interface in io.jsonwebtoken.security: A request to verify a previously-computed cryptographic digest (available via DigestSupplier.getDigest()) against the digest to be computed for the specified payload.
VerifySecureDigestRequest<K extends Key> - Interface in io.jsonwebtoken.security: A request to a SecureDigestAlgorithm to verify a previously-computed digital signature or message authentication code.
verifyWith(SecretKey) - Method in interface io.jsonwebtoken.JwtParserBuilder: Sets the signature verification SecretKey used to verify all encountered JWS signatures.
verifyWith(PublicKey) - Method in interface io.jsonwebtoken.JwtParserBuilder: Sets the signature verification PublicKey used to verify all encountered JWS signatures.
visit(Jwt<?, ?>) - Method in interface io.jsonwebtoken.JwtVisitor: Handles an encountered Unsecured JWT that has not been cryptographically secured at all.
visit(Jws<?>) - Method in interface io.jsonwebtoken.JwtVisitor: Handles an encountered JSON Web Signature (aka 'JWS') message that has been cryptographically verified/authenticated.
visit(Jwe<?>) - Method in interface io.jsonwebtoken.JwtVisitor: Handles an encountered JSON Web Encryption (aka 'JWE') message that has been authenticated and decrypted.
visit(Jwt<?, ?>) - Method in class io.jsonwebtoken.SupportedJwtVisitor: Handles an encountered unsecured JWT by delegating to either SupportedJwtVisitor.onUnsecuredContent(Jwt) or SupportedJwtVisitor.onUnsecuredClaims(Jwt) depending on the payload type.
visit(Jws<?>) - Method in class io.jsonwebtoken.SupportedJwtVisitor: Handles an encountered JSON Web Token (aka 'JWS') message that has been cryptographically verified/authenticated by delegating to either SupportedJwtVisitor.onVerifiedContent(Jws) or SupportedJwtVisitor.onVerifiedClaims(Jws) depending on the payload type.
visit(Jwe<?>) - Method in class io.jsonwebtoken.SupportedJwtVisitor: Handles an encountered JSON Web Encryption (aka 'JWE') message that has been authenticated and decrypted by delegating to either SupportedJwtVisitor.onDecryptedContent(Jwe) or SupportedJwtVisitor.onDecryptedClaims(Jwe) depending on the payload type.

W

WeakKeyException - Exception in io.jsonwebtoken.security: Exception thrown when encountering a key that is not strong enough (of sufficient length) to be used with a particular algorithm or in a particular security context.
WeakKeyException(String) - Constructor for exception io.jsonwebtoken.security.WeakKeyException: Creates a new instance with the specified explanation message.
wrap(CharSequence) - Static method in class io.jsonwebtoken.lang.Strings: Returns a CharBuffer that wraps seq, or an empty buffer if seq is null.
WRAP_KEY - Static variable in class io.jsonwebtoken.security.Jwks.OP: wrapKey operation indicating a key is intended to be used to encrypt another key.

X

X25519 - Static variable in class io.jsonwebtoken.security.Jwks.CRV: X25519 Elliptic Curve defined by RFC 8037, Section 3.2 using the native Java JCA X25519¹ algorithm.
X448 - Static variable in class io.jsonwebtoken.security.Jwks.CRV: X448 Elliptic Curve defined by RFC 8037, Section 3.2 using the native Java JCA X448¹ algorithm.
X509_CERT_CHAIN - Static variable in interface io.jsonwebtoken.JwsHeader: Deprecated.
since 0.12.0 in favor of X509Accessor.getX509Chain()
X509_CERT_SHA1_THUMBPRINT - Static variable in interface io.jsonwebtoken.JwsHeader: Deprecated.
since 0.12.0 in favor of X509Accessor.getX509Sha1Thumbprint()
X509_CERT_SHA256_THUMBPRINT - Static variable in interface io.jsonwebtoken.JwsHeader: Deprecated.
since 0.12.0 in favor of X509Accessor.getX509Sha256Thumbprint()
X509_URL - Static variable in interface io.jsonwebtoken.JwsHeader: Deprecated.
since 0.12.0 in favor of X509Accessor.getX509Url()
X509Accessor - Interface in io.jsonwebtoken.security: Accessor methods of X.509-specific properties of a ProtectedHeader or AsymmetricJwk, guaranteeing consistent behavior across similar but distinct JWT concepts with identical parameter names.
X509Builder<T extends X509Builder<T>> - Interface in io.jsonwebtoken.security: Additional X.509-specific builder methods for constructing an associated JWT Header or JWK, enabling method chaining.
x509Chain(List<X509Certificate>) - Method in interface io.jsonwebtoken.security.X509Mutator: Sets the x5c (X.509 Certificate Chain) of the associated JWT or JWK.
X509Mutator<T extends X509Mutator<T>> - Interface in io.jsonwebtoken.security: Mutation (modifications) of X.509-specific properties of an associated JWT Header or JWK, enabling method chaining.
x509Sha1Thumbprint(boolean) - Method in interface io.jsonwebtoken.security.X509Builder: If the enable argument is true, compute the SHA-1 thumbprint of the first X509Certificate in the configured x509CertificateChain, and set the resulting value as the X509Mutator.x509Sha1Thumbprint(byte[]) parameter.
x509Sha1Thumbprint(byte[]) - Method in interface io.jsonwebtoken.security.X509Mutator: Sets the x5t (X.509 Certificate SHA-1 Thumbprint) (a.k.a.
x509Sha256Thumbprint(boolean) - Method in interface io.jsonwebtoken.security.X509Builder: If the enable argument is true, compute the SHA-256 thumbprint of the first X509Certificate in the configured x509CertificateChain, and set the resulting value as the X509Mutator.x509Sha256Thumbprint(byte[]) parameter.
x509Sha256Thumbprint(byte[]) - Method in interface io.jsonwebtoken.security.X509Mutator: Sets the x5t#S256 (X.509 Certificate SHA-256 Thumbprint) (a.k.a.
x509Url(URI) - Method in interface io.jsonwebtoken.security.X509Mutator: Sets the x5u (X.509 URL) that refers to a resource containing the X.509 public key certificate or certificate chain of the associated JWT or JWK.

Z

zip() - Method in interface io.jsonwebtoken.JwtParserBuilder: Configures the parser's supported CompressionAlgorithms used to decompress JWT payloads.

A B C D E F G H I J K L M N O P Q R S T U V W X Z