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

A

addClaim(String, Object) - Method in class org.primeframework.jwt.domain.JWT

Add a claim to this JWT.

Algorithm - Enum in org.primeframework.jwt.domain

Available JSON Web Algorithms (JWA) as described in RFC 7518 available for this JWT implementation.

algorithm - Variable in enum org.primeframework.jwt.domain.Algorithm

algorithm - Variable in class org.primeframework.jwt.domain.Header

algorithm - Variable in class org.primeframework.jwt.domain.JSONWebKey

anyGetter() - Method in class org.primeframework.jwt.domain.Header

Special getter used to flatten additional header properties into top level values.

anyGetter() - Method in class org.primeframework.jwt.domain.JWT

Special getter used to flatten the claims into top level properties.

audience - Variable in class org.primeframework.jwt.domain.JWT

Registered Claim aud as defined by RFC 7519 Section 4.1.3.

C

canVerify(Algorithm) - Method in class org.primeframework.jwt.hmac.HMACVerifier

canVerify(Algorithm) - Method in class org.primeframework.jwt.rsa.RSAVerifier

canVerify(Algorithm) - Method in interface org.primeframework.jwt.Verifier

claims - Variable in class org.primeframework.jwt.domain.JWT

D

decode(String, Verifier...) - Method in class org.primeframework.jwt.JWTDecoder

Decode the JWT using one of they provided verifiers.

decode(String, Map<String, Verifier>) - Method in class org.primeframework.jwt.JWTDecoder

Decode the JWT using one of they provided verifiers.

decode(String, Map<String, Verifier>, Function<Header, String>) - Method in class org.primeframework.jwt.JWTDecoder

Decode the JWT using one of they provided verifiers.

decodeCertificate(String) - Static method in class org.primeframework.jwt.rsa.PEMUtils

Decode a PEM encoded certificate, returning only the Base64 encoded string.

deserialize(byte[], Class<T>) - Static method in class org.primeframework.jwt.json.Mapper

deserialize(JsonParser, DeserializationContext) - Method in class org.primeframework.jwt.json.ZonedDateTimeDeserializer

E

encode(JWT, Signer) - Method in class org.primeframework.jwt.JWTEncoder

Encode the JWT to produce a dot separated encoded string that can be sent in an HTTP request header.

encode(JWT, Signer, Consumer<Header>) - Method in class org.primeframework.jwt.JWTEncoder

Encode the JWT to produce a dot separated encoded string that can be sent in an HTTP request header.

encodeCertificate(String) - Static method in class org.primeframework.jwt.rsa.PEMUtils

PEM encode a Base64 encoded string version of a certificate.

encodePrivateKey(PrivateKey) - Static method in class org.primeframework.jwt.rsa.PEMUtils

Return a PEM encoded string representation of the provided PrivateKey.

encodePublicKey(PublicKey) - Static method in class org.primeframework.jwt.rsa.PEMUtils

Return a PEM encoded string representation of the provided PublicKey.

ENCRYPTION - Static variable in class org.primeframework.jwt.domain.PublicKeyUse

equals(Object) - Method in class org.primeframework.jwt.domain.JSONWebKey

equals(Object) - Method in class org.primeframework.jwt.domain.JWT

equals(Object) - Method in class org.primeframework.jwt.domain.RSAKeyPair

expiration - Variable in class org.primeframework.jwt.domain.JWT

Registered Claim exp as defined by RFC 7519 Section 4.1.4.

exponent - Variable in class org.primeframework.jwt.domain.JSONWebKey

The "e" (exponent) parameter contains the exponent value for the RSA public key.

G

generate2048RSAKeyPair() - Static method in class org.primeframework.jwt.JWTUtils

Generate a new public / private key pair using a 2048 bit RSA key.

generate3072RSAKeyPair() - Static method in class org.primeframework.jwt.JWTUtils

Generate a new public / private key pair using a 3072 bit RSA key.

generate4096RSAKeyPair() - Static method in class org.primeframework.jwt.JWTUtils

Generate a new public / private key pair using a 4096 bit RSA key.

generateJWS_x5t(String, String) - Static method in class org.primeframework.jwt.rsa.RSAUtils

Generate the x5t - the X.509 certificate thumbprint to be used in JWT header.

generateJWS_x5t(String) - Static method in class org.primeframework.jwt.rsa.RSAUtils

Generate the x5t - the X.509 certificate thumbprint to be used in JWT header.

generateJWS_x5t(String, byte[]) - Static method in class org.primeframework.jwt.rsa.RSAUtils

Generate the x5t - the X.509 certificate thumbprint to be used in JWT header.

generateJWS_x5t(byte[]) - Static method in class org.primeframework.jwt.rsa.RSAUtils

Generate the x5t - the X.509 certificate thumbprint to be used in JWT header.

generateSHA256HMACSecret() - Static method in class org.primeframework.jwt.JWTUtils

Generate a 32 byte (256 bit) HMAC secret for use with a SHA-256 hash.

generateSHA384HMACSecret() - Static method in class org.primeframework.jwt.JWTUtils

Generate a 48 byte (384 bit) HMAC secret for use with a SHA-384 hash.

generateSHA512HMACSecret() - Static method in class org.primeframework.jwt.JWTUtils

Generate a 64 byte (512 bit) HMAC secret for use with a SHA-512 hash.

get(String) - Method in class org.primeframework.jwt.domain.Header

getAlgorithm() - Method in class org.primeframework.jwt.hmac.HMACSigner

getAlgorithm() - Method in class org.primeframework.jwt.rsa.RSASigner

getAlgorithm() - Method in interface org.primeframework.jwt.Signer

Return the algorithm supported by this signer.

getAlgorithm() - Method in class org.primeframework.jwt.UnsecuredSigner

getBoolean(String) - Method in class org.primeframework.jwt.domain.JWT

getDecoder() - Static method in class org.primeframework.jwt.domain.JWT

Return a singleton instance of the JWT Decoder.

getEncoder() - Static method in class org.primeframework.jwt.domain.JWT

Return a singleton instance of the JWT encoder.

getInstance() - Static method in class org.primeframework.jwt.JWTDecoder

getInstance() - Static method in class org.primeframework.jwt.JWTEncoder

getInteger(String) - Method in class org.primeframework.jwt.domain.JWT

getList(String) - Method in class org.primeframework.jwt.domain.JWT

getLong(String) - Method in class org.primeframework.jwt.domain.JWT

getName() - Method in enum org.primeframework.jwt.domain.Algorithm

getObject(String) - Method in class org.primeframework.jwt.domain.JWT

getPEMFromPrivateKey(PrivateKey) - Static method in class org.primeframework.jwt.rsa.RSAUtils

Return the private key in a PEM formatted String.

getPEMFromPublicKey(PublicKey) - Static method in class org.primeframework.jwt.rsa.RSAUtils

Return the public key in a PEM formatted String.

getPrivateKeyFromPEM(String) - Static method in class org.primeframework.jwt.rsa.RSAUtils

Return a Private Key from the provided private key in PEM format.

getPublicKeyFromPEM(String) - Static method in class org.primeframework.jwt.rsa.RSAUtils

Return a PublicKey from the public key pem string.

getRawClaims() - Method in class org.primeframework.jwt.domain.JWT

getString(String) - Method in class org.primeframework.jwt.domain.JWT

H

hashCode() - Method in class org.primeframework.jwt.domain.JSONWebKey

hashCode() - Method in class org.primeframework.jwt.domain.JWT

hashCode() - Method in class org.primeframework.jwt.domain.RSAKeyPair

Header - Class in org.primeframework.jwt.domain

JSON Object Signing and Encryption (JOSE) Header

Header() - Constructor for class org.primeframework.jwt.domain.Header

Header(Algorithm) - Constructor for class org.primeframework.jwt.domain.Header

HMACSigner - Class in org.primeframework.jwt.hmac

This class can sign and verify a JWT that was signed using HMAC.

HMACVerifier - Class in org.primeframework.jwt.hmac

This class is used to verify a JWT signed with an HMAC algorithm.

I

InvalidJWTException - Exception in org.primeframework.jwt.domain

The JWT could not be parsed properly.

InvalidJWTException(String) - Constructor for exception org.primeframework.jwt.domain.InvalidJWTException

InvalidJWTException(String, Throwable) - Constructor for exception org.primeframework.jwt.domain.InvalidJWTException

InvalidJWTSignatureException - Exception in org.primeframework.jwt.domain

The JWT was properly constructed but the signature is invalid.

InvalidJWTSignatureException() - Constructor for exception org.primeframework.jwt.domain.InvalidJWTSignatureException

InvalidKeyLengthException - Exception in org.primeframework.jwt.domain

The JWT Signer or Verifier is attempting to utilize an RSA Key Length of less than 2048.

InvalidKeyLengthException(String) - Constructor for exception org.primeframework.jwt.domain.InvalidKeyLengthException

isExpired() - Method in class org.primeframework.jwt.domain.JWT

Return true if this JWT is expired.

issuedAt - Variable in class org.primeframework.jwt.domain.JWT

Registered Claim iat as defined by RFC 7519 Section 4.1.6.

issuer - Variable in class org.primeframework.jwt.domain.JWT

Registered Claim iss as defined by RFC 7519 Section 4.1.1.

isUnavailableForProcessing() - Method in class org.primeframework.jwt.domain.JWT

Return true if this JWT is un-available for processing.

J

JacksonModule - Class in org.primeframework.jwt.json

JacksonModule() - Constructor for class org.primeframework.jwt.json.JacksonModule

JSONWebKey - Class in org.primeframework.jwt.domain

A JSON Web Key as defined by RFC 7517 Section 4

JSONWebKey() - Constructor for class org.primeframework.jwt.domain.JSONWebKey

JWT - Class in org.primeframework.jwt.domain

JSON Web Token (JWT) as defined by RFC 7519.

JWT() - Constructor for class org.primeframework.jwt.domain.JWT

JWTDecoder - Class in org.primeframework.jwt

JWTDecoder() - Constructor for class org.primeframework.jwt.JWTDecoder

JWTEncoder - Class in org.primeframework.jwt

JWTEncoder() - Constructor for class org.primeframework.jwt.JWTEncoder

JWTException - Exception in org.primeframework.jwt.domain

Base JWT Exception

JWTException() - Constructor for exception org.primeframework.jwt.domain.JWTException

JWTException(String) - Constructor for exception org.primeframework.jwt.domain.JWTException

JWTException(String, Throwable) - Constructor for exception org.primeframework.jwt.domain.JWTException

JWTExpiredException - Exception in org.primeframework.jwt.domain

The JWT has a valid signature but the JWT is expired.

JWTExpiredException() - Constructor for exception org.primeframework.jwt.domain.JWTExpiredException

JWTUnavailableForProcessingException - Exception in org.primeframework.jwt.domain

The JWT is not yet valid.

JWTUnavailableForProcessingException() - Constructor for exception org.primeframework.jwt.domain.JWTUnavailableForProcessingException

JWTUtils - Class in org.primeframework.jwt

Helper to generate new HMAC secrets or RSA public / private key pairs.

JWTUtils() - Constructor for class org.primeframework.jwt.JWTUtils

K

keyId - Variable in class org.primeframework.jwt.domain.JSONWebKey

keyType - Variable in class org.primeframework.jwt.domain.JSONWebKey

KeyType - Enum in org.primeframework.jwt.domain

Available Cryptographic Algorithms for Keys as described in RFC 7518 Section 6.1.

M

Mapper - Class in org.primeframework.jwt.json

Serialize and de-serialize JWT header and payload.

Mapper() - Constructor for class org.primeframework.jwt.json.Mapper

MissingVerifierException - Exception in org.primeframework.jwt.domain

No Verifier was found that supported the Algorithm used in the JWT.

MissingVerifierException(String) - Constructor for exception org.primeframework.jwt.domain.MissingVerifierException

modulus - Variable in class org.primeframework.jwt.domain.JSONWebKey

The "n" (modulus) parameter contains the modulus value for the RSA public key.

N

newSHA256Signer(String) - Static method in class org.primeframework.jwt.hmac.HMACSigner

newSHA256Signer(String) - Static method in class org.primeframework.jwt.rsa.RSASigner

Build a new RSA signer using a SHA-256 hash.

newSHA384Signer(String) - Static method in class org.primeframework.jwt.hmac.HMACSigner

newSHA384Signer(String) - Static method in class org.primeframework.jwt.rsa.RSASigner

Build a new RSA signer using a SHA-384 hash.

newSHA512Signer(String) - Static method in class org.primeframework.jwt.hmac.HMACSigner

newSHA512Signer(String) - Static method in class org.primeframework.jwt.rsa.RSASigner

Build a new RSA signer using a SHA-512 hash.

newVerifier(String) - Static method in class org.primeframework.jwt.hmac.HMACVerifier

Return a new instance of the HMAC Verifier with the provided secret.

newVerifier(String) - Static method in class org.primeframework.jwt.rsa.RSAVerifier

Return a new instance of the RSA Verifier with the provided public secret.

notBefore - Variable in class org.primeframework.jwt.domain.JWT

Registered Claim nbf as defined by RFC 7519 Section 4.1.5.

O

org.primeframework.jwt - package org.primeframework.jwt

org.primeframework.jwt.domain - package org.primeframework.jwt.domain

org.primeframework.jwt.hmac - package org.primeframework.jwt.hmac

org.primeframework.jwt.json - package org.primeframework.jwt.json

org.primeframework.jwt.rsa - package org.primeframework.jwt.rsa

P

PEMUtils - Class in org.primeframework.jwt.rsa

PEMUtils() - Constructor for class org.primeframework.jwt.rsa.PEMUtils

PKCS_1_PRIVATE_KEY_PREFIX - Static variable in class org.primeframework.jwt.rsa.PEMUtils

PKCS_1_PRIVATE_KEY_SUFFIX - Static variable in class org.primeframework.jwt.rsa.PEMUtils

PKCS_1_PUBLIC_KEY_PREFIX - Static variable in class org.primeframework.jwt.rsa.PEMUtils

PKCS_1_PUBLIC_KEY_SUFFIX - Static variable in class org.primeframework.jwt.rsa.PEMUtils

PKCS_8_PRIVATE_KEY_PREFIX - Static variable in class org.primeframework.jwt.rsa.PEMUtils

PKCS_8_PRIVATE_KEY_SUFFIX - Static variable in class org.primeframework.jwt.rsa.PEMUtils

privateKey - Variable in class org.primeframework.jwt.domain.RSAKeyPair

properties - Variable in class org.primeframework.jwt.domain.Header

publicKey - Variable in class org.primeframework.jwt.domain.RSAKeyPair

PublicKeyUse - Class in org.primeframework.jwt.domain

Public Key Use as defined by RFC 7517 Section 4.2

PublicKeyUse() - Constructor for class org.primeframework.jwt.domain.PublicKeyUse

R

RSAKeyPair - Class in org.primeframework.jwt.domain

RSAKeyPair(String, String) - Constructor for class org.primeframework.jwt.domain.RSAKeyPair

RSASigner - Class in org.primeframework.jwt.rsa

This class can sign a JWT using an RSA Private key.

RSAUtils - Class in org.primeframework.jwt.rsa

RSA Key Helper.

RSAUtils() - Constructor for class org.primeframework.jwt.rsa.RSAUtils

RSAVerifier - Class in org.primeframework.jwt.rsa

This class is used to verify a JWT with an RSA signature using an RSA Public Key.

S

serialize(Object) - Static method in class org.primeframework.jwt.json.Mapper

serialize(ZonedDateTime, JsonGenerator, SerializerProvider) - Method in class org.primeframework.jwt.json.ZonedDateTimeSerializer

set(String, String) - Method in class org.primeframework.jwt.domain.Header

Add a property to the JWT header.

setAudience(Object) - Method in class org.primeframework.jwt.domain.JWT

setExpiration(ZonedDateTime) - Method in class org.primeframework.jwt.domain.JWT

setIssuedAt(ZonedDateTime) - Method in class org.primeframework.jwt.domain.JWT

setIssuer(String) - Method in class org.primeframework.jwt.domain.JWT

setNotBefore(ZonedDateTime) - Method in class org.primeframework.jwt.domain.JWT

setSubject(String) - Method in class org.primeframework.jwt.domain.JWT

setUniqueId(String) - Method in class org.primeframework.jwt.domain.JWT

sign(String) - Method in class org.primeframework.jwt.hmac.HMACSigner

sign(String) - Method in class org.primeframework.jwt.rsa.RSASigner

sign(String) - Method in interface org.primeframework.jwt.Signer

Sign the provided message and return the signature.

sign(String) - Method in class org.primeframework.jwt.UnsecuredSigner

SIGNATURE - Static variable in class org.primeframework.jwt.domain.PublicKeyUse

Signer - Interface in org.primeframework.jwt

JWT Signer.

subject - Variable in class org.primeframework.jwt.domain.JWT

Registered Claim sub as defined by RFC 7519 Section 4.1.2.

T

type - Variable in class org.primeframework.jwt.domain.Header

Type - Enum in org.primeframework.jwt.domain

U

uniqueId - Variable in class org.primeframework.jwt.domain.JWT

Registered Claim jti as defined by RFC 7519 Section 4.1.7.

UnsecuredSigner - Class in org.primeframework.jwt

Unsecured signer.

UnsecuredSigner() - Constructor for class org.primeframework.jwt.UnsecuredSigner

use - Variable in class org.primeframework.jwt.domain.JSONWebKey

V

valueOf(String) - Static method in enum org.primeframework.jwt.domain.Algorithm

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.primeframework.jwt.domain.KeyType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.primeframework.jwt.domain.Type

Returns the enum constant of this type with the specified name.

values() - Static method in enum org.primeframework.jwt.domain.Algorithm

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.primeframework.jwt.domain.KeyType

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.primeframework.jwt.domain.Type

Returns an array containing the constants of this enum type, in the order they are declared.

Verifier - Interface in org.primeframework.jwt

verify(Algorithm, byte[], byte[]) - Method in class org.primeframework.jwt.hmac.HMACVerifier

verify(Algorithm, byte[], byte[]) - Method in class org.primeframework.jwt.rsa.RSAVerifier

verify(Algorithm, byte[], byte[]) - Method in interface org.primeframework.jwt.Verifier

Verify the signature of the encoded JWT payload.

X

X509_CERTIFICATE_PREFIX - Static variable in class org.primeframework.jwt.rsa.PEMUtils

X509_CERTIFICATE_SUFFIX - Static variable in class org.primeframework.jwt.rsa.PEMUtils

X509_PUBLIC_KEY_PREFIX - Static variable in class org.primeframework.jwt.rsa.PEMUtils

X509_PUBLIC_KEY_SUFFIX - Static variable in class org.primeframework.jwt.rsa.PEMUtils

Z

ZonedDateTimeDeserializer - Class in org.primeframework.jwt.json

Jackson de-serializer for the ZonedDateTime class.

ZonedDateTimeDeserializer() - Constructor for class org.primeframework.jwt.json.ZonedDateTimeDeserializer

ZonedDateTimeSerializer - Class in org.primeframework.jwt.json

Jackson serializer for the ZonedDateTime class.

ZonedDateTimeSerializer() - Constructor for class org.primeframework.jwt.json.ZonedDateTimeSerializer

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