Skip navigation links
A B C D E G I J K N O P R S T V W 

A

algorithm(JWS.Algorithm) - Method in interface org.soulwing.jwt.api.JWS.Builder
Sets the algorithm to use for signature generation of validation.
Assertions - Interface in org.soulwing.jwt.api
A specification of assertions for JWT claims.
assertions() - Method in class org.soulwing.jwt.api.jose4j.Jose4jProvider
 
assertions() - Method in interface org.soulwing.jwt.api.JWTProvider
Gets a builder that will produce an Assertions instance.
Assertions.Builder - Interface in org.soulwing.jwt.api
A builder that constructs assertions for claims.
AUD - Static variable in interface org.soulwing.jwt.api.Claims
 
audience(String, String...) - Method in interface org.soulwing.jwt.api.Claims.Builder
Specifies a value for the claim.
audiences() - Method in interface org.soulwing.jwt.api.Claims
Gets an optional list of values for the "aud".

B

BiPredicateAssertions - Class in org.soulwing.jwt.api
An Assertions implementation that evaluates a list of BiPredicate lambdas.
BiPredicateAssertions() - Constructor for class org.soulwing.jwt.api.BiPredicateAssertions
 
BiPredicateAssertions.Builder - Class in org.soulwing.jwt.api
 
build() - Method in interface org.soulwing.jwt.api.Assertions.Builder
Creates a new assertions object using the configuration of this builder.
build() - Method in class org.soulwing.jwt.api.BiPredicateAssertions.Builder
 
build() - Method in interface org.soulwing.jwt.api.Claims.Builder
Creates a Claims instance using the configuration of this builder.
build() - Method in interface org.soulwing.jwt.api.JWE.Builder
Creates a JSON Web Encryption operator using the configuration of this builder.
build() - Method in interface org.soulwing.jwt.api.JWS.Builder
Creates a JSON Web Signature operator using the configuration of this builder.
build() - Method in interface org.soulwing.jwt.api.JWTGenerator.Builder
Creates a generator using the configuration of this builder.
build() - Method in interface org.soulwing.jwt.api.JWTValidator.Builder
Creates a validator using the configuration of this builder.
builder() - Static method in class org.soulwing.jwt.api.BiPredicateAssertions
Gets a builder for a new instance.

C

claim(String, Class<? extends T>) - Method in interface org.soulwing.jwt.api.Claims
Gets an optional value for arbitrary claim.
Claims - Interface in org.soulwing.jwt.api
An immutable value type representing a map of named values for a JWT payload.
claims() - Method in class org.soulwing.jwt.api.jose4j.Jose4jProvider
 
claims() - Method in interface org.soulwing.jwt.api.JWTProvider
Gets a builder that will produce a Claims instance.
Claims.Builder - Interface in org.soulwing.jwt.api
 
claimsAssertions(Assertions) - Method in interface org.soulwing.jwt.api.JWTValidator.Builder
Sets assertions to be tested on claims.
clock(Clock) - Method in interface org.soulwing.jwt.api.JWTValidator.Builder
Sets the reference clock to use for assertions on time values.
compressionAlgorithm(JWE.CompressionAlgorithm) - Method in interface org.soulwing.jwt.api.JWE.Builder
Sets the compression algorithm.
contentEncryptionAlgorithm(JWE.ContentEncryptionAlgorithm) - Method in interface org.soulwing.jwt.api.JWE.Builder
Sets the content encryption algorithm.
contentType(String) - Method in interface org.soulwing.jwt.api.JWE.Builder
Sets the value for the cty header value.
currentKey() - Method in interface org.soulwing.jwt.api.KeyProvider
Gets the current key to use for signature or encryption operations.
currentKey() - Method in class org.soulwing.jwt.api.SingletonKeyProvider
Gets the current key to use for signature or encryption operations.

D

decrypt(String) - Method in interface org.soulwing.jwt.api.JWE
Validates a JWE in Compact Serialization and extracts the encapsulated payload.
decryption(JWE) - Method in interface org.soulwing.jwt.api.JWTValidator.Builder
Sets the JWE operator to use for decryption operations.
DecryptionKeyNotFoundException - Exception in org.soulwing.jwt.api.exceptions
An exception thrown when a decryption operation fails because the key needed was not found.
DecryptionKeyNotFoundException(String) - Constructor for exception org.soulwing.jwt.api.exceptions.DecryptionKeyNotFoundException
 

E

encrypt(String) - Method in interface org.soulwing.jwt.api.JWE
Creates a JWE in Compact Serialization encoding using the given payload.
encryption(JWE) - Method in interface org.soulwing.jwt.api.JWTGenerator.Builder
Sets the JWE operator to use for encryption operations.
encryptionOperator() - Method in class org.soulwing.jwt.api.jose4j.Jose4jProvider
 
encryptionOperator() - Method in interface org.soulwing.jwt.api.JWTProvider
Gets a builder that will produce a JWE operator instance.
EXP - Static variable in interface org.soulwing.jwt.api.Claims
 
expiresAt(Instant) - Method in interface org.soulwing.jwt.api.Claims.Builder
Specifies a value for the claim.
expiresAt() - Method in interface org.soulwing.jwt.api.Claims
Gets an optional value for "exp" claim.

G

generate(Claims) - Method in interface org.soulwing.jwt.api.JWTGenerator
Generates a signed and optionally encrypted JWT.
generator() - Method in class org.soulwing.jwt.api.jose4j.Jose4jProvider
 
generator() - Method in interface org.soulwing.jwt.api.JWTProvider
Gets a builder that will produce a JWTGenerator instance.
get(String, Class<? extends T>) - Method in interface org.soulwing.jwt.api.Claims
 
getAudience() - Method in interface org.soulwing.jwt.api.Claims
Gets the value of the "aud" claim.
getExpiresAt() - Method in interface org.soulwing.jwt.api.Claims
Gets the value of the "exp" claim.
getId() - Method in interface org.soulwing.jwt.api.Claims
Gets the value of the "jti" claim.
getId() - Method in class org.soulwing.jwt.api.KeyProvider.Tuple
Unique identifier for the key.
getIssuedAt() - Method in interface org.soulwing.jwt.api.Claims
Gets the value of the "iat" claim.
getIssuer() - Method in interface org.soulwing.jwt.api.Claims
Gets the value of the "iss" claim.
getKey() - Method in class org.soulwing.jwt.api.KeyProvider.Tuple
The subject key.
getProvider() - Static method in class org.soulwing.jwt.api.JWTProviderLocator
Gets the default JWT provider using the current thread's context class loader (lazy loading as necessary).
getSubject() - Method in interface org.soulwing.jwt.api.Claims
Gets the value of the "sub" claim.

I

IAT - Static variable in interface org.soulwing.jwt.api.Claims
 
id(String) - Method in interface org.soulwing.jwt.api.Claims.Builder
Specifies a value for the claim.
id() - Method in interface org.soulwing.jwt.api.Claims
Gets an optional value for the "jti" claim.
InvalidSignatureException - Exception in org.soulwing.jwt.api.exceptions
An exception thrown when a signature validation fails.
InvalidSignatureException(JWS.Algorithm, String) - Constructor for exception org.soulwing.jwt.api.exceptions.InvalidSignatureException
 
ISS - Static variable in interface org.soulwing.jwt.api.Claims
 
issuedAt(Instant) - Method in interface org.soulwing.jwt.api.Claims.Builder
Specifies a value for the claim.
issuedAt() - Method in interface org.soulwing.jwt.api.Claims
Gets an optional value for "iat" claim.
issuer(String) - Method in interface org.soulwing.jwt.api.Claims.Builder
Specifies a value for the claim.
issuer() - Method in interface org.soulwing.jwt.api.Claims
Gets an optional value for the "iss" claim.

J

Jose4jProvider - Class in org.soulwing.jwt.api.jose4j
A JWTProvider implemented using Jose4j.
Jose4jProvider() - Constructor for class org.soulwing.jwt.api.jose4j.Jose4jProvider
 
JTI - Static variable in interface org.soulwing.jwt.api.Claims
 
JWE - Interface in org.soulwing.jwt.api
A JSON Web Encryption operator.
JWE.Builder - Interface in org.soulwing.jwt.api
A builder that produces a JWE operator.
JWE.CompressionAlgorithm - Enum in org.soulwing.jwt.api
JWE content compression algorithms
JWE.ContentEncryptionAlgorithm - Enum in org.soulwing.jwt.api
JWE content encryption algorithms.
JWE.KeyManagementAlgorithm - Enum in org.soulwing.jwt.api
JWE key management algorithms.
JWS - Interface in org.soulwing.jwt.api
A JSON Web Signature operator.
JWS.Algorithm - Enum in org.soulwing.jwt.api
An enumeration of standard algorithms for signatures
JWS.Builder - Interface in org.soulwing.jwt.api
A builder for a JSON Web Signature operator.
JWT - Static variable in interface org.soulwing.jwt.api.JWE
The cty header value for JWT content (value "JWT").
JWTAssertionFailedException - Exception in org.soulwing.jwt.api.exceptions
An exception thrown by an Assertions when an assertion is not satisfied.
JWTAssertionFailedException(String) - Constructor for exception org.soulwing.jwt.api.exceptions.JWTAssertionFailedException
 
JWTAssertionFailedException(String, Throwable) - Constructor for exception org.soulwing.jwt.api.exceptions.JWTAssertionFailedException
 
JWTAssertionFailedException(Throwable) - Constructor for exception org.soulwing.jwt.api.exceptions.JWTAssertionFailedException
 
JWTConfigurationException - Exception in org.soulwing.jwt.api.exceptions
An exception thrown by a builder of a JWT provider.
JWTConfigurationException(String) - Constructor for exception org.soulwing.jwt.api.exceptions.JWTConfigurationException
 
JWTConfigurationException(String, Throwable) - Constructor for exception org.soulwing.jwt.api.exceptions.JWTConfigurationException
 
JWTConfigurationException(Throwable) - Constructor for exception org.soulwing.jwt.api.exceptions.JWTConfigurationException
 
JWTEncryptionException - Exception in org.soulwing.jwt.api.exceptions
An exception thrown when a JWT provider encounters an error while performing an encryption operation.
JWTEncryptionException(String) - Constructor for exception org.soulwing.jwt.api.exceptions.JWTEncryptionException
 
JWTEncryptionException(String, Throwable) - Constructor for exception org.soulwing.jwt.api.exceptions.JWTEncryptionException
 
JWTEncryptionException(Throwable) - Constructor for exception org.soulwing.jwt.api.exceptions.JWTEncryptionException
 
JWTException - Exception in org.soulwing.jwt.api.exceptions
An exception thrown by a JWT provider.
JWTException() - Constructor for exception org.soulwing.jwt.api.exceptions.JWTException
 
JWTException(String) - Constructor for exception org.soulwing.jwt.api.exceptions.JWTException
 
JWTException(String, Throwable) - Constructor for exception org.soulwing.jwt.api.exceptions.JWTException
 
JWTException(Throwable) - Constructor for exception org.soulwing.jwt.api.exceptions.JWTException
 
JWTException(String, Throwable, boolean, boolean) - Constructor for exception org.soulwing.jwt.api.exceptions.JWTException
 
JWTGenerator - Interface in org.soulwing.jwt.api
A generator that produces JSON Web Token (JWT) objects.
JWTGenerator.Builder - Interface in org.soulwing.jwt.api
 
JWTGeneratorException - Exception in org.soulwing.jwt.api.exceptions
An exception thrown when a JWT provider encounters an error while performing a JWT generation operation.
JWTGeneratorException(String) - Constructor for exception org.soulwing.jwt.api.exceptions.JWTGeneratorException
 
JWTGeneratorException(String, Throwable) - Constructor for exception org.soulwing.jwt.api.exceptions.JWTGeneratorException
 
JWTGeneratorException(Throwable) - Constructor for exception org.soulwing.jwt.api.exceptions.JWTGeneratorException
 
JWTParseException - Exception in org.soulwing.jwt.api.exceptions
An exception thrown when a JSON representation of a claims object cannot be parsed successfully.
JWTParseException(Throwable) - Constructor for exception org.soulwing.jwt.api.exceptions.JWTParseException
 
JWTProvider - Interface in org.soulwing.jwt.api
A JWT provider.
JWTProviderLocator - Class in org.soulwing.jwt.api
A locator for a JWTProvider.
JWTProviderLocator() - Constructor for class org.soulwing.jwt.api.JWTProviderLocator
 
JWTSignatureException - Exception in org.soulwing.jwt.api.exceptions
An exception thrown when a JWT provider encounters an error while performing a signature operation.
JWTSignatureException(String) - Constructor for exception org.soulwing.jwt.api.exceptions.JWTSignatureException
 
JWTSignatureException(String, Throwable) - Constructor for exception org.soulwing.jwt.api.exceptions.JWTSignatureException
 
JWTSignatureException(Throwable) - Constructor for exception org.soulwing.jwt.api.exceptions.JWTSignatureException
 
JWTValidationException - Exception in org.soulwing.jwt.api.exceptions
An exception thrown when a JWT provider encounters an error while performing a JWT validation.
JWTValidationException(String) - Constructor for exception org.soulwing.jwt.api.exceptions.JWTValidationException
 
JWTValidationException(String, Throwable) - Constructor for exception org.soulwing.jwt.api.exceptions.JWTValidationException
 
JWTValidationException(Throwable) - Constructor for exception org.soulwing.jwt.api.exceptions.JWTValidationException
 
JWTValidator - Interface in org.soulwing.jwt.api
A validator for JSON Web Token (JWT) inputs.
JWTValidator.Builder - Interface in org.soulwing.jwt.api
A builder that produces validator instances.

K

keyManagementAlgorithm(JWE.KeyManagementAlgorithm) - Method in interface org.soulwing.jwt.api.JWE.Builder
Sets the key management algorithm.
keyProvider(KeyProvider) - Method in interface org.soulwing.jwt.api.JWE.Builder
Sets the key provider to use to obtain keys for encryption or decryption operations.
keyProvider(KeyProvider) - Method in interface org.soulwing.jwt.api.JWS.Builder
Sets the key provider to use to obtain keys for signature or validation operations.
KeyProvider - Interface in org.soulwing.jwt.api
A provider for keys used in signature and encipherment operations.
KeyProvider.Tuple - Class in org.soulwing.jwt.api
A tuple containing a key and its (optional) corresponding ID.

N

newProvider(ClassLoader) - Static method in class org.soulwing.jwt.api.JWTProviderLocator
Gets a JWT provider.

O

org.soulwing.jwt.api - package org.soulwing.jwt.api
 
org.soulwing.jwt.api.exceptions - package org.soulwing.jwt.api.exceptions
 
org.soulwing.jwt.api.jose4j - package org.soulwing.jwt.api.jose4j
 

P

parse(String) - Method in class org.soulwing.jwt.api.jose4j.Jose4jProvider
 
parse(String) - Method in interface org.soulwing.jwt.api.JWTProvider
Parses a JSON string to create a Claims instance.

R

requireAudience(String, String...) - Method in interface org.soulwing.jwt.api.Assertions.Builder
Requires an claim whose value is equal to one of the given audiences.
requireAudience(String, String...) - Method in class org.soulwing.jwt.api.BiPredicateAssertions.Builder
 
requireAudienceSatisfies(Predicate<List>) - Method in interface org.soulwing.jwt.api.Assertions.Builder
Requires an claim whose value satisfies the given condition.
requireAudienceSatisfies(Predicate<List>) - Method in class org.soulwing.jwt.api.BiPredicateAssertions.Builder
 
requireContains(String, Object, Object...) - Method in interface org.soulwing.jwt.api.Assertions.Builder
Requires a named claim whose value is an array which contains one of the given values.
requireContains(String, Object, Object...) - Method in class org.soulwing.jwt.api.BiPredicateAssertions.Builder
 
requireEquals(String, Object, Object...) - Method in interface org.soulwing.jwt.api.Assertions.Builder
Requires a named claim whose value is equal to one of the given values.
requireEquals(String, Object, Object...) - Method in class org.soulwing.jwt.api.BiPredicateAssertions.Builder
 
requireExpirationSatisfies(BiPredicate<Instant, Clock>) - Method in interface org.soulwing.jwt.api.Assertions.Builder
Requires a claim whose value satisfies the specified condition.
requireExpirationSatisfies(BiPredicate<Instant, Clock>) - Method in class org.soulwing.jwt.api.BiPredicateAssertions.Builder
 
requireId() - Method in interface org.soulwing.jwt.api.Assertions.Builder
Requires some non-empty value for the claim.
requireId() - Method in class org.soulwing.jwt.api.BiPredicateAssertions.Builder
 
requireIdSatisfies(Predicate<String>) - Method in interface org.soulwing.jwt.api.Assertions.Builder
Requires a claim that satisfies the given condition.
requireIdSatisfies(Predicate<String>) - Method in class org.soulwing.jwt.api.BiPredicateAssertions.Builder
 
requireInstantSatisfies(String, BiPredicate<Instant, Clock>) - Method in interface org.soulwing.jwt.api.Assertions.Builder
Requires a named claim whose numeric value, interpreted as a quantity of seconds from the epoch, satisfies a condition represented as bi-predicate whose arguments are the given instant and a reference clock.
requireInstantSatisfies(String, BiPredicate<Instant, Clock>) - Method in class org.soulwing.jwt.api.BiPredicateAssertions.Builder
 
requireIssuedAtSatisfies(BiPredicate<Instant, Clock>) - Method in interface org.soulwing.jwt.api.Assertions.Builder
Requires a claim whose value satisfies the specified condition.
requireIssuedAtSatisfies(BiPredicate<Instant, Clock>) - Method in class org.soulwing.jwt.api.BiPredicateAssertions.Builder
 
requireIssuer(String, String...) - Method in interface org.soulwing.jwt.api.Assertions.Builder
Requires an claim whose value is equal to one of the given issuers.
requireIssuer(String, String...) - Method in class org.soulwing.jwt.api.BiPredicateAssertions.Builder
 
requireIssuerSatisfies(Predicate<String>) - Method in interface org.soulwing.jwt.api.Assertions.Builder
Requires a claim whose value satisfies the given condition.
requireIssuerSatisfies(Predicate<String>) - Method in class org.soulwing.jwt.api.BiPredicateAssertions.Builder
 
requireLifetimeNotExceeded(Duration) - Method in interface org.soulwing.jwt.api.Assertions.Builder
Requires a claim whose value is after the current time of a reference clock less the given lifetime duration.
requireLifetimeNotExceeded(Duration) - Method in class org.soulwing.jwt.api.BiPredicateAssertions.Builder
 
requireNotExpired(Duration) - Method in interface org.soulwing.jwt.api.Assertions.Builder
Requires an claim whose value is after the current time of a reference clock, less the given tolerance to allow for clock skew.
requireNotExpired(Duration) - Method in class org.soulwing.jwt.api.BiPredicateAssertions.Builder
 
requireSatisfies(String, Class<? extends T>, Predicate<T>) - Method in interface org.soulwing.jwt.api.Assertions.Builder
Requires a named claim whose value satisfies the given condition.
requireSatisfies(String, Class<? extends T>, Predicate<T>) - Method in class org.soulwing.jwt.api.BiPredicateAssertions.Builder
 
requireSubject(String, String...) - Method in interface org.soulwing.jwt.api.Assertions.Builder
Requires a claim whose value is equal to one of the given subjects.
requireSubject(String, String...) - Method in class org.soulwing.jwt.api.BiPredicateAssertions.Builder
 
requireSubjectSatisfies(Predicate<String>) - Method in interface org.soulwing.jwt.api.Assertions.Builder
Requires a claim whose value satisfies the given condition.
requireSubjectSatisfies(Predicate<String>) - Method in class org.soulwing.jwt.api.BiPredicateAssertions.Builder
 
retrieveKey(String) - Method in interface org.soulwing.jwt.api.KeyProvider
Retrieves a key to use for signature validation or decryption operations.
retrieveKey(String) - Method in class org.soulwing.jwt.api.SingletonKeyProvider
Retrieves the singleton key.

S

set(String, String) - Method in interface org.soulwing.jwt.api.Claims.Builder
Specifies a value for an arbitrary claim.
set(String, Number) - Method in interface org.soulwing.jwt.api.Claims.Builder
Specifies a value for an arbitrary claim.
set(String, Boolean) - Method in interface org.soulwing.jwt.api.Claims.Builder
Specifies a value for an arbitrary claim.
set(String, Object...) - Method in interface org.soulwing.jwt.api.Claims.Builder
Specifies a value for an arbitrary claim.
set(String, Collection<?>) - Method in interface org.soulwing.jwt.api.Claims.Builder
Specifies a value for an arbitrary claim.
sign(String) - Method in interface org.soulwing.jwt.api.JWS
Creates a signed Compact Serialization of a JWS using the given payload.
signature(JWS) - Method in interface org.soulwing.jwt.api.JWTGenerator.Builder
Sets the JWS operator to use for signature operations.
SignatureKeyNotFoundException - Exception in org.soulwing.jwt.api.exceptions
An exception thrown when a signature operation fails because the key needed was not found.
SignatureKeyNotFoundException(String) - Constructor for exception org.soulwing.jwt.api.exceptions.SignatureKeyNotFoundException
 
signatureOperator() - Method in class org.soulwing.jwt.api.jose4j.Jose4jProvider
 
signatureOperator() - Method in interface org.soulwing.jwt.api.JWTProvider
Gets a builder that will produce a JWS operator instance.
signatureValidation(JWS) - Method in interface org.soulwing.jwt.api.JWTValidator.Builder
Sets the JWS operator to use for signature validation operations.
SingletonKeyProvider - Class in org.soulwing.jwt.api
A KeyProvider that holds a single key.
SUB - Static variable in interface org.soulwing.jwt.api.Claims
 
subject(String) - Method in interface org.soulwing.jwt.api.Claims.Builder
Specifies a value for the claim.
subject() - Method in interface org.soulwing.jwt.api.Claims
Gets an optional value for "sub" claim.

T

test(Claims, Clock) - Method in interface org.soulwing.jwt.api.Assertions
Applies these assertions to the given claims.
test(Claims, Clock) - Method in class org.soulwing.jwt.api.BiPredicateAssertions
 
toJson() - Method in interface org.soulwing.jwt.api.Claims
Produces a JSON object representation of this Claims object encoded as a string.
toToken() - Method in enum org.soulwing.jwt.api.JWE.CompressionAlgorithm
 
toToken() - Method in enum org.soulwing.jwt.api.JWE.ContentEncryptionAlgorithm
 
toToken() - Method in enum org.soulwing.jwt.api.JWE.KeyManagementAlgorithm
 
toToken() - Method in enum org.soulwing.jwt.api.JWS.Algorithm
 
Tuple(String, Key) - Constructor for class org.soulwing.jwt.api.KeyProvider.Tuple
 

V

validate(String) - Method in interface org.soulwing.jwt.api.JWTValidator
Validates a JWT.
validator() - Method in class org.soulwing.jwt.api.jose4j.Jose4jProvider
 
validator() - Method in interface org.soulwing.jwt.api.JWTProvider
Gets a builder that will produce a JWTValidator instance.
valueOf(String) - Static method in enum org.soulwing.jwt.api.JWE.CompressionAlgorithm
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.soulwing.jwt.api.JWE.ContentEncryptionAlgorithm
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.soulwing.jwt.api.JWE.KeyManagementAlgorithm
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.soulwing.jwt.api.JWS.Algorithm
Returns the enum constant of this type with the specified name.
values() - Static method in enum org.soulwing.jwt.api.JWE.CompressionAlgorithm
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.soulwing.jwt.api.JWE.ContentEncryptionAlgorithm
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.soulwing.jwt.api.JWE.KeyManagementAlgorithm
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.soulwing.jwt.api.JWS.Algorithm
Returns an array containing the constants of this enum type, in the order they are declared.
verify(String) - Method in interface org.soulwing.jwt.api.JWS
Verifies the signature and extracts the encapsulated payload of a JWS.

W

with(Key) - Static method in class org.soulwing.jwt.api.SingletonKeyProvider
Creates a new instance using the specified key.
with(String, Key) - Static method in class org.soulwing.jwt.api.SingletonKeyProvider
Creates a new instance using the specified key.
A B C D E G I J K N O P R S T V W 
Skip navigation links

Copyright © 2019. All rights reserved.