- capitalize(String) - Static method in class io.jsonwebtoken.lang.Strings
-
- caseInsensitiveValueOf(E[], String) - Static method in class io.jsonwebtoken.lang.Objects
-
- claim(String, Object) - Method in class io.jsonwebtoken.impl.DefaultJwtBuilder
-
- 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
-
- 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.
- clear() - Method in class io.jsonwebtoken.impl.JwtMap
-
- Clock - Interface in io.jsonwebtoken
-
A clock represents a time source that can be used when creating and verifying JWTs.
- 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 class io.jsonwebtoken.impl.DefaultJwtBuilder
-
- compact() - Method in interface io.jsonwebtoken.JwtBuilder
-
- compress(byte[]) - Method in interface io.jsonwebtoken.CompressionCodec
-
Compresses the specified byte array according to the compression
algorithm
.
- compress(byte[]) - Method in class io.jsonwebtoken.impl.compression.AbstractCompressionCodec
-
Asserts that payload is not null and calls
doCompress
- 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
calg
header, and if found, returns the corresponding
CompressionCodec
the parser
can use to decompress the JWT body.
- CompressionCodecs - Class in io.jsonwebtoken
-
- CompressionCodecs - Class in io.jsonwebtoken.impl.compression
-
- 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 class io.jsonwebtoken.impl.DefaultJwtBuilder
-
- compressWith(CompressionCodec) - Method in interface io.jsonwebtoken.JwtBuilder
-
- 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.
- containsKey(Object) - Method in class io.jsonwebtoken.impl.JwtMap
-
- containsValue(Object) - Method in class io.jsonwebtoken.impl.JwtMap
-
- 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.
- createSignatureInstance() - Method in class io.jsonwebtoken.impl.crypto.RsaProvider
-
- createSignatureValidator(SignatureAlgorithm, Key) - Method in class io.jsonwebtoken.impl.crypto.DefaultSignatureValidatorFactory
-
- createSignatureValidator(SignatureAlgorithm, Key) - Method in interface io.jsonwebtoken.impl.crypto.SignatureValidatorFactory
-
- createSignatureValidator(SignatureAlgorithm, Key) - Method in class io.jsonwebtoken.impl.DefaultJwtParser
-
- createSigner(SignatureAlgorithm, Key) - Method in class io.jsonwebtoken.impl.crypto.DefaultSignerFactory
-
- createSigner(SignatureAlgorithm, Key) - Method in interface io.jsonwebtoken.impl.crypto.SignerFactory
-
- createSigner(SignatureAlgorithm, Key) - Method in class io.jsonwebtoken.impl.DefaultJwtBuilder
-
- CRITICAL - Static variable in interface io.jsonwebtoken.JwsHeader
-
JWS Critical
header parameter name: "crit"
- generateKey() - Static method in class io.jsonwebtoken.impl.crypto.MacProvider
-
Generates a new secure-random 512 bit secret key suitable for creating and verifying HMAC signatures.
- generateKey(SignatureAlgorithm) - Static method in class io.jsonwebtoken.impl.crypto.MacProvider
-
Generates a new secure-random secret key of a length suitable for creating and verifying HMAC signatures
according to the specified SignatureAlgorithm
using JJWT's default SecureRandom instance
.
- generateKey(SignatureAlgorithm, SecureRandom) - Static method in class io.jsonwebtoken.impl.crypto.MacProvider
-
Generates a new secure-random secret key of a length suitable for creating and verifying HMAC signatures
according to the specified SignatureAlgorithm
using the specified SecureRandom number generator.
- generateKeyPair() - Static method in class io.jsonwebtoken.impl.crypto.EllipticCurveProvider
-
- generateKeyPair(SignatureAlgorithm) - Static method in class io.jsonwebtoken.impl.crypto.EllipticCurveProvider
-
Generates a new secure-random key pair of sufficient strength for the specified Elliptic Curve
SignatureAlgorithm
(must be one of
ES256
,
ES384
or
ES512
) using JJWT's default
SecureRandom instance
.
- generateKeyPair(SignatureAlgorithm, SecureRandom) - Static method in class io.jsonwebtoken.impl.crypto.EllipticCurveProvider
-
Generates a new secure-random key pair of sufficient strength for the specified Elliptic Curve
SignatureAlgorithm
(must be one of
ES256
,
ES384
or
ES512
) using the specified
SecureRandom
random number generator.
- generateKeyPair(String, String, SignatureAlgorithm, SecureRandom) - Static method in class io.jsonwebtoken.impl.crypto.EllipticCurveProvider
-
Generates a new secure-random key pair of sufficient strength for the specified Elliptic Curve
SignatureAlgorithm
(must be one of
ES256
,
ES384
or
ES512
) using the specified
SecureRandom
random number generator via the specified JCA provider and algorithm name.
- generateKeyPair() - Static method in class io.jsonwebtoken.impl.crypto.RsaProvider
-
Generates a new RSA secure-random 4096 bit key pair.
- generateKeyPair(int) - Static method in class io.jsonwebtoken.impl.crypto.RsaProvider
-
Generates a new RSA secure-randomly key pair of the specified size using JJWT's default SecureRandom instance
.
- generateKeyPair(int, SecureRandom) - Static method in class io.jsonwebtoken.impl.crypto.RsaProvider
-
Generates a new RSA secure-random key pair of the specified size using the given SecureRandom number generator.
- generateKeyPair(String, int, SecureRandom) - Static method in class io.jsonwebtoken.impl.crypto.RsaProvider
-
Generates a new secure-random key pair of the specified size using the specified SecureRandom according to the
specified jcaAlgorithmName
.
- get(String, Class<T>) - Method in interface io.jsonwebtoken.Claims
-
- get(String, Class<T>) - Method in class io.jsonwebtoken.impl.DefaultClaims
-
- get(Object) - Method in class io.jsonwebtoken.impl.JwtMap
-
- getAlgorithm() - Method in class io.jsonwebtoken.impl.DefaultJwsHeader
-
- 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 algorithm name to use as the JWT's calg
header value.
- getAlgorithmName() - Method in class io.jsonwebtoken.impl.compression.DeflateCompressionCodec
-
- getAlgorithmName() - Method in class io.jsonwebtoken.impl.compression.GzipCompressionCodec
-
- getAudience() - Method in interface io.jsonwebtoken.Claims
-
Returns the JWT
aud
(audience) value or
null
if not present.
- getAudience() - Method in class io.jsonwebtoken.impl.DefaultClaims
-
- getBody() - Method in class io.jsonwebtoken.impl.DefaultJws
-
- getBody() - Method in class io.jsonwebtoken.impl.DefaultJwt
-
- 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 calg
(Compression Algorithm) header value or null
if not present.
- getCompressionAlgorithm() - Method in class io.jsonwebtoken.impl.DefaultHeader
-
- 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.
- getContentType() - Method in class io.jsonwebtoken.impl.DefaultHeader
-
- getDate(String) - Method in class io.jsonwebtoken.impl.JwtMap
-
- 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.
- getExpiration() - Method in class io.jsonwebtoken.impl.DefaultClaims
-
- 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 class io.jsonwebtoken.impl.DefaultJws
-
- getHeader() - Method in class io.jsonwebtoken.impl.DefaultJwt
-
- 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.
- getId() - Method in class io.jsonwebtoken.impl.DefaultClaims
-
- 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.
- getIssuedAt() - Method in class io.jsonwebtoken.impl.DefaultClaims
-
- getIssuer() - Method in interface io.jsonwebtoken.Claims
-
Returns the JWT
iss
(issuer) value or
null
if not present.
- getIssuer() - Method in class io.jsonwebtoken.impl.DefaultClaims
-
- getJcaName() - Method in enum io.jsonwebtoken.SignatureAlgorithm
-
Returns the name of the JCA algorithm used to compute the signature.
- getKeyId() - Method in class io.jsonwebtoken.impl.DefaultJwsHeader
-
- getKeyId() - Method in interface io.jsonwebtoken.JwsHeader
-
Returns the JWS
kid
(Key ID) header value or
null
if not present.
- getMacInstance() - Method in class io.jsonwebtoken.impl.crypto.MacSigner
-
- getNotBefore() - Method in interface io.jsonwebtoken.Claims
-
Returns the JWT
nbf
(not before) timestamp or
null
if not present.
- getNotBefore() - Method in class io.jsonwebtoken.impl.DefaultClaims
-
- 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 class io.jsonwebtoken.impl.DefaultJws
-
- getSignature() - Method in interface io.jsonwebtoken.Jws
-
- getSignatureByteArrayLength(SignatureAlgorithm) - Static method in class io.jsonwebtoken.impl.crypto.EllipticCurveProvider
-
Returns the expected signature byte array length (R + S parts) for
the specified ECDSA algorithm.
- getString(String) - Method in class io.jsonwebtoken.impl.JwtMap
-
- getSubject() - Method in interface io.jsonwebtoken.Claims
-
Returns the JWT
sub
(subject) value or
null
if not present.
- getSubject() - Method in class io.jsonwebtoken.impl.DefaultClaims
-
- getSystemProperty(String) - Method in class io.jsonwebtoken.impl.DefaultTextCodecFactory
-
- getTextCodec() - Method in class io.jsonwebtoken.impl.DefaultTextCodecFactory
-
- getTextCodec() - Method in interface io.jsonwebtoken.impl.TextCodecFactory
-
- getType() - Method in interface io.jsonwebtoken.Header
-
Returns the
typ
(type) header value or
null
if not present.
- getType() - Method in class io.jsonwebtoken.impl.DefaultHeader
-
- 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.
- GZIP - Static variable in class io.jsonwebtoken.impl.compression.CompressionCodecs
-
- GzipCompressionCodec - Class in io.jsonwebtoken.impl.compression
-
- GzipCompressionCodec() - Constructor for class io.jsonwebtoken.impl.compression.GzipCompressionCodec
-
- 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
-
- INSTANCE - Static variable in class io.jsonwebtoken.impl.crypto.DefaultSignatureValidatorFactory
-
- INSTANCE - Static variable in class io.jsonwebtoken.impl.crypto.DefaultSignerFactory
-
- INSTANCE - Static variable in class io.jsonwebtoken.impl.DefaultClock
-
Default static instance that may be shared.
- 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
-
- io.jsonwebtoken - package io.jsonwebtoken
-
- io.jsonwebtoken.impl - package io.jsonwebtoken.impl
-
- io.jsonwebtoken.impl.compression - package io.jsonwebtoken.impl.compression
-
- io.jsonwebtoken.impl.crypto - package io.jsonwebtoken.impl.crypto
-
- io.jsonwebtoken.lang - package io.jsonwebtoken.lang
-
- isAndroid() - Method in class io.jsonwebtoken.impl.DefaultTextCodecFactory
-
- 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 signature algorithm, false
otherwise.
- isEmpty() - Method in class io.jsonwebtoken.impl.JwtMap
-
- 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 class io.jsonwebtoken.impl.DefaultJwtParser
-
- 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
.
- isValid(String, String) - Method in class io.jsonwebtoken.impl.crypto.DefaultJwtSignatureValidator
-
- isValid(byte[], byte[]) - Method in class io.jsonwebtoken.impl.crypto.EllipticCurveSignatureValidator
-
- isValid(String, String) - Method in interface io.jsonwebtoken.impl.crypto.JwtSignatureValidator
-
- isValid(byte[], byte[]) - Method in class io.jsonwebtoken.impl.crypto.MacValidator
-
- isValid(byte[], byte[]) - Method in class io.jsonwebtoken.impl.crypto.RsaSignatureValidator
-
- isValid(byte[], byte[]) - Method in interface io.jsonwebtoken.impl.crypto.SignatureValidator
-
- newInstance(String) - 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.
- now() - Method in class io.jsonwebtoken.impl.DefaultClock
-
Simply returns
new Date
()
.
- now() - Method in class io.jsonwebtoken.impl.FixedClock
-
- 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
-
- 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.
- SEPARATOR_CHAR - Static variable in interface io.jsonwebtoken.JwtParser
-
- setAlgorithm(String) - Method in class io.jsonwebtoken.impl.DefaultJwsHeader
-
- setAlgorithm(String) - Method in interface io.jsonwebtoken.JwsHeader
-
Sets the JWT
alg
(Algorithm) header value.
- setAllowedClockSkewSeconds(long) - Method in class io.jsonwebtoken.impl.DefaultJwtParser
-
- setAllowedClockSkewSeconds(long) - Method in interface io.jsonwebtoken.JwtParser
-
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 class io.jsonwebtoken.impl.DefaultClaims
-
- setAudience(String) - Method in class io.jsonwebtoken.impl.DefaultJwtBuilder
-
- 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 class io.jsonwebtoken.impl.DefaultJwtBuilder
-
- setClaims(Map<String, Object>) - Method in class io.jsonwebtoken.impl.DefaultJwtBuilder
-
- setClaims(Claims) - Method in interface io.jsonwebtoken.JwtBuilder
-
Sets the JWT payload to be a JSON Claims instance.
- setClaims(Map<String, Object>) - 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 class io.jsonwebtoken.impl.DefaultJwtParser
-
- setClock(Clock) - Method in interface io.jsonwebtoken.JwtParser
-
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 calg
(Compression Algorithm) header parameter value.
- setCompressionAlgorithm(String) - Method in class io.jsonwebtoken.impl.DefaultHeader
-
- setCompressionCodecResolver(CompressionCodecResolver) - Method in class io.jsonwebtoken.impl.DefaultJwtParser
-
- setCompressionCodecResolver(CompressionCodecResolver) - Method in interface io.jsonwebtoken.JwtParser
-
- setContentType(String) - Method in interface io.jsonwebtoken.Header
-
Sets the JWT
cty
(Content Type) header parameter value.
- setContentType(String) - Method in class io.jsonwebtoken.impl.DefaultHeader
-
- setDate(String, Date) - Method in class io.jsonwebtoken.impl.JwtMap
-
- 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 class io.jsonwebtoken.impl.DefaultClaims
-
- setExpiration(Date) - Method in class io.jsonwebtoken.impl.DefaultJwtBuilder
-
- setExpiration(Date) - Method in interface io.jsonwebtoken.JwtBuilder
-
Sets the JWT Claims
exp
(expiration) value.
- setHeader(Header) - Method in class io.jsonwebtoken.impl.DefaultJwtBuilder
-
- setHeader(Map<String, Object>) - Method in class io.jsonwebtoken.impl.DefaultJwtBuilder
-
- 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 class io.jsonwebtoken.impl.DefaultJwtBuilder
-
- setHeaderParam(String, Object) - Method in interface io.jsonwebtoken.JwtBuilder
-
Applies the specified name/value pair to the header.
- setHeaderParams(Map<String, Object>) - Method in class io.jsonwebtoken.impl.DefaultJwtBuilder
-
- 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 class io.jsonwebtoken.impl.DefaultClaims
-
- setId(String) - Method in class io.jsonwebtoken.impl.DefaultJwtBuilder
-
- 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 class io.jsonwebtoken.impl.DefaultClaims
-
- setIssuedAt(Date) - Method in class io.jsonwebtoken.impl.DefaultJwtBuilder
-
- 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 class io.jsonwebtoken.impl.DefaultClaims
-
- setIssuer(String) - Method in class io.jsonwebtoken.impl.DefaultJwtBuilder
-
- setIssuer(String) - Method in interface io.jsonwebtoken.JwtBuilder
-
Sets the JWT Claims
iss
(issuer) value.
- setKeyId(String) - Method in class io.jsonwebtoken.impl.DefaultJwsHeader
-
- 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 class io.jsonwebtoken.impl.DefaultClaims
-
- setNotBefore(Date) - Method in class io.jsonwebtoken.impl.DefaultJwtBuilder
-
- setNotBefore(Date) - Method in interface io.jsonwebtoken.JwtBuilder
-
Sets the JWT Claims
nbf
(not before) value.
- setParameter(Signature, PSSParameterSpec) - Method in class io.jsonwebtoken.impl.crypto.RsaProvider
-
- setPayload(String) - Method in class io.jsonwebtoken.impl.DefaultJwtBuilder
-
- setPayload(String) - Method in interface io.jsonwebtoken.JwtBuilder
-
Sets the JWT's payload to be a plaintext (non-JSON) string.
- setSigningKey(byte[]) - Method in class io.jsonwebtoken.impl.DefaultJwtParser
-
- setSigningKey(String) - Method in class io.jsonwebtoken.impl.DefaultJwtParser
-
- setSigningKey(Key) - Method in class io.jsonwebtoken.impl.DefaultJwtParser
-
- setSigningKey(byte[]) - Method in interface io.jsonwebtoken.JwtParser
-
Sets the signing key used to verify any discovered JWS digital signature.
- setSigningKey(String) - Method in interface io.jsonwebtoken.JwtParser
-
Sets the signing key used to verify any discovered JWS digital signature.
- setSigningKey(Key) - Method in interface io.jsonwebtoken.JwtParser
-
Sets the signing key used to verify any discovered JWS digital signature.
- setSigningKeyResolver(SigningKeyResolver) - Method in class io.jsonwebtoken.impl.DefaultJwtParser
-
- setSigningKeyResolver(SigningKeyResolver) - Method in interface io.jsonwebtoken.JwtParser
-
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 class io.jsonwebtoken.impl.DefaultClaims
-
- setSubject(String) - Method in class io.jsonwebtoken.impl.DefaultJwtBuilder
-
- 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.
- setType(String) - Method in class io.jsonwebtoken.impl.DefaultHeader
-
- setValue(String, Object) - Method in class io.jsonwebtoken.impl.JwtMap
-
- sign(String) - Method in class io.jsonwebtoken.impl.crypto.DefaultJwtSigner
-
- sign(byte[]) - Method in class io.jsonwebtoken.impl.crypto.EllipticCurveSigner
-
- sign(String) - Method in interface io.jsonwebtoken.impl.crypto.JwtSigner
-
- sign(byte[]) - Method in class io.jsonwebtoken.impl.crypto.MacSigner
-
- sign(byte[]) - Method in class io.jsonwebtoken.impl.crypto.RsaSigner
-
- sign(byte[]) - Method in interface io.jsonwebtoken.impl.crypto.Signer
-
- 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
-
Exception indicating that either calculating a signature or verifying an existing signature of a JWT failed.
- SignatureException(String) - Constructor for exception io.jsonwebtoken.SignatureException
-
- SignatureException(String, Throwable) - Constructor for exception io.jsonwebtoken.SignatureException
-
- SignatureValidator - Interface in io.jsonwebtoken.impl.crypto
-
- SignatureValidatorFactory - Interface in io.jsonwebtoken.impl.crypto
-
- Signer - Interface in io.jsonwebtoken.impl.crypto
-
- SignerFactory - Interface in io.jsonwebtoken.impl.crypto
-
- 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(SignatureAlgorithm, byte[]) - Method in class io.jsonwebtoken.impl.DefaultJwtBuilder
-
- signWith(SignatureAlgorithm, String) - Method in class io.jsonwebtoken.impl.DefaultJwtBuilder
-
- signWith(SignatureAlgorithm, Key) - Method in class io.jsonwebtoken.impl.DefaultJwtBuilder
-
- signWith(SignatureAlgorithm, byte[]) - Method in interface io.jsonwebtoken.JwtBuilder
-
Signs the constructed JWT using the specified algorithm with the specified key, producing a JWS.
- signWith(SignatureAlgorithm, String) - Method in interface io.jsonwebtoken.JwtBuilder
-
Signs the constructed JWT using the specified algorithm with the specified key, producing a JWS.
- signWith(SignatureAlgorithm, Key) - Method in interface io.jsonwebtoken.JwtBuilder
-
Signs the constructed JWT using the specified algorithm with the specified key, producing a JWS.
- size() - Method in class io.jsonwebtoken.impl.JwtMap
-
- 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
-
- 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.
- TextCodec - Interface in io.jsonwebtoken.impl
-
- TextCodecFactory - Interface in io.jsonwebtoken.impl
-
- 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.
- toDate(Object, String) - Static method in class io.jsonwebtoken.impl.JwtMap
-
- toIterator(Enumeration<E>) - Static method in class io.jsonwebtoken.lang.Collections
-
Adapt an enumeration to an iterator.
- toJson(Object) - Method in class io.jsonwebtoken.impl.DefaultJwtBuilder
-
- 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).
- toString() - Method in class io.jsonwebtoken.impl.DefaultJws
-
- toString() - Method in class io.jsonwebtoken.impl.DefaultJwt
-
- toString() - Method in class io.jsonwebtoken.impl.JwtMap
-
- 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.
- transcodeSignatureToConcat(byte[], int) - Static method in class io.jsonwebtoken.impl.crypto.EllipticCurveProvider
-
Transcodes the JCA ASN.1/DER-encoded signature into the concatenated
R + S format expected by ECDSA JWS.
- transcodeSignatureToDER(byte[]) - Static method in class io.jsonwebtoken.impl.crypto.EllipticCurveProvider
-
Transcodes the ECDSA JWS signature into ASN.1/DER format for use by
the JCA verifier.
- 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"