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

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.
Assertions.Context - Interface in org.soulwing.jwt.api
A context for evaluation assertions on claims.
assertSatisfied(Claims, Assertions.Context) - Method in interface org.soulwing.jwt.api.Assertions
Asserts that these assertions are satisfied by the given claims.
assertSatisfied(Claims, Assertions.Context) - Method in class org.soulwing.jwt.api.BiPredicateAssertions
 
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.
build() - Method in class org.soulwing.jwt.api.KeyInfo.Builder
Builds and returns an instance according to the configuration of this builder.
build() - Method in class org.soulwing.jwt.api.locator.JcaPublicKeyLocator.Builder
 
build() - Method in class org.soulwing.jwt.api.locator.JcaX509CertificateValidator.Builder
Creates a new validator in accordance with the configuration of this builder.
build() - Method in class org.soulwing.jwt.api.PublicKeyInfo.Builder
Builds an instance according to the configuration of this builder.
build() - Method in interface org.soulwing.jwt.api.PublicKeyLocator.Builder
Builds a locator in accordance with the configuration of this builder.
builder() - Static method in class org.soulwing.jwt.api.BiPredicateAssertions
Gets a builder for a new instance.
builder() - Static method in class org.soulwing.jwt.api.KeyInfo
Creates a builder that constructs a new instance.
builder() - Static method in class org.soulwing.jwt.api.locator.JcaPublicKeyLocator
Gets a builder that builds a new locator.
builder() - Static method in class org.soulwing.jwt.api.locator.JcaX509CertificateValidator
Gets a builder that creates a new instance.
builder() - Static method in class org.soulwing.jwt.api.PublicKeyInfo
Creates a builder that will build a new instance.

C

CertificateChainLoader - Interface in org.soulwing.jwt.api.locator
A service that loads a certificate chain from a URL.
CertificateException - Exception in org.soulwing.jwt.api.exceptions
An exception thrown when a JCA error occurs in handling a certificate or certificate chain.
CertificateException(String) - Constructor for exception org.soulwing.jwt.api.exceptions.CertificateException
 
CertificateException(Throwable) - Constructor for exception org.soulwing.jwt.api.exceptions.CertificateException
 
certificates(List<X509Certificate>) - Method in class org.soulwing.jwt.api.KeyInfo.Builder
Specifies a list of certificates associated with this key.
certificates(List<X509Certificate>) - Method in class org.soulwing.jwt.api.PublicKeyInfo.Builder
Specifies certificates that will be added to the public key info.
CertificateSubjectNameAssertionException - Exception in org.soulwing.jwt.api.exceptions
An exception thrown when the subject name on a certificate does not satisfy an assertion.
CertificateSubjectNameAssertionException(String) - Constructor for exception org.soulwing.jwt.api.exceptions.CertificateSubjectNameAssertionException
 
certificateUrl(URI) - Method in class org.soulwing.jwt.api.KeyInfo.Builder
Specifies a URL from which certificates associated with this key may be retrieved.
CertificateValidationException - Exception in org.soulwing.jwt.api.exceptions
An exception thrown by a PublicKeyLocator if the certificate to be used in validating a signature fails validation; e.g.
CertificateValidationException(String) - Constructor for exception org.soulwing.jwt.api.exceptions.CertificateValidationException
 
CertificateValidationException(String, Throwable) - Constructor for exception org.soulwing.jwt.api.exceptions.CertificateValidationException
 
certificateValidator(X509CertificateValidator) - Method in class org.soulwing.jwt.api.locator.JcaPublicKeyLocator.Builder
 
certificateValidator(X509CertificateValidator) - Method in interface org.soulwing.jwt.api.PublicKeyLocator.Builder
Specifies the certificate validator.
certificateValidatorFactory(X509CertificateValidator.Factory) - Method in class org.soulwing.jwt.api.locator.JcaPublicKeyLocator.Builder
 
certificateValidatorFactory(X509CertificateValidator.Factory) - Method in interface org.soulwing.jwt.api.PublicKeyLocator.Builder
Specifies the certificate validator factory.
chainLoader(CertificateChainLoader) - Method in class org.soulwing.jwt.api.locator.JcaPublicKeyLocator.Builder
 
checkExpiration(boolean) - Method in class org.soulwing.jwt.api.locator.JcaX509CertificateValidator.Builder
Specifies whether certificate expiration status should be checked.
checkRevocation(boolean) - Method in class org.soulwing.jwt.api.locator.JcaX509CertificateValidator.Builder
Specifies whether certificate revocation status should be checked.
checkSubjectOnly(boolean) - Method in class org.soulwing.jwt.api.locator.JcaX509CertificateValidator.Builder
Specifies whether status checks should only be applied to the subject certificate.
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.
clock(Clock) - Method in class org.soulwing.jwt.api.locator.JcaX509CertificateValidator.Builder
Specifies the clock to use as the basis for validity checks.
compressionAlgorithm(JWE.CompressionAlgorithm) - Method in interface org.soulwing.jwt.api.JWE.Builder
Sets the compression algorithm.
ContainsAssertionException - Exception in org.soulwing.jwt.api.exceptions
An exception thrown when assertion about a multi-valued claim containing a particular value is not satisfied.
ContainsAssertionException(String, List<?>, Object, Object...) - Constructor for exception org.soulwing.jwt.api.exceptions.ContainsAssertionException
 
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.
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.
encryptionOperator(JWE) - Method in interface org.soulwing.jwt.api.JWTValidator.Builder
Specifies the JWE operator to use for decryption operations.
encryptionOperatorFactory(JWE.Factory) - Method in interface org.soulwing.jwt.api.JWTValidator.Builder
Specifies the JWE operator factory that will be used to produce operators for decryption operations.
EqualsAssertionException - Exception in org.soulwing.jwt.api.exceptions
An exception thrown when an assertion that a claim must equal a value or one of a collection of values is not satisfied.
EqualsAssertionException(String, Object, Object, Object...) - Constructor for exception org.soulwing.jwt.api.exceptions.EqualsAssertionException
 
EXP - Static variable in interface org.soulwing.jwt.api.Claims
 
ExpirationAssertionException - Exception in org.soulwing.jwt.api.exceptions
An exception thrown when an assertion about the expiration of a token has failed.
ExpirationAssertionException(Instant, Instant, Duration) - Constructor for exception org.soulwing.jwt.api.exceptions.ExpirationAssertionException
 
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
 
getAlgorithm() - Method in interface org.soulwing.jwt.api.JWS.Header
Gets the value of the algorithm header (alg)
getAudience() - Method in interface org.soulwing.jwt.api.Claims
Gets the value of the "aud" claim.
getCertificateChain() - Method in interface org.soulwing.jwt.api.JoseHeader
Gets the value of the certificate chain header (x5c)
getCertificateChain() - Method in interface org.soulwing.jwt.api.PublicKeyLocator.Criteria
Gets the value of the x5c header.
getCertificateChainUrl() - Method in interface org.soulwing.jwt.api.JoseHeader
Gets the value of the certificate chain URL header (x5u)
getCertificateChainUrl() - Method in interface org.soulwing.jwt.api.PublicKeyLocator.Criteria
Gets the value of the x5u header.
getCertificates() - Method in class org.soulwing.jwt.api.KeyInfo
Gets the list of certificates associated with the key.
getCertificates() - Method in class org.soulwing.jwt.api.PublicKeyInfo
Gets the chain of certificates associated with the public key, if any
getCertificateSha1Fingerprint() - Method in interface org.soulwing.jwt.api.JoseHeader
Gets the value of the certificate SHA1 fingerprint header (x5t)
getCertificateSha256Fingerprint() - Method in interface org.soulwing.jwt.api.JoseHeader
Gets the value of the certificate SHA256 fingerprint header (x5t#256)
getCertificateThumbprint() - Method in interface org.soulwing.jwt.api.PublicKeyLocator.Criteria
Gets an object that can be used to match values of the x5t and x5t#S256 headers.
getCertificateUrl() - Method in class org.soulwing.jwt.api.KeyInfo
Gets the URL from which certificates associated with the key may be retrieved.
getClock() - Method in interface org.soulwing.jwt.api.Assertions.Context
Gets the reference clock for assertions on time values.
getCompressionAlgorithm() - Method in interface org.soulwing.jwt.api.JWE.Header
Gets the value of the compression algorithm header (zip)
getContentEncryptionAlgorithm() - Method in interface org.soulwing.jwt.api.JWE.Header
Gets the value of the content encryption algorithm header (enc)
getContentType() - Method in interface org.soulwing.jwt.api.JoseHeader
Gets the value of the content type header (cty)
getCritical() - Method in interface org.soulwing.jwt.api.JoseHeader
Gets the value of the critical header (crit)
getDefaultInstance() - Static method in class org.soulwing.jwt.api.locator.PemCertificateChainLoader
 
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.KeyInfo
Gets the ID specified for this 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.
getJsonWebKey() - Method in interface org.soulwing.jwt.api.JoseHeader
Gets the value of the JSON web key header (jwk)
getJsonWebKeyUrl() - Method in interface org.soulwing.jwt.api.JoseHeader
Gets the value of the JSON web key URL header (jku)
getKey() - Method in interface org.soulwing.jwt.api.JWK
Gets the JCA key that corresponds to this web key.
getKey() - Method in class org.soulwing.jwt.api.KeyInfo
Gets the subject key.
getKeyBitLength() - Method in enum org.soulwing.jwt.api.JWS.Algorithm
 
getKeyId() - Method in interface org.soulwing.jwt.api.JoseHeader
Gets the value of the key ID header (kid)
getKeyId() - Method in interface org.soulwing.jwt.api.PublicKeyLocator.Criteria
Gets the value of the kid header.
getKeyManagementAlgorithm() - Method in interface org.soulwing.jwt.api.JWE.Header
Gets the value of the key management algorithm header (alg)
getOperator(JWE.Header) - Method in interface org.soulwing.jwt.api.JWE.Factory
Gets an operator appropriate for use with an encrypted JWT with the specified header claims.
getOperator(JWS.Header) - Method in interface org.soulwing.jwt.api.JWS.Factory
Gets an operator appropriate for use with a signed JWT with the specified header claims.
getPayload() - Method in interface org.soulwing.jwt.api.JWS.Result
Gets the payload whose signature was verified.
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).
getPublicKey() - Method in class org.soulwing.jwt.api.PublicKeyInfo
Gets the subject public key.
getPublicKeyInfo() - Method in interface org.soulwing.jwt.api.Assertions.Context
Public key information for the public key used to verify the signature.
getPublicKeyInfo() - Method in interface org.soulwing.jwt.api.JWS.Result
Public key information for the public key used to verify the signature.
getSubject() - Method in interface org.soulwing.jwt.api.Claims
Gets the value of the "sub" claim.
getType() - Method in interface org.soulwing.jwt.api.JoseHeader
Gets the value of the type header (typ)
getValidator(PublicKeyLocator.Criteria, List<X509Certificate>) - Method in interface org.soulwing.jwt.api.X509CertificateValidator.Factory
Gets a validator appropriate to the given public key criteria and the certificate chain derived from it.
getWebKey() - Method in interface org.soulwing.jwt.api.PublicKeyLocator.Criteria
Gets the value of the jwk header.
getWebKeyUrl() - Method in interface org.soulwing.jwt.api.PublicKeyLocator.Criteria
Gets the value of the jku header.

H

header(String) - Method in class org.soulwing.jwt.api.jose4j.Jose4jProvider
 
header(String) - Method in interface org.soulwing.jwt.api.JWTProvider
Parses the JOSE header from a JWT in compacted encoding form.

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.
id(String) - Method in class org.soulwing.jwt.api.KeyInfo.Builder
Specifies an identifier for this key.
IdAssertionException - Exception in org.soulwing.jwt.api.exceptions
An exception thrown when an assertion about the JTI claim is not satisfied.
IdAssertionException() - Constructor for exception org.soulwing.jwt.api.exceptions.IdAssertionException
 
IdAssertionException(String) - Constructor for exception org.soulwing.jwt.api.exceptions.IdAssertionException
 
InstantAssertionException - Exception in org.soulwing.jwt.api.exceptions
An exception thrown when an assertion about an instant in time is not satisfied.
InstantAssertionException(Instant, Instant, BiFunction<Instant, Instant, String>) - Constructor for exception org.soulwing.jwt.api.exceptions.InstantAssertionException
 
InvalidSignatureException - Exception in org.soulwing.jwt.api.exceptions
An exception thrown when a signature validation fails.
InvalidSignatureException(JWS.Algorithm) - Constructor for exception org.soulwing.jwt.api.exceptions.InvalidSignatureException
 
isAsymmetric() - Method in enum org.soulwing.jwt.api.JWS.Algorithm
 
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

JcaPublicKeyLocator - Class in org.soulwing.jwt.api.locator
A PublicKeyLocator implemented using the JCA.
JcaPublicKeyLocator.Builder - Class in org.soulwing.jwt.api.locator
 
JcaX509CertificateValidator - Class in org.soulwing.jwt.api.locator
A X509CertificateValidator implemented using a JCA PKIX path builder.
JcaX509CertificateValidator.Builder - Class in org.soulwing.jwt.api.locator
A builder that produces a JcaX509CertificateValidator.
Jose4jProvider - Class in org.soulwing.jwt.api.jose4j
A JWTProvider implemented using Jose4j.
Jose4jProvider() - Constructor for class org.soulwing.jwt.api.jose4j.Jose4jProvider
 
JoseHeader - Interface in org.soulwing.jwt.api
JOSE header fields for JWE and JWS.
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.Factory - Interface in org.soulwing.jwt.api
A factory that produces JWE operator instances.
JWE.Header - Interface in org.soulwing.jwt.api
A JWE JOSE header.
JWE.KeyManagementAlgorithm - Enum in org.soulwing.jwt.api
JWE key management algorithms.
JWK - Interface in org.soulwing.jwt.api
A JSON Web Key.
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.
JWS.Factory - Interface in org.soulwing.jwt.api
A factory that produces JWS operator instances.
JWS.Header - Interface in org.soulwing.jwt.api
A JWS JOSE header.
JWS.Result - Interface in org.soulwing.jwt.api
A signature verification result.
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(String) - Constructor for exception org.soulwing.jwt.api.exceptions.JWTParseException
 
JWTParseException(Throwable) - Constructor for exception org.soulwing.jwt.api.exceptions.JWTParseException
 
JWTParseException(String, 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
 
JWTProviderNotFoundException - Exception in org.soulwing.jwt.api.exceptions
A JWT runtime exception.
JWTProviderNotFoundException() - Constructor for exception org.soulwing.jwt.api.exceptions.JWTProviderNotFoundException
 
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

key(Key) - Method in class org.soulwing.jwt.api.KeyInfo.Builder
Specifies the key itself.
KeyInfo - Class in org.soulwing.jwt.api
A key and optional associated information.
KeyInfo.Builder - Class in org.soulwing.jwt.api
A builder that constructs a KeyInfo instance.
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.
KeyProviderException - Exception in org.soulwing.jwt.api.exceptions
An exception thrown when a checked exception is thrown in the implementation of a KeyProvider.
KeyProviderException(String) - Constructor for exception org.soulwing.jwt.api.exceptions.KeyProviderException
 
KeyProviderException(Throwable) - Constructor for exception org.soulwing.jwt.api.exceptions.KeyProviderException
 
KeyProviderException(String, Throwable) - Constructor for exception org.soulwing.jwt.api.exceptions.KeyProviderException
 

L

LifetimeAssertionException - Exception in org.soulwing.jwt.api.exceptions
An exception thrown when an assertion about the lifetime of a token has failed.
LifetimeAssertionException(Instant, Instant, Duration) - Constructor for exception org.soulwing.jwt.api.exceptions.LifetimeAssertionException
 
load(URI) - Method in interface org.soulwing.jwt.api.locator.CertificateChainLoader
 
load(URI) - Method in class org.soulwing.jwt.api.locator.PemCertificateChainLoader
 
locate(PublicKeyLocator.Criteria) - Method in class org.soulwing.jwt.api.locator.JcaPublicKeyLocator
 
locate(PublicKeyLocator.Criteria) - Method in interface org.soulwing.jwt.api.PublicKeyLocator
Locates the public key described by the given criteria, if possible.

M

matcher() - Method in interface org.soulwing.jwt.api.PublicKeyLocator.Thumbprint
Gets a predicate that tests whether this thumbprint matches a given certificate

N

names() - Method in interface org.soulwing.jwt.api.Claims
Gets the set of names for claims in this collection.
newProvider(ClassLoader) - Static method in class org.soulwing.jwt.api.JWTProviderLocator
Gets a JWT provider.

O

of(String) - Static method in enum org.soulwing.jwt.api.JWE.CompressionAlgorithm
 
of(String) - Static method in enum org.soulwing.jwt.api.JWE.ContentEncryptionAlgorithm
 
of(String) - Static method in enum org.soulwing.jwt.api.JWE.KeyManagementAlgorithm
 
of(String) - Static method in enum org.soulwing.jwt.api.JWS.Algorithm
 
openStream(URI) - Method in class org.soulwing.jwt.api.locator.PemCertificateChainLoader
 
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
 
org.soulwing.jwt.api.locator - package org.soulwing.jwt.api.locator
 

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.
PemCertificateChainLoader - Class in org.soulwing.jwt.api.locator
A CertificateChainLoader that loads PEM-encoded certificates.
PemCertificateChainLoader() - Constructor for class org.soulwing.jwt.api.locator.PemCertificateChainLoader
 
publicKey(PublicKey) - Method in class org.soulwing.jwt.api.PublicKeyInfo.Builder
Specifies the subject public key.
PublicKeyInfo - Class in org.soulwing.jwt.api
A PublicKey and associated information.
PublicKeyInfo.Builder - Class in org.soulwing.jwt.api
A builder that creates a PublicKeyInfo instance.
publicKeyLocator(PublicKeyLocator) - Method in interface org.soulwing.jwt.api.JWS.Builder
Sets the public key locator to use for signature validation.
PublicKeyLocator - Interface in org.soulwing.jwt.api
A service provider that locates a public key given criteria from a JOSE header.
PublicKeyLocator.Builder - Interface in org.soulwing.jwt.api
A builder that creates a PublicKeyLocator.
PublicKeyLocator.Criteria - Interface in org.soulwing.jwt.api
Criteria for a public key search as obtained from the JOSE header.
PublicKeyLocator.StrategyType - Enum in org.soulwing.jwt.api
An enumeration of strategy types for locating public keys.
PublicKeyLocator.Thumbprint - Interface in org.soulwing.jwt.api
An object that encapsulates the algorithms and matching operations for certificate thumbprints provided in the JOSE header.
PublicKeyNotFoundException - Exception in org.soulwing.jwt.api.exceptions
An exception thrown by a PublicKeyLocator to indicate that no public key matching given criteria could be found.
PublicKeyNotFoundException() - Constructor for exception org.soulwing.jwt.api.exceptions.PublicKeyNotFoundException
 

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>, Function<List, JWTAssertionFailedException>) - Method in interface org.soulwing.jwt.api.Assertions.Builder
Requires an claim whose value satisfies the given condition.
requireAudienceSatisfies(Predicate<List>, Function<List, JWTAssertionFailedException>) - Method in class org.soulwing.jwt.api.BiPredicateAssertions.Builder
 
requireCertificateSubjectMatches(String) - Method in interface org.soulwing.jwt.api.Assertions.Builder
Requires that the certificate associated with a public key that was used to verify the signature has a subject name that exactly matches the given subject name.
requireCertificateSubjectMatches(String) - Method in class org.soulwing.jwt.api.BiPredicateAssertions.Builder
 
requireCertificateSubjectMatchesIssuer() - Method in interface org.soulwing.jwt.api.Assertions.Builder
Requires that the certificate associated with a public key that was used to verify the signature has a subject name that exactly matches the value of the claim.
requireCertificateSubjectMatchesIssuer() - 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>, BiFunction<Instant, Clock, JWTAssertionFailedException>) - Method in interface org.soulwing.jwt.api.Assertions.Builder
Requires a claim whose value satisfies the specified condition.
requireExpirationSatisfies(BiPredicate<Instant, Clock>, BiFunction<Instant, Clock, JWTAssertionFailedException>) - 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>, Function<String, JWTAssertionFailedException>) - Method in interface org.soulwing.jwt.api.Assertions.Builder
Requires a claim that satisfies the given condition.
requireIdSatisfies(Predicate<String>, Function<String, JWTAssertionFailedException>) - Method in class org.soulwing.jwt.api.BiPredicateAssertions.Builder
 
requireInstantSatisfies(String, BiPredicate<Instant, Clock>, BiFunction<Instant, Clock, JWTAssertionFailedException>) - 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>, BiFunction<Instant, Clock, JWTAssertionFailedException>) - Method in class org.soulwing.jwt.api.BiPredicateAssertions.Builder
 
requireIssuedAtSatisfies(BiPredicate<Instant, Clock>, BiFunction<Instant, Clock, JWTAssertionFailedException>) - Method in interface org.soulwing.jwt.api.Assertions.Builder
Requires a claim whose value satisfies the specified condition.
requireIssuedAtSatisfies(BiPredicate<Instant, Clock>, BiFunction<Instant, Clock, JWTAssertionFailedException>) - 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>, Function<String, JWTAssertionFailedException>) - Method in interface org.soulwing.jwt.api.Assertions.Builder
Requires a claim whose value satisfies the given condition.
requireIssuerSatisfies(Predicate<String>, Function<String, JWTAssertionFailedException>) - 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
 
requirePublicKeyInfoSatisfies(String, BiPredicate<String, PublicKeyInfo>, BiFunction<String, PublicKeyInfo, JWTAssertionFailedException>) - Method in interface org.soulwing.jwt.api.Assertions.Builder
Requires that the public key info for a public key used to verify the signature satisfies the given condition.
requirePublicKeyInfoSatisfies(Predicate<PublicKeyInfo>, Function<PublicKeyInfo, JWTAssertionFailedException>) - Method in interface org.soulwing.jwt.api.Assertions.Builder
Requires that the public key info for a public key used to verify the signature satisfies the given condition.
requirePublicKeyInfoSatisfies(String, BiPredicate<String, PublicKeyInfo>, BiFunction<String, PublicKeyInfo, JWTAssertionFailedException>) - Method in class org.soulwing.jwt.api.BiPredicateAssertions.Builder
 
requirePublicKeyInfoSatisfies(Predicate<PublicKeyInfo>, Function<PublicKeyInfo, JWTAssertionFailedException>) - Method in class org.soulwing.jwt.api.BiPredicateAssertions.Builder
 
requireSatisfies(String, Class<? extends T>, Predicate<T>, Function<T, JWTAssertionFailedException>) - 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>, Function<T, JWTAssertionFailedException>) - 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>, Function<String, JWTAssertionFailedException>) - Method in interface org.soulwing.jwt.api.Assertions.Builder
Requires a claim whose value satisfies the given condition.
requireSubjectSatisfies(Predicate<String>, Function<String, JWTAssertionFailedException>) - 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, Object...) - 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() - 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.
signatureOperator(JWS) - Method in interface org.soulwing.jwt.api.JWTValidator.Builder
Sets the JWS operator to use for signature validation operations.
signatureOperatorFactory(JWS.Factory) - Method in interface org.soulwing.jwt.api.JWTValidator.Builder
Specifies the JWS operator factory that will be used to produce operators for decryption operations.
SingletonKeyProvider - Class in org.soulwing.jwt.api
A KeyProvider that holds a single key.
strategies(Set<PublicKeyLocator.StrategyType>) - Method in class org.soulwing.jwt.api.locator.JcaPublicKeyLocator.Builder
 
strategies(Set<PublicKeyLocator.StrategyType>) - Method in interface org.soulwing.jwt.api.PublicKeyLocator.Builder
Locator strategies to enable; by default all strategies are considered in the order given in the PublicKeyLocator.StrategyType enumeration.
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

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
 
trustStore(KeyStore) - Method in class org.soulwing.jwt.api.locator.JcaX509CertificateValidator.Builder
Specifies the trust store.
TypeMismatchAssertionException - Exception in org.soulwing.jwt.api.exceptions
An exception thrown when an assertion fails due to a mismatch between the expected type and actual type for the value of a claim.
TypeMismatchAssertionException(String) - Constructor for exception org.soulwing.jwt.api.exceptions.TypeMismatchAssertionException
 

U

UndefinedValueAssertionException - Exception in org.soulwing.jwt.api.exceptions
An exception thrown when an assertion on a claim value is not satisfied because the value is undefined.
UndefinedValueAssertionException(String) - Constructor for exception org.soulwing.jwt.api.exceptions.UndefinedValueAssertionException
 

V

validate(String) - Method in interface org.soulwing.jwt.api.JWTValidator
Validates a JWT.
validate(List<X509Certificate>) - Method in class org.soulwing.jwt.api.locator.JcaX509CertificateValidator
 
validate(List<X509Certificate>) - Method in interface org.soulwing.jwt.api.X509CertificateValidator
Validates the given chain of certificates.
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.
valueOf(String) - Static method in enum org.soulwing.jwt.api.PublicKeyLocator.StrategyType
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.
values() - Static method in enum org.soulwing.jwt.api.PublicKeyLocator.StrategyType
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.

X

X509CertificateValidator - Interface in org.soulwing.jwt.api
An X.509 certificate validator
X509CertificateValidator.Factory - Interface in org.soulwing.jwt.api
A factory for a X509CertificateValidator.
A B C D E G H I J K L M N O P R S T U V W X 
Skip navigation links

Copyright © 2019. All rights reserved.