Index (JJWT :: API 0.11.2 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

A

addClaims(Map<String, Object>) - Method in interface io.jsonwebtoken.JwtBuilder: Adds all given name/value pairs to the JSON Claims in the payload.
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.
ALGORITHM - Static variable in interface io.jsonwebtoken.JwsHeader: JWS Algorithm header parameter name: "alg"
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
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.
Assert - Class in io.jsonwebtoken.lang
assertValidSigningKey(Key) - Method in enum io.jsonwebtoken.SignatureAlgorithm: 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: 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.
AUDIENCE - Static variable in interface io.jsonwebtoken.Claims: JWT Audience claims parameter name: "aud"

B

BASE64 - Static variable in class io.jsonwebtoken.io.Decoders
BASE64 - Static variable in class io.jsonwebtoken.io.Encoders
BASE64URL - Static variable in class io.jsonwebtoken.io.Decoders
BASE64URL - Static variable in class io.jsonwebtoken.io.Encoders
base64UrlDecodeWith(Decoder<String, byte[]>) - Method in interface io.jsonwebtoken.JwtParser: Deprecated.
see JwtParserBuilder.base64UrlDecodeWith(Decoder). To construct a JwtParser use the corresponding builder via Jwts.parserBuilder(). This will construct an immutable JwtParser.
NOTE: this method will be removed before version 1.0
base64UrlDecodeWith(Decoder<String, byte[]>) - Method in interface io.jsonwebtoken.JwtParserBuilder: Perform Base64Url decoding with the specified Decoder
base64UrlEncodeWith(Encoder<byte[], String>) - Method in interface io.jsonwebtoken.JwtBuilder: Perform Base64Url encoding with the specified Encoder.
BOUNCY_CASTLE_AVAILABLE - Static variable in class io.jsonwebtoken.lang.RuntimeEnvironment
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.Maps.MapBuilder: Returns a 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.

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).
claim(String, Object) - Method in interface io.jsonwebtoken.JwtBuilder: Sets a custom JWT Claims parameter value.
ClaimJwtException - Exception in io.jsonwebtoken: ClaimJwtException is a subclass of the JwtException that is thrown after a validation of an JTW claim failed.
ClaimJwtException(Header, Claims, String) - Constructor for exception io.jsonwebtoken.ClaimJwtException
ClaimJwtException(Header, Claims, String, Throwable) - Constructor for exception io.jsonwebtoken.ClaimJwtException
Claims - Interface in io.jsonwebtoken: A JWT Claims set.
claims() - Static method in class io.jsonwebtoken.Jwts: Returns a new Claims instance to be used as a JWT body.
claims(Map<String, Object>) - Static method in class io.jsonwebtoken.Jwts: Returns a new Claims instance populated with the specified name/value pairs.
ClaimsMutator<T extends ClaimsMutator> - Interface in io.jsonwebtoken: Mutation (modifications) to a Claims instance.
Classes - Class in io.jsonwebtoken.lang
clean(byte[]) - Static method in class io.jsonwebtoken.lang.Arrays
clean(String) - Static method in class io.jsonwebtoken.lang.Strings
clean(CharSequence) - Static method in class io.jsonwebtoken.lang.Strings
cleanPath(String) - Static method in class io.jsonwebtoken.lang.Strings: Normalize the path by suppressing sequences like "path/.." and inner simple dots.
Clock - Interface in io.jsonwebtoken: A clock represents a time source that can be used when creating and verifying JWTs.
CodecException - Exception in io.jsonwebtoken.io
CodecException(String) - Constructor for exception io.jsonwebtoken.io.CodecException
CodecException(String, Throwable) - Constructor for exception io.jsonwebtoken.io.CodecException
Collections - Class in io.jsonwebtoken.lang
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: Compresses the specified byte array according to the compression algorithm.
COMPRESSION_ALGORITHM - Static variable in interface io.jsonwebtoken.Header: JWT Compression Algorithm header parameter name: "zip"
CompressionCodec - Interface in io.jsonwebtoken: Compresses and decompresses byte arrays according to a compression algorithm.
CompressionCodecResolver - Interface in io.jsonwebtoken: Looks for a JWT zip header, and if found, returns the corresponding CompressionCodec the parser can use to decompress the JWT body.
CompressionCodecs - Class in io.jsonwebtoken: Provides default implementations of the CompressionCodec interface.
CompressionException - Exception in io.jsonwebtoken: Exception indicating that either compressing or decompressing an JWT body failed.
CompressionException(String) - Constructor for exception io.jsonwebtoken.CompressionException
CompressionException(String, Throwable) - Constructor for exception io.jsonwebtoken.CompressionException
compressWith(CompressionCodec) - Method in interface io.jsonwebtoken.JwtBuilder: Compresses the JWT body using the specified CompressionCodec.
concatenateStringArrays(String[], String[]) - Static method in class io.jsonwebtoken.lang.Strings: Concatenate the given String arrays into one, with overlapping array elements included twice.
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_TYPE - Static variable in interface io.jsonwebtoken.Header: JWT Content Type header parameter name: "cty"
countOccurrencesOf(String, String) - Static method in class io.jsonwebtoken.lang.Strings: Count the occurrences of the substring in string s.
CRITICAL - Static variable in interface io.jsonwebtoken.JwsHeader: JWS Critical header parameter name: "crit"

D

DateFormats - Class in io.jsonwebtoken.lang
DateFormats() - Constructor for class io.jsonwebtoken.lang.DateFormats
decode(T) - Method in interface io.jsonwebtoken.io.Decoder
Decoder<T,R> - Interface in io.jsonwebtoken.io
Decoders - Class in io.jsonwebtoken.io
DecodingException - Exception in io.jsonwebtoken.io
DecodingException(String) - Constructor for exception io.jsonwebtoken.io.DecodingException
DecodingException(String, Throwable) - Constructor for exception io.jsonwebtoken.io.DecodingException
decompress(byte[]) - Method in interface io.jsonwebtoken.CompressionCodec: Decompresses the specified compressed byte array according to the compression algorithm.
DEFLATE - Static variable in class io.jsonwebtoken.CompressionCodecs: Codec implementing the JWA standard deflate compression algorithm
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.
DeserializationException - Exception in io.jsonwebtoken.io
DeserializationException(String) - Constructor for exception io.jsonwebtoken.io.DeserializationException
DeserializationException(String, Throwable) - Constructor for exception io.jsonwebtoken.io.DeserializationException
deserialize(byte[]) - Method in interface io.jsonwebtoken.io.Deserializer
deserializeJsonWith(Deserializer<Map<String, ?>>) - Method in interface io.jsonwebtoken.JwtParser: Deprecated.
see JwtParserBuilder.deserializeJsonWith(Deserializer) )}. To construct a JwtParser use the corresponding builder via Jwts.parserBuilder(). This will construct an immutable JwtParser.
NOTE: this method will be removed before version 1.0
deserializeJsonWith(Deserializer<Map<String, ?>>) - Method in interface io.jsonwebtoken.JwtParserBuilder: Uses the specified deserializer to convert JSON Strings (UTF-8 byte arrays) into Java Map objects.
Deserializer<T> - Interface in io.jsonwebtoken.io
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.

E

enableBouncyCastleIfPossible() - Static method in class io.jsonwebtoken.lang.RuntimeEnvironment
encode(T) - Method in interface io.jsonwebtoken.io.Encoder
Encoder<T,R> - Interface in io.jsonwebtoken.io
Encoders - Class in io.jsonwebtoken.io
EncodingException - Exception in io.jsonwebtoken.io
EncodingException(String, Throwable) - Constructor for exception io.jsonwebtoken.io.EncodingException
endsWithIgnoreCase(String, String) - Static method in class io.jsonwebtoken.lang.Strings: Test if the given String ends with the specified suffix, ignoring upper/lower case.
EXPIRATION - Static variable in interface io.jsonwebtoken.Claims: JWT Expiration claims parameter name: "exp"
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
ExpiredJwtException(Header, Claims, String, Throwable) - Constructor for exception io.jsonwebtoken.ExpiredJwtException

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.
formatIso8601(Date) - Static method in class io.jsonwebtoken.lang.DateFormats
formatIso8601(Date, boolean) - Static method in class io.jsonwebtoken.lang.DateFormats
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: 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: 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 type requiredType, or null if not present.
getAlgorithm() - Method in interface io.jsonwebtoken.JwsHeader: Returns the JWS alg (algorithm) header value or null if not present.
getAlgorithmName() - Method in interface io.jsonwebtoken.CompressionCodec: The compression algorithm name to use as the JWT's zip header value.
getAudience() - Method in interface io.jsonwebtoken.Claims: Returns the JWT aud (audience) value or null if not present.
getBody() - Method in interface io.jsonwebtoken.Jwt: Returns the JWT body, either a String or a Claims instance.
getClaimName() - Method in exception io.jsonwebtoken.InvalidClaimException
getClaims() - Method in exception io.jsonwebtoken.ClaimJwtException
getClaimValue() - Method in exception io.jsonwebtoken.InvalidClaimException
getCompressionAlgorithm() - Method in interface io.jsonwebtoken.Header: Returns the JWT zip (Compression Algorithm) header value or null if not present.
getConstructor(Class<T>, Class...) - Static method in class io.jsonwebtoken.lang.Classes
getContentType() - Method in interface io.jsonwebtoken.Header: Returns the cty (Content Type) header value or null if not present.
getDescription() - Method in enum io.jsonwebtoken.SignatureAlgorithm: Returns the JWA algorithm description.
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.
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: Returns the cryptographic family name of the signature algorithm.
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.
getHeader() - Method in exception io.jsonwebtoken.ClaimJwtException
getHeader() - Method in interface io.jsonwebtoken.Jwt: Returns the JWT Header or null if not present.
getId() - Method in interface io.jsonwebtoken.Claims: Returns the JWTs jti (JWT ID) value or null if not present.
getIdentityHexString(Object) - Static method in class io.jsonwebtoken.lang.Objects: Return a hex String form of an object's identity hash code.
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.
getJcaName() - Method in enum io.jsonwebtoken.SignatureAlgorithm: Returns the name of the JCA algorithm used to compute the signature.
getKeyId() - Method in interface io.jsonwebtoken.JwsHeader: Returns the JWS kid (Key ID) header value or null if not present.
getMinKeyLength() - Method in enum io.jsonwebtoken.SignatureAlgorithm: 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.
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).
getSignature() - Method in interface io.jsonwebtoken.Jws
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.
getValue() - Method in enum io.jsonwebtoken.SignatureAlgorithm: Returns the JWA algorithm name constant.
GZIP - Static variable in class io.jsonwebtoken.CompressionCodecs: Codec implementing the gzip compression algorithm.

H

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(String, 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<T extends Header<T>> - Interface in io.jsonwebtoken: A JWT JOSE header.
header() - Static method in class io.jsonwebtoken.Jwts: Creates a new Header instance suitable for plaintext (not digitally signed) JWTs.
header(Map<String, Object>) - Static method in class io.jsonwebtoken.Jwts: Creates a new Header instance suitable for plaintext (not digitally signed) JWTs, populated with the specified name/value pairs.
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.

I

ID - Static variable in interface io.jsonwebtoken.Claims: JWT JWT ID claims parameter name: "jti"
identityToString(Object) - Static method in class io.jsonwebtoken.lang.Objects: Return a String representation of an object's overall identity.
INCORRECT_EXPECTED_CLAIM_MESSAGE_TEMPLATE - Static variable in exception io.jsonwebtoken.ClaimJwtException
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) - Constructor for exception io.jsonwebtoken.IncorrectClaimException
IncorrectClaimException(Header, Claims, String, Throwable) - Constructor for exception io.jsonwebtoken.IncorrectClaimException
instantiate(Constructor<T>, Object...) - Static method in class io.jsonwebtoken.lang.Classes
InstantiationException - Exception in io.jsonwebtoken.lang
InstantiationException(String, Throwable) - Constructor for exception io.jsonwebtoken.lang.InstantiationException
InvalidClaimException - Exception in io.jsonwebtoken: Exception indicating a parsed claim is invalid in some way.
InvalidClaimException(Header, Claims, String) - Constructor for exception io.jsonwebtoken.InvalidClaimException
InvalidClaimException(Header, Claims, String, Throwable) - Constructor for exception io.jsonwebtoken.InvalidClaimException
InvalidKeyException - Exception in io.jsonwebtoken.security
InvalidKeyException(String) - Constructor for exception io.jsonwebtoken.security.InvalidKeyException
invokeStatic(String, String, Class[], Object...) - Static method in class io.jsonwebtoken.lang.Classes
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
IOException(String) - Constructor for exception io.jsonwebtoken.io.IOException
IOException(String, Throwable) - Constructor for exception io.jsonwebtoken.io.IOException
isArray(Object) - Static method in class io.jsonwebtoken.lang.Objects: Determine whether the given object is an array: either an Object array or a primitive array.
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
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: 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: Determine whether the given array is empty: i.e.
isEmpty(byte[]) - Static method in class io.jsonwebtoken.lang.Objects: Returns true if the specified byte array is null or of zero length, false otherwise.
isHmac() - Method in enum io.jsonwebtoken.SignatureAlgorithm: Returns true if the enum instance represents an HMAC signature algorithm, false otherwise.
isInstanceOf(Class, Object) - Static method in class io.jsonwebtoken.lang.Assert: Assert that the provided object is an instance of the provided class.
isInstanceOf(Class, 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: 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 .
isRsa() - Method in enum io.jsonwebtoken.SignatureAlgorithm: Returns true if the enum instance represents an RSA public/private key pair signature algorithm, false otherwise.
isSigned(String) - 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"
ISSUER - Static variable in interface io.jsonwebtoken.Claims: JWT Issuer claims parameter name: "iss"
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.

J

JSON_WEB_KEY - Static variable in interface io.jsonwebtoken.JwsHeader: JWS JSON Web Key header parameter name: "jwk"
JWK_SET_URL - Static variable in interface io.jsonwebtoken.JwsHeader: JWS JWT Set URL header parameter name: "jku"
Jws<B> - Interface in io.jsonwebtoken: An expanded (not compact/serialized) Signed JSON Web Token.
JwsHeader<T extends JwsHeader<T>> - Interface in io.jsonwebtoken: A JWS header.
jwsHeader() - Static method in class io.jsonwebtoken.Jwts: Returns a new JwsHeader instance suitable for digitally signed JWTs (aka 'JWS's).
jwsHeader(Map<String, Object>) - Static method in class io.jsonwebtoken.Jwts: Returns a new JwsHeader instance suitable for digitally signed JWTs (aka 'JWS's), populated with the specified name/value pairs.
Jwt<H extends Header,B> - Interface in io.jsonwebtoken: An expanded (not compact/serialized) JSON Web Token.
JWT_TYPE - Static variable in interface io.jsonwebtoken.Header: JWT Type (typ) value: "JWT"
JwtBuilder - Interface in io.jsonwebtoken: A builder for constructing JWTs.
JwtException - Exception in io.jsonwebtoken: Base class for JWT-related runtime exceptions.
JwtException(String) - Constructor for exception io.jsonwebtoken.JwtException
JwtException(String, Throwable) - Constructor for exception io.jsonwebtoken.JwtException
JwtHandler<T> - Interface in io.jsonwebtoken: A JwtHandler is invoked by a JwtParser after parsing a JWT to indicate the exact type of JWT or JWS parsed.
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
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.

K

KEY_ID - Static variable in interface io.jsonwebtoken.JwsHeader: JWS Key ID header parameter name: "kid"
KeyException - Exception in io.jsonwebtoken.security
KeyException(String) - Constructor for exception io.jsonwebtoken.security.KeyException
keyPairFor(SignatureAlgorithm) - Static method in class io.jsonwebtoken.security.Keys: Returns a new KeyPair suitable for use with the specified asymmetric algorithm.
Keys - Class in io.jsonwebtoken.security: Utility class for securely generating SecretKeys and KeyPairs.

L

length(byte[]) - Static method in class io.jsonwebtoken.lang.Arrays

M

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
MalformedJwtException(String, Throwable) - Constructor for exception io.jsonwebtoken.MalformedJwtException
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.
MISSING_EXPECTED_CLAIM_MESSAGE_TEMPLATE - Static variable in exception io.jsonwebtoken.ClaimJwtException
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) - Constructor for exception io.jsonwebtoken.MissingClaimException
MissingClaimException(Header, Claims, String, Throwable) - Constructor for exception io.jsonwebtoken.MissingClaimException

N

newInstance(String) - Static method in class io.jsonwebtoken.lang.Classes
newInstance(String, Class[], Object...) - Static method in class io.jsonwebtoken.lang.Classes
newInstance(String, Object...) - Static method in class io.jsonwebtoken.lang.Classes
newInstance(Class<T>) - Static method in class io.jsonwebtoken.lang.Classes
newInstance(Class<T>, Object...) - Static method in class io.jsonwebtoken.lang.Classes
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"
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
notEmpty(Collection, 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(Map, 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(Object, 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.
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
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.
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
of(K, V) - Static method in class io.jsonwebtoken.lang.Maps: Creates a new map builder with a single entry.
onClaimsJws(Jws<Claims>) - Method in interface io.jsonwebtoken.JwtHandler: 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: 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
onPlaintextJws(Jws<String>) - Method in interface io.jsonwebtoken.JwtHandler: This method is invoked when a JwtParser determines that the parsed JWT is a plaintext JWS.
onPlaintextJws(Jws<String>) - Method in class io.jsonwebtoken.JwtHandlerAdapter
onPlaintextJwt(Jwt<Header, String>) - Method in interface io.jsonwebtoken.JwtHandler: This method is invoked when a JwtParser determines that the parsed JWT is a plaintext JWT.
onPlaintextJwt(Jwt<Header, String>) - Method in class io.jsonwebtoken.JwtHandlerAdapter

P

parse(String) - 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 or JWS instance.

parse(String, JwtHandler<T>) - Method in interface io.jsonwebtoken.JwtParser

Parses the specified compact serialized JWT string based on the builder's current configuration state and invokes the specified handler with the resulting JWT or JWS instance.

parseClaimsJws(String) - Method in interface io.jsonwebtoken.JwtParser

Parses the specified compact serialized JWS string based on the builder's current configuration state and returns the resulting Claims JWS instance.

parseClaimsJwt(String) - 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 unsigned plaintext JWT instance.

parseIso8601Date(String) - Static method in class io.jsonwebtoken.lang.DateFormats

parseLocaleString(String) - Static method in class io.jsonwebtoken.lang.Strings

Parse the given localeString value into a Locale.

parsePlaintextJws(String) - Method in interface io.jsonwebtoken.JwtParser

Parses the specified compact serialized JWS string based on the builder's current configuration state and returns the resulting plaintext JWS instance.

parsePlaintextJwt(String) - 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 unsigned plaintext JWT instance.

parser() - Static method in class io.jsonwebtoken.Jwts

Deprecated.

use Jwts.parserBuilder() instead. See JwtParserBuilder for usage details.
Migration to new method structure is minimal, for example:
Old code:
Jwts.parser() .requireAudience("string") .parse(jwtString)

New code:
Jwts.parserBuilder() .requireAudience("string") .build() .parse(jwtString)

NOTE: this method will be removed before version 1.0

parserBuilder() - Static method in class io.jsonwebtoken.Jwts

Returns a new JwtParserBuilder instance that can be configured to create an immutable/thread-safe {@link JwtParser).

pathEquals(String, String) - Static method in class io.jsonwebtoken.lang.Strings

Compare two paths after normalization of them.

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

PrematureJwtException(Header, Claims, String, Throwable) - Constructor for exception io.jsonwebtoken.PrematureJwtException

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

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 occurences of a substring within a string with another string.
require(String, Object) - Method in interface io.jsonwebtoken.JwtParser: Deprecated.
see JwtParserBuilder.require(String, Object). To construct a JwtParser use the corresponding builder via Jwts.parserBuilder(). This will construct an immutable JwtParser.
NOTE: this method will be removed before version 1.0
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.JwtParser: Deprecated.
see JwtParserBuilder.requireAudience(String). To construct a JwtParser use the corresponding builder via Jwts.parserBuilder(). This will construct an immutable JwtParser.
NOTE: this method will be removed before version 1.0
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 Claims.get(String, Class) is called and the value does not match the type of the Class argument.
RequiredTypeException(String) - Constructor for exception io.jsonwebtoken.RequiredTypeException
RequiredTypeException(String, Throwable) - Constructor for exception io.jsonwebtoken.RequiredTypeException
requireExpiration(Date) - Method in interface io.jsonwebtoken.JwtParser: Deprecated.
see JwtParserBuilder.requireExpiration(Date). To construct a JwtParser use the corresponding builder via Jwts.parserBuilder(). This will construct an immutable JwtParser.
NOTE: this method will be removed before version 1.0
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.JwtParser: Deprecated.
see JwtParserBuilder.requireId(String). To construct a JwtParser use the corresponding builder via Jwts.parserBuilder(). This will construct an immutable JwtParser.
NOTE: this method will be removed before version 1.0
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.JwtParser: Deprecated.
see JwtParserBuilder.requireIssuedAt(Date). To construct a JwtParser use the corresponding builder via Jwts.parserBuilder(). This will construct an immutable JwtParser.
NOTE: this method will be removed before version 1.0
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.JwtParser: Deprecated.
see JwtParserBuilder.requireIssuer(String). To construct a JwtParser use the corresponding builder via Jwts.parserBuilder(). This will construct an immutable JwtParser.
NOTE: this method will be removed before version 1.0
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.JwtParser: Deprecated.
see JwtParserBuilder.requireNotBefore(Date). To construct a JwtParser use the corresponding builder via Jwts.parserBuilder(). This will construct an immutable JwtParser.
NOTE: this method will be removed before version 1.0
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.JwtParser: Deprecated.
see JwtParserBuilder.requireSubject(String). To construct a JwtParser use the corresponding builder via Jwts.parserBuilder(). This will construct an immutable JwtParser.
NOTE: this method will be removed before version 1.0
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: 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: 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, String) - Method in interface io.jsonwebtoken.SigningKeyResolver: Returns the signing key that should be used to validate a digital signature for the Plaintext JWS with the specified header and plaintext payload.
resolveSigningKey(JwsHeader, Claims) - Method in class io.jsonwebtoken.SigningKeyResolverAdapter
resolveSigningKey(JwsHeader, String) - Method in class io.jsonwebtoken.SigningKeyResolverAdapter
resolveSigningKeyBytes(JwsHeader, Claims) - Method in class io.jsonwebtoken.SigningKeyResolverAdapter: Convenience method invoked by SigningKeyResolverAdapter.resolveSigningKey(JwsHeader, Claims) that obtains the necessary signing key bytes.
resolveSigningKeyBytes(JwsHeader, String) - Method in class io.jsonwebtoken.SigningKeyResolverAdapter: Convenience method invoked by SigningKeyResolverAdapter.resolveSigningKey(JwsHeader, String) that obtains the necessary signing key bytes.
RuntimeEnvironment - Class in io.jsonwebtoken.lang

S

secretKeyFor(SignatureAlgorithm) - Static method in class io.jsonwebtoken.security.Keys: Returns a new SecretKey with a key length suitable for use with the specified SignatureAlgorithm.
SecurityException - Exception in io.jsonwebtoken.security
SecurityException(String) - Constructor for exception io.jsonwebtoken.security.SecurityException
SecurityException(String, Throwable) - Constructor for exception io.jsonwebtoken.security.SecurityException
SEPARATOR_CHAR - Static variable in interface io.jsonwebtoken.JwtParser
SerialException - Exception in io.jsonwebtoken.io
SerialException(String) - Constructor for exception io.jsonwebtoken.io.SerialException
SerialException(String, Throwable) - Constructor for exception io.jsonwebtoken.io.SerialException
SerializationException - Exception in io.jsonwebtoken.io
SerializationException(String) - Constructor for exception io.jsonwebtoken.io.SerializationException
SerializationException(String, Throwable) - Constructor for exception io.jsonwebtoken.io.SerializationException
serialize(T) - Method in interface io.jsonwebtoken.io.Serializer
Serializer<T> - Interface in io.jsonwebtoken.io
serializeToJsonWith(Serializer<Map<String, ?>>) - Method in interface io.jsonwebtoken.JwtBuilder: Performs object-to-JSON serialization with the specified Serializer.
setAlgorithm(String) - Method in interface io.jsonwebtoken.JwsHeader: Sets the JWT alg (Algorithm) header value.
setAllowedClockSkewSeconds(long) - Method in interface io.jsonwebtoken.JwtParser: Deprecated.
see JwtParserBuilder.setAllowedClockSkewSeconds(long). To construct a JwtParser use the corresponding builder via Jwts.parserBuilder(). This will construct an immutable JwtParser.
NOTE: this method will be removed before version 1.0
setAllowedClockSkewSeconds(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.
setAudience(String) - Method in interface io.jsonwebtoken.Claims: Sets the JWT aud (audience) value.
setAudience(String) - Method in interface io.jsonwebtoken.ClaimsMutator: Sets the JWT aud (audience) value.
setAudience(String) - Method in interface io.jsonwebtoken.JwtBuilder: Sets the JWT Claims aud (audience) value.
setClaimName(String) - Method in exception io.jsonwebtoken.InvalidClaimException
setClaims(Claims) - Method in interface io.jsonwebtoken.JwtBuilder: Sets the JWT payload to be a JSON Claims instance.
setClaims(Map<String, ?>) - Method in interface io.jsonwebtoken.JwtBuilder: Sets the JWT payload to be a JSON Claims instance populated by the specified name/value pairs.
setClaimValue(Object) - Method in exception io.jsonwebtoken.InvalidClaimException
setClock(Clock) - Method in interface io.jsonwebtoken.JwtParser: Deprecated.
see JwtParserBuilder.setClock(Clock). To construct a JwtParser use the corresponding builder via Jwts.parserBuilder(). This will construct an immutable JwtParser.
NOTE: this method will be removed before version 1.0
setClock(Clock) - Method in interface io.jsonwebtoken.JwtParserBuilder: Sets the Clock that determines the timestamp to use when validating the parsed JWT.
setCompressionAlgorithm(String) - Method in interface io.jsonwebtoken.Header: Sets the JWT zip (Compression Algorithm) header parameter value.
setCompressionCodecResolver(CompressionCodecResolver) - Method in interface io.jsonwebtoken.JwtParser: Deprecated.
see JwtParserBuilder.setCompressionCodecResolver(CompressionCodecResolver). To construct a JwtParser use the corresponding builder via Jwts.parserBuilder(). This will construct an immutable JwtParser.
NOTE: this method will be removed before version 1.0
setCompressionCodecResolver(CompressionCodecResolver) - Method in interface io.jsonwebtoken.JwtParserBuilder: Sets the CompressionCodecResolver used to acquire the CompressionCodec that should be used to decompress the JWT body.
setContentType(String) - Method in interface io.jsonwebtoken.Header: Sets the JWT cty (Content Type) header parameter value.
setExpiration(Date) - Method in interface io.jsonwebtoken.Claims: Sets the JWT exp (expiration) timestamp.
setExpiration(Date) - Method in interface io.jsonwebtoken.ClaimsMutator: Sets the JWT exp (expiration) timestamp.
setExpiration(Date) - Method in interface io.jsonwebtoken.JwtBuilder: Sets the JWT Claims exp (expiration) value.
setHeader(Header) - Method in interface io.jsonwebtoken.JwtBuilder: Sets (and replaces) any existing header with the specified header.
setHeader(Map<String, Object>) - Method in interface io.jsonwebtoken.JwtBuilder: Sets (and replaces) any existing header with the specified header.
setHeaderParam(String, Object) - Method in interface io.jsonwebtoken.JwtBuilder: Applies the specified name/value pair to the header.
setHeaderParams(Map<String, Object>) - Method in interface io.jsonwebtoken.JwtBuilder: Applies the specified name/value pairs to the header.
setId(String) - Method in interface io.jsonwebtoken.Claims: Sets the JWT jti (JWT ID) value.
setId(String) - Method in interface io.jsonwebtoken.ClaimsMutator: Sets the JWT jti (JWT ID) value.
setId(String) - Method in interface io.jsonwebtoken.JwtBuilder: Sets the JWT Claims jti (JWT ID) value.
setIssuedAt(Date) - Method in interface io.jsonwebtoken.Claims: Sets the JWT iat (issued at) timestamp.
setIssuedAt(Date) - Method in interface io.jsonwebtoken.ClaimsMutator: Sets the JWT iat (issued at) timestamp.
setIssuedAt(Date) - Method in interface io.jsonwebtoken.JwtBuilder: Sets the JWT Claims iat (issued at) value.
setIssuer(String) - Method in interface io.jsonwebtoken.Claims: Sets the JWT iss (issuer) value.
setIssuer(String) - Method in interface io.jsonwebtoken.ClaimsMutator: Sets the JWT iss (issuer) value.
setIssuer(String) - Method in interface io.jsonwebtoken.JwtBuilder: Sets the JWT Claims iss (issuer) value.
setKeyId(String) - Method in interface io.jsonwebtoken.JwsHeader: Sets the JWT kid (Key ID) header value.
setNotBefore(Date) - Method in interface io.jsonwebtoken.Claims: Sets the JWT nbf (not before) timestamp.
setNotBefore(Date) - Method in interface io.jsonwebtoken.ClaimsMutator: Sets the JWT nbf (not before) timestamp.
setNotBefore(Date) - Method in interface io.jsonwebtoken.JwtBuilder: Sets the JWT Claims nbf (not before) value.
setPayload(String) - Method in interface io.jsonwebtoken.JwtBuilder: Sets the JWT's payload to be a plaintext (non-JSON) string.
setSigningKey(byte[]) - Method in interface io.jsonwebtoken.JwtParser: Deprecated.
see JwtParserBuilder.setSigningKey(byte[]). To construct a JwtParser use the corresponding builder via Jwts.parserBuilder(). This will construct an immutable JwtParser.
NOTE: this method will be removed before version 1.0
setSigningKey(String) - Method in interface io.jsonwebtoken.JwtParser: Deprecated.
see JwtParserBuilder.setSigningKey(String). To construct a JwtParser use the corresponding builder via Jwts.parserBuilder(). This will construct an immutable JwtParser.
NOTE: this method will be removed before version 1.0
setSigningKey(Key) - Method in interface io.jsonwebtoken.JwtParser: Deprecated.
see JwtParserBuilder.setSigningKey(Key). To construct a JwtParser use the corresponding builder via Jwts.parserBuilder(). This will construct an immutable JwtParser.
NOTE: this method will be removed before version 1.0
setSigningKey(byte[]) - Method in interface io.jsonwebtoken.JwtParserBuilder: Sets the signing key used to verify any discovered JWS digital signature.
setSigningKey(String) - Method in interface io.jsonwebtoken.JwtParserBuilder: Sets the signing key used to verify any discovered JWS digital signature.
setSigningKey(Key) - Method in interface io.jsonwebtoken.JwtParserBuilder: Sets the signing key used to verify any discovered JWS digital signature.
setSigningKeyResolver(SigningKeyResolver) - Method in interface io.jsonwebtoken.JwtParser: Deprecated.
see JwtParserBuilder.setSigningKeyResolver(SigningKeyResolver). To construct a JwtParser use the corresponding builder via Jwts.parserBuilder(). This will construct an immutable JwtParser.
NOTE: this method will be removed before version 1.0
setSigningKeyResolver(SigningKeyResolver) - Method in interface io.jsonwebtoken.JwtParserBuilder: Sets the SigningKeyResolver used to acquire the signing key that should be used to verify a JWS's signature.
setSubject(String) - Method in interface io.jsonwebtoken.Claims: Sets the JWT sub (subject) value.
setSubject(String) - Method in interface io.jsonwebtoken.ClaimsMutator: Sets the JWT sub (subject) value.
setSubject(String) - Method in interface io.jsonwebtoken.JwtBuilder: Sets the JWT Claims sub (subject) value.
setType(String) - Method in interface io.jsonwebtoken.Header: Sets the JWT typ (Type) header value.
SignatureAlgorithm - Enum in io.jsonwebtoken: Type-safe representation of standard JWT signature algorithm names as defined in the JSON Web Algorithms specification.
SignatureException - Exception in io.jsonwebtoken.security
SignatureException(String) - Constructor for exception io.jsonwebtoken.security.SignatureException
SignatureException(String, Throwable) - Constructor for exception io.jsonwebtoken.security.SignatureException
SignatureException - Exception in io.jsonwebtoken: Deprecated.
in favor of SecurityException; this class will be removed before 1.0
SignatureException(String) - Constructor for exception io.jsonwebtoken.SignatureException: Deprecated.
SignatureException(String, Throwable) - Constructor for exception io.jsonwebtoken.SignatureException: Deprecated.
SigningKeyResolver - Interface in io.jsonwebtoken: A SigningKeyResolver can be used by a JwtParser to find a signing key that should be used to verify a JWS signature.
SigningKeyResolverAdapter - Class in io.jsonwebtoken: An Adapter implementation of the SigningKeyResolver interface that allows subclasses to process only the type of JWS body that is known/expected for a particular case.
SigningKeyResolverAdapter() - Constructor for class io.jsonwebtoken.SigningKeyResolverAdapter
signWith(Key) - Method in interface io.jsonwebtoken.JwtBuilder: Signs the constructed JWT with the specified key using the key's recommended signature algorithm, 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, SignatureAlgorithm). 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, SignatureAlgorithm) instead. This method will be removed in the 1.0 release.
signWith(Key, SignatureAlgorithm) - Method in interface io.jsonwebtoken.JwtBuilder: Signs the constructed JWT with the specified key using the specified algorithm, producing a JWS.
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: Test if the given String starts with the specified prefix, ignoring upper/lower case.
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.
Strings - Class in io.jsonwebtoken.lang
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"
substringMatch(CharSequence, int, CharSequence) - Static method in class io.jsonwebtoken.lang.Strings: Test whether the given string matches the given substring at the given index.

T

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.
toIterator(Enumeration<E>) - Static method in class io.jsonwebtoken.lang.Collections: Adapt an enumeration to an iterator.
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.
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).
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.
trimAllWhitespace(String) - Static method in class io.jsonwebtoken.lang.Strings: Trim all whitespace from the given String: leading, trailing, and inbetween 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 occurences 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 occurences 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: JWT Type header parameter name: "typ"

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.
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
UnsupportedJwtException(String, Throwable) - Constructor for exception io.jsonwebtoken.UnsupportedJwtException
UTF_8 - Static variable in class io.jsonwebtoken.lang.Strings

V

valueOf(String) - Static method in enum io.jsonwebtoken.SignatureAlgorithm: Returns the enum constant of this type with the specified name.
values() - Static method in enum io.jsonwebtoken.SignatureAlgorithm: Returns an array containing the constants of this enum type, in the order they are declared.

W

WeakKeyException - Exception in io.jsonwebtoken.security
WeakKeyException(String) - Constructor for exception io.jsonwebtoken.security.WeakKeyException

X

X509_CERT_CHAIN - Static variable in interface io.jsonwebtoken.JwsHeader: JWS X.509 Certificate Chain header parameter name: "x5c"
X509_CERT_SHA1_THUMBPRINT - Static variable in interface io.jsonwebtoken.JwsHeader: JWS X.509 Certificate SHA-1 Thumbprint header parameter name: "x5t"
X509_CERT_SHA256_THUMBPRINT - Static variable in interface io.jsonwebtoken.JwsHeader: JWS X.509 Certificate SHA-256 Thumbprint header parameter name: "x5t#S256"
X509_URL - Static variable in interface io.jsonwebtoken.JwsHeader: JWS X.509 URL header parameter name: "x5u"

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