Index

A B C D E F G H I J K L N O P R S T U V W X Z
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

A128CBC_HS256 - Enum constant in enum org.forgerock.json.jose.jwe.EncryptionMethod

AES encryption in CBC mode with PKCS5 Padding and a 128 bit length, AES encryption for CEK, HMAC using SHA-256 hash algorithm for authentication tag.

A128GCM - Enum constant in enum org.forgerock.json.jose.jwe.EncryptionMethod

AES encryption in Galois Counter Mode (GCM) with a 128 bit key length.

A128KW - Enum constant in enum org.forgerock.json.jose.jwe.JweAlgorithm

AES-128 KeyWrap.

A192CBC_HS384 - Enum constant in enum org.forgerock.json.jose.jwe.EncryptionMethod

AES encryption in CBC mode with PKCS5 Padding and a 192 bit length, AES encryption for CEK, HMAC using SHA-384 hash algorithm for the authentication tag.

A192GCM - Enum constant in enum org.forgerock.json.jose.jwe.EncryptionMethod

AES encryption in Galois Counter Mode (GCM) with a 192 bit key length.

A192KW - Enum constant in enum org.forgerock.json.jose.jwe.JweAlgorithm

AES-192 KeyWrap.

A256CBC_HS512 - Enum constant in enum org.forgerock.json.jose.jwe.EncryptionMethod

AES encryption in CBC mode with PKCS5 Padding and a 256 bit length, AES encryption for CEK, HMAC using SHA-256 hash algorithm for authentication tag.

A256GCM - Enum constant in enum org.forgerock.json.jose.jwe.EncryptionMethod

AES encryption in Galois Counter Mode (GCM) with a 256 bit key length.

A256KW - Enum constant in enum org.forgerock.json.jose.jwe.JweAlgorithm

AES-256 KeyWrap.

AbstractEncryptionHandler - Class in org.forgerock.json.jose.jwe.handlers.encryption

Deprecated.

Use ContentEncryptionHandler instead.

AbstractEncryptionHandler() - Constructor for class org.forgerock.json.jose.jwe.handlers.encryption.AbstractEncryptionHandler

Deprecated.

AbstractJwtBuilder - Class in org.forgerock.json.jose.builders

A base implementation for all JwtBuilders that provides the basis of the JWT builder methods.

AbstractJwtBuilder() - Constructor for class org.forgerock.json.jose.builders.AbstractJwtBuilder

addAudience(String) - Method in class org.forgerock.json.jose.jwt.JwtClaimsSet

Adds an entry to the JWT's intended audience list, in the Claims Set.

addAudience(URI) - Method in class org.forgerock.json.jose.jwt.JwtClaimsSet

Adds an entry to the JWT's intended audience list, in the Claims Set.

AES_KEYWRAP - Enum constant in enum org.forgerock.json.jose.jwe.JweAlgorithmType

AES KeyWrap.

AESKeyWrapEncryptionHandler - Class in org.forgerock.json.jose.jwe.handlers.encryption

Provides JWE key encapsulation using the AES KeyWrap algorithm.

AESKeyWrapEncryptionHandler(EncryptionMethod) - Constructor for class org.forgerock.json.jose.jwe.handlers.encryption.AESKeyWrapEncryptionHandler

Constructs an AES KeyWrap encryption handler for the given underlying content encryption method.

alg(Algorithm) - Method in class org.forgerock.json.jose.builders.JwtHeaderBuilder

Sets the algorithm used to perform cryptographic signing and/or encryption on the JWT.

ALG - Enum constant in enum org.forgerock.json.jose.jwt.JwtHeaderKey

Algorithm JWT header parameter.

ALG - Static variable in class org.forgerock.json.jose.jwk.JWK

The Algorithm key.

Algorithm - Interface in org.forgerock.json.jose.jwt

The interface for each possible algorithm that can be used to sign and/or encrypt a JWT.

apu(String) - Method in class org.forgerock.json.jose.builders.JweHeaderBuilder

Sets the Agreement PartyUInfo header parameter for this JWE.

APU - Enum constant in enum org.forgerock.json.jose.jwe.JweHeaderKey

Agreement PartyUInfo header parameter.

asJwt() - Method in class org.forgerock.json.jose.builders.EncryptedJwtBuilder

asJwt() - Method in class org.forgerock.json.jose.builders.EncryptedThenSignedJwtBuilder

asJwt() - Method in interface org.forgerock.json.jose.builders.JwtBuilder

Builds the JWT object from its constituent parts.

asJwt() - Method in class org.forgerock.json.jose.builders.SignedJwtBuilderImpl

asJwt() - Method in class org.forgerock.json.jose.builders.SignedThenEncryptedJwtBuilder

aud(List<String>) - Method in class org.forgerock.json.jose.builders.JwtClaimsSetBuilder

Sets the JWT's intended audience list in the Claims Set.

AUD - Enum constant in enum org.forgerock.json.jose.jwt.JwtClaimsSetKey

Audience Claim.

B

base64urlDecode(String) - Static method in class org.forgerock.json.jose.utils.Utils

Base64url decodes the given String and converts the decoded bytes into a UTF-8 String.

base64UrlDecode(String) - Static method in class org.forgerock.json.jose.utils.BigIntegerUtils

Decode a big-endian base64 url encoding of a magnitude big integer and transform it as a positive big integer.

base64urlEncode(String) - Static method in class org.forgerock.json.jose.utils.Utils

Base64url encodes the given String, converting the String to UTF-8 bytes.

BigIntegerUtils - Class in org.forgerock.json.jose.utils

Utils to complement bit operations not covered by the BigInteger functions.

build() - Method in class org.forgerock.json.jose.builders.EncryptedJwtBuilder

Builds the JWE into a String by calling the build method on the JWE object.

build() - Method in class org.forgerock.json.jose.builders.EncryptedThenSignedJwtBuilder

Builds the JWS into a String by calling the build method on the JWS object.

build() - Method in class org.forgerock.json.jose.builders.EncryptedThenSignedJwtHeaderBuilder

Creates a JwsHeader instance from the header parameters set in this builder.

build() - Method in class org.forgerock.json.jose.builders.JweHeaderBuilder

Creates a JweHeader instance from the header parameters set in this builder.

build() - Method in class org.forgerock.json.jose.builders.JwsHeaderBuilder

Creates a JwsHeader instance from the header parameters set in this builder.

build() - Method in interface org.forgerock.json.jose.builders.JwtBuilder

Builds the JWT into a String by calling the build method on the JWT object.

build() - Method in class org.forgerock.json.jose.builders.JwtClaimsSetBuilder

Creates a JwtClaimsSet instance from the claims set in this builder.

build() - Method in class org.forgerock.json.jose.builders.JwtHeaderBuilder

Creates a JwtHeader instance from the header parameters set in this builder.

build() - Method in class org.forgerock.json.jose.builders.SignedJwtBuilderImpl

Builds the JWS into a String by calling the build method on the JWS object.

build() - Method in class org.forgerock.json.jose.jwe.EncryptedJwt

build() - Method in class org.forgerock.json.jose.jws.SignedJwt

Builds the JWT into a String by following the steps specified in the relevant specification according to whether the JWT is being signed and/or encrypted.

build() - Method in interface org.forgerock.json.jose.jwt.Jwt

Builds the JWT into a String by following the steps specified in the relevant specification according to whether the JWT is being signed and/or encrypted.

build() - Method in class org.forgerock.json.jose.jwt.JwtClaimsSet

Builds the JWT's Claims Set into a String representation of a JSON object.

build() - Method in class org.forgerock.json.jose.jwt.JwtHeader

Builds the JWT's header into a String representation of a JSON object.

build() - Method in interface org.forgerock.json.jose.jwt.Payload

Builds the JWTs Payload into a String by following the steps specified in the relevant specification according to whether the JWT is being signed and/or encrypted.

C

CHARSET - Static variable in class org.forgerock.json.jose.utils.Utils

UTF-8 Charset.

checkListValuesAreOfType(List<?>, Class<?>) - Method in class org.forgerock.json.jose.jwt.JWObject

Checks that the given List's type is of an assignable type from the required class.

checkValueIsOfType(Object, Class<?>) - Method in class org.forgerock.json.jose.jwt.JWObject

Checks that the given value is of an assignable type from the required class.

claim(String, Object) - Method in class org.forgerock.json.jose.builders.JwtClaimsSetBuilder

Adds a custom claim to the JWT Claims Set.

claims() - Method in class org.forgerock.json.jose.builders.JwtBuilderFactory

Creates a builder for building a JWT Claims Set to be used in the building of JWTs.

claims(Map<String, Object>) - Method in class org.forgerock.json.jose.builders.JwtClaimsSetBuilder

Sets all of the claims the JWT Claims Set with the values contained in the specified map.

claims(JwtClaimsSet) - Method in class org.forgerock.json.jose.builders.AbstractJwtBuilder

Sets the JwtClaimsSet for this JwtBuilder.

claims(JwtClaimsSet) - Method in class org.forgerock.json.jose.builders.EncryptedJwtBuilder

Sets the JwtClaimsSet for this JwtBuilder.

claims(JwtClaimsSet) - Method in class org.forgerock.json.jose.builders.SignedJwtBuilderImpl

Sets the JwtClaimsSet for this JwtBuilder.

claims(JwtClaimsSet) - Method in class org.forgerock.json.jose.builders.SignedThenEncryptedJwtBuilder

compress(byte[]) - Method in interface org.forgerock.json.jose.jwe.handlers.compression.CompressionHandler

Applies the compression algorithm to compress the given array of bytes.

compress(byte[]) - Method in class org.forgerock.json.jose.jwe.handlers.compression.DeflateCompressionHandler

Applies the compression algorithm to compress the given array of bytes.

compress(byte[]) - Method in class org.forgerock.json.jose.jwe.handlers.compression.NOPCompressionHandler

Simple returns the same byte array as it is given.

compress(CompressionAlgorithm, String) - Method in class org.forgerock.json.jose.jwe.CompressionManager

Convenience method equivalent to Base64url.encode(getCompressionHandler(compressionAlgorithm).compress(data.getBytes(Utils.CHARSET))).

CompressionAlgorithm - Enum in org.forgerock.json.jose.jwe

An Enum of the possible compression algorithms that can be applied to the JWE payload plaintext.

CompressionHandler - Interface in org.forgerock.json.jose.jwe.handlers.compression

The interface for CompressionHandlers for all the different compression algorithms.

CompressionManager - Class in org.forgerock.json.jose.jwe

A service to get the appropriate CompressionHandler for a specified Compression algorithm.

CompressionManager() - Constructor for class org.forgerock.json.jose.jwe.CompressionManager

configureJwksStore(String, Duration, Duration, URL) - Method in class org.forgerock.json.jose.jwk.store.JwksStoreService

Configure a JWKs store.

constantEquals(byte[], byte[]) - Static method in class org.forgerock.json.jose.utils.Utils

Compares two byte arrays for equality, in a constant time.

crit(List<String>) - Method in class org.forgerock.json.jose.builders.JwtSecureHeaderBuilder

Sets the critical header parameters for this JWS.

CRIT - Enum constant in enum org.forgerock.json.jose.jws.JwsHeaderKey

Critical header parameter.

cty(String) - Method in class org.forgerock.json.jose.builders.JwtSecureHeaderBuilder

Sets the content type header parameter for this JWS.

CTY - Enum constant in enum org.forgerock.json.jose.jws.JwsHeaderKey

Content Type header parameter.

CUSTOM - Enum constant in enum org.forgerock.json.jose.jwe.JweHeaderKey

Generic header key for a custom header parameter.

CUSTOM - Enum constant in enum org.forgerock.json.jose.jws.JwsHeaderKey

Generic header key for a custom header parameter.

CUSTOM - Enum constant in enum org.forgerock.json.jose.jwt.JwtClaimsSetKey

Custom (private) Claim.

CUSTOM - Enum constant in enum org.forgerock.json.jose.jwt.JwtHeaderKey

Generic header key for a custom header parameter.

D

decodeCoordinate(String) - Static method in class org.forgerock.json.jose.jwk.EcJWK

Decode the unsigned big-endian base64 url encoding of an elliptical curve point.

decompress(byte[]) - Method in interface org.forgerock.json.jose.jwe.handlers.compression.CompressionHandler

Applies the compression algorithm to decompress the given array of bytes.

decompress(byte[]) - Method in class org.forgerock.json.jose.jwe.handlers.compression.DeflateCompressionHandler

Applies the compression algorithm to decompress the given array of bytes.

decompress(byte[]) - Method in class org.forgerock.json.jose.jwe.handlers.compression.NOPCompressionHandler

Simply returns the same byte array as it is given.

decompress(CompressionAlgorithm, String) - Method in class org.forgerock.json.jose.jwe.CompressionManager

Convenience method equivalent to getCompressionHandler(compressionAlgorithm).decompress(Base64url.decode(data)).

decrypt(String, Key, byte[]) - Method in class org.forgerock.json.jose.jwe.handlers.encryption.AbstractEncryptionHandler

Deprecated.

Decrypts the given ciphertext using the private key and with the same encryption algorithm that was used in the encryption.

decrypt(String, Key, byte[], byte[]) - Method in class org.forgerock.json.jose.jwe.handlers.encryption.AbstractEncryptionHandler

Deprecated.

Decrypts the given ciphertext using the private key and initialisation vector with the same encryption algorithm that was used in the encryption.

decrypt(Key) - Method in class org.forgerock.json.jose.jwe.EncryptedJwt

Decrypts the JWE ciphertext back into a JwtClaimsSet.

decrypt(Key) - Method in class org.forgerock.json.jose.jws.EncryptedThenSignedJwt

Decrypts the JWE so that it Claims Set can be accessed.

decryptAndVerify(Key, SigningHandler) - Method in class org.forgerock.json.jose.jwe.SignedThenEncryptedJwt

Decrypts the outer JWT and then verifies the signature on the inner JWT.

decryptCiphertext(Key, byte[], byte[], byte[], byte[]) - Method in class org.forgerock.json.jose.jwe.handlers.encryption.RSA15AES128CBCHS256EncryptionHandler

Deprecated.

Decrypts the ciphertext with the Content Encryption Key, using the initialisation vector and additional authenticated data, following the steps defined by the EncryptionHandler JweAlgorithm.

decryptCiphertext(Key, byte[], byte[], byte[], byte[]) - Method in class org.forgerock.json.jose.jwe.handlers.encryption.AESKeyWrapEncryptionHandler

decryptCiphertext(Key, byte[], byte[], byte[], byte[]) - Method in class org.forgerock.json.jose.jwe.handlers.encryption.DirectEncryptionHandler

decryptCiphertext(Key, byte[], byte[], byte[], byte[]) - Method in interface org.forgerock.json.jose.jwe.handlers.encryption.EncryptionHandler

Decrypts the ciphertext with the Content Encryption Key, using the initialisation vector and additional authenticated data, following the steps defined by the EncryptionHandler JweAlgorithm.

decryptCiphertext(Key, byte[], byte[], byte[], byte[]) - Method in class org.forgerock.json.jose.jwe.handlers.encryption.RSAEncryptionHandler

Decrypts the ciphertext with the Content Encryption Key, using the initialisation vector and additional authenticated data, following the steps defined by the EncryptionHandler JweAlgorithm.

decryptContentEncryptionKey(Key, byte[]) - Method in class org.forgerock.json.jose.jwe.handlers.encryption.RSA15AES128CBCHS256EncryptionHandler

Deprecated.

Decrypts the JWE Encrypted Key to produce the Content Encryption Key (CEK).

decryptContentEncryptionKey(Key, byte[]) - Method in class org.forgerock.json.jose.jwe.handlers.encryption.AESKeyWrapEncryptionHandler

decryptContentEncryptionKey(Key, byte[]) - Method in class org.forgerock.json.jose.jwe.handlers.encryption.DirectEncryptionHandler

decryptContentEncryptionKey(Key, byte[]) - Method in interface org.forgerock.json.jose.jwe.handlers.encryption.EncryptionHandler

Decrypts the Content Encryption Key (CEK) following the appropriate steps defined by the EncryptionHandler JweAlgorithm.

decryptContentEncryptionKey(Key, byte[]) - Method in class org.forgerock.json.jose.jwe.handlers.encryption.RSAEncryptionHandler

Decrypts the JWE Encrypted Key to produce the Content Encryption Key (CEK).

DEF - Enum constant in enum org.forgerock.json.jose.jwe.CompressionAlgorithm

A lossless compressed data format that compresses data using a combination of the LZ77 algorithm and Huffman coding.

DeflateCompressionHandler - Class in org.forgerock.json.jose.jwe.handlers.compression

An implementation of the CompressionHandler for DEFLATE Compressed Data Format Specification.

DeflateCompressionHandler() - Constructor for class org.forgerock.json.jose.jwe.handlers.compression.DeflateCompressionHandler

DerUtils - Class in org.forgerock.json.jose.utils

Utility methods for reading and writing DER-encoded values.

DIRECT - Enum constant in enum org.forgerock.json.jose.jwe.JweAlgorithm

Direct encryption with a shared symmetric key.

DIRECT - Enum constant in enum org.forgerock.json.jose.jwe.JweAlgorithmType

Direct symmetric encryption.

DirectEncryptionHandler - Class in org.forgerock.json.jose.jwe.handlers.encryption

Supports direct encryption using a shared symmetric key.

DirectEncryptionHandler(EncryptionMethod) - Constructor for class org.forgerock.json.jose.jwe.handlers.encryption.DirectEncryptionHandler

Constructs the direct encryption handler for the given content encryption method.

done() - Method in class org.forgerock.json.jose.builders.JwtHeaderBuilder

Marks the end to the building of the JWT header.

E

EC - Enum constant in enum org.forgerock.json.jose.jwk.KeyType

Elliptical Curve Key.

ECDSA - Enum constant in enum org.forgerock.json.jose.jws.JwsAlgorithmType

Elliptic Curve DSA signing algorithm.

ECDSASigningHandler - Class in org.forgerock.json.jose.jws.handlers

Elliptic Curve Digital Signature Algorithm (ECDSA) signing and verification.

ECDSASigningHandler(ECPrivateKey) - Constructor for class org.forgerock.json.jose.jws.handlers.ECDSASigningHandler

Constructs the ECDSA signing handler for signing only.

ECDSASigningHandler(ECPublicKey) - Constructor for class org.forgerock.json.jose.jws.handlers.ECDSASigningHandler

Constructs the ECDSA signing handler for verification only.

EcJWK - Class in org.forgerock.json.jose.jwk

This class implements an Elliptical Curve Json Web Key storage and manipulation class.

EcJWK(ECPublicKey, ECPrivateKey, KeyUse, String) - Constructor for class org.forgerock.json.jose.jwk.EcJWK

Creates a public and private EcJWK.

EcJWK(ECPublicKey, KeyUse, String) - Constructor for class org.forgerock.json.jose.jwk.EcJWK

Creates a public EcJWK.

EcJWK(KeyUse, String, String, String, String, String, String, String, String, List<String>) - Constructor for class org.forgerock.json.jose.jwk.EcJWK

Creates a public and private EcJWK.

EcJWK(KeyUse, String, String, String, String, String, String, String, List<String>) - Constructor for class org.forgerock.json.jose.jwk.EcJWK

Creates a public EcJWK.

enc(EncryptionMethod) - Method in class org.forgerock.json.jose.builders.JweHeaderBuilder

Sets the Encryption Method header parameter for this JWE.

ENC - Enum constant in enum org.forgerock.json.jose.jwe.JweHeaderKey

Encryption Method header parameter.

ENC - Enum constant in enum org.forgerock.json.jose.jwk.KeyUse

Use Key as a encryption key.

encodeCoordinate(int, BigInteger) - Static method in class org.forgerock.json.jose.jwk.EcJWK

Base64url encode the unsigned big-endian representation of an elliptical curve point.

encrypt(String, Key, byte[]) - Method in class org.forgerock.json.jose.jwe.handlers.encryption.AbstractEncryptionHandler

Deprecated.

Encrypts the given plaintext using the specified key with the specified encryption algorithm.

encrypt(String, Key, byte[], byte[]) - Method in class org.forgerock.json.jose.jwe.handlers.encryption.AbstractEncryptionHandler

Deprecated.

Encrypts the given plaintext using the specified key and initialisation vector with the specified encryption algorithm.

encrypt(Key) - Method in class org.forgerock.json.jose.builders.SignedJwtBuilderImpl

Wraps the signed JWT in an outer encrypted JWE envelope.

EncryptedJwt - Class in org.forgerock.json.jose.jwe

A JWE implementation of the Jwt interface.

EncryptedJwt(JweHeader, String, byte[], byte[], byte[], byte[]) - Constructor for class org.forgerock.json.jose.jwe.EncryptedJwt

Constructs a reconstructed EncryptedJwt from its constituent parts, the JweHeader, encrypted Content Encryption Key (CEK), initialisation vector, ciphertext and additional authentication data.

EncryptedJwt(JweHeader, JwtClaimsSet, Key) - Constructor for class org.forgerock.json.jose.jwe.EncryptedJwt

Constructs a fresh, new EncryptedJwt from the given JweHeader and JwtClaimsSet.

EncryptedJwtBuilder - Class in org.forgerock.json.jose.builders

An implementation of a JwtBuilder that can build a JWT and encrypt it, resulting in an EncryptedJwt object.

EncryptedJwtBuilder(Key) - Constructor for class org.forgerock.json.jose.builders.EncryptedJwtBuilder

Constructs a new EncryptedJwtBuilder that will use the given public key to encrypt the JWT.

EncryptedThenSignedJwt - Class in org.forgerock.json.jose.jws

An implementation of a JWS with a nested JWE as its payload.

EncryptedThenSignedJwt(JwsHeader, EncryptedJwt, byte[], byte[]) - Constructor for class org.forgerock.json.jose.jws.EncryptedThenSignedJwt

Constructs a reconstructed SignedEncryptedJwt from its constituent parts, the JwsHeader, nested Encrypted JWT, signing input and signature.

EncryptedThenSignedJwt(JwsHeader, EncryptedJwt, SigningHandler) - Constructor for class org.forgerock.json.jose.jws.EncryptedThenSignedJwt

Constructs a fresh, new SignedEncryptedJwt from the given JwsHeader and nested Encrypted JWT.

EncryptedThenSignedJwtBuilder - Class in org.forgerock.json.jose.builders

An implementation of a JwtBuilder that can build a JWT and encrypt it and nest it within another signed JWT, resulting in an SignedEncryptedJwt object.

EncryptedThenSignedJwtBuilder(EncryptedJwtBuilder, SigningHandler, JwsAlgorithm) - Constructor for class org.forgerock.json.jose.builders.EncryptedThenSignedJwtBuilder

Constructs a new SignedEncryptedJwtBuilder that will use the given EncryptedJwtBuilder, to build the nested Encrypted JWT, and the private key and JwsAlgorithm to sign the outer JWT.

EncryptedThenSignedJwtHeaderBuilder - Class in org.forgerock.json.jose.builders

An implementation of a JWS Header builder that provides a fluent builder pattern to create JWS headers for signed encrypted JWTs.

EncryptedThenSignedJwtHeaderBuilder(EncryptedThenSignedJwtBuilder) - Constructor for class org.forgerock.json.jose.builders.EncryptedThenSignedJwtHeaderBuilder

Constructs a new JwsHeaderBuilder, parented by the given JwtBuilder.

EncryptionHandler - Interface in org.forgerock.json.jose.jwe.handlers.encryption

The interface for EncryptionHandlers for all the different encryption algorithms.

EncryptionManager - Class in org.forgerock.json.jose.jwe

A service to get the appropriate EncryptionHandler for a specified Java Cryptographic encryption algorithm.

EncryptionManager() - Constructor for class org.forgerock.json.jose.jwe.EncryptionManager

EncryptionMethod - Enum in org.forgerock.json.jose.jwe

An Enum of the possible encryption methods that can be used when encrypting a JWT.

encryptPlaintext(Key, byte[], byte[], byte[]) - Method in class org.forgerock.json.jose.jwe.handlers.encryption.RSA15AES128CBCHS256EncryptionHandler

Deprecated.

Encrypts the plaintext with the Content Encryption Key, using the initialisation vector and additional authenticated data, following the steps defined by the EncryptionHandler JweAlgorithm.

encryptPlaintext(Key, byte[], byte[], byte[]) - Method in class org.forgerock.json.jose.jwe.handlers.encryption.AESKeyWrapEncryptionHandler

encryptPlaintext(Key, byte[], byte[], byte[]) - Method in class org.forgerock.json.jose.jwe.handlers.encryption.DirectEncryptionHandler

encryptPlaintext(Key, byte[], byte[], byte[]) - Method in interface org.forgerock.json.jose.jwe.handlers.encryption.EncryptionHandler

Encrypts the plaintext with the Content Encryption Key, using the initialisation vector and additional authenticated data, following the steps defined by the EncryptionHandler JweAlgorithm.

encryptPlaintext(Key, byte[], byte[], byte[]) - Method in class org.forgerock.json.jose.jwe.handlers.encryption.RSAEncryptionHandler

Encrypts the plaintext with the Content Encryption Key, using the initialisation vector and additional authenticated data, following the steps defined by the EncryptionHandler JweAlgorithm.

epk(String) - Method in class org.forgerock.json.jose.builders.JweHeaderBuilder

Sets the Ephemeral Public Key header parameter for this JWE.

EPK - Enum constant in enum org.forgerock.json.jose.jwe.JweHeaderKey

Ephemeral Public Key header parameter.

equals(Object) - Method in class org.forgerock.json.jose.jwe.JweEncryption

ES256 - Enum constant in enum org.forgerock.json.jose.jws.JwsAlgorithm

ECDSA using SHA-256 hash algorithm.

ES384 - Enum constant in enum org.forgerock.json.jose.jws.JwsAlgorithm

ECDSA using SHA-384 hash algorithm.

ES512 - Enum constant in enum org.forgerock.json.jose.jws.JwsAlgorithm

ECDSA using SHA-512 hash algorithm.

exp(Date) - Method in class org.forgerock.json.jose.builders.JwtClaimsSetBuilder

Sets the expiration time of the JWT in the Claims Set.

EXP - Enum constant in enum org.forgerock.json.jose.jwt.JwtClaimsSetKey

Expiration Time Claim.

F

FailedToLoadJWKException - Exception in org.forgerock.json.jose.exceptions

Unable to load the JWK/x5u location points.

FailedToLoadJWKException() - Constructor for exception org.forgerock.json.jose.exceptions.FailedToLoadJWKException

Construct the exception.

FailedToLoadJWKException(String) - Constructor for exception org.forgerock.json.jose.exceptions.FailedToLoadJWKException

Construct the exception with the given message.

FailedToLoadJWKException(String, Throwable) - Constructor for exception org.forgerock.json.jose.exceptions.FailedToLoadJWKException

Construct the exception with the given message and cause.

FailedToLoadJWKException(Throwable) - Constructor for exception org.forgerock.json.jose.exceptions.FailedToLoadJWKException

Construct the exception with the given cause.

findJwk(String) - Method in class org.forgerock.json.jose.jwk.JWKSet

Search for a JWK that matches the kid.

findJwk(String) - Method in class org.forgerock.json.jose.jwk.store.JwksStore

Search for a JWK that matches the kid.

findJwk(Algorithm, KeyUse) - Method in class org.forgerock.json.jose.jwk.JWKSet

Search for a JWK that matches the algorithm and the key usage.

findJwk(Algorithm, KeyUse) - Method in class org.forgerock.json.jose.jwk.store.JwksStore

Search for a JWK that matches the algorithm and the key usage.

forKey(ECKey) - Static method in enum org.forgerock.json.jose.jws.SupportedEllipticCurve

Determines the standard curve that matches the given (private or public) key.

forName(String) - Static method in enum org.forgerock.json.jose.jws.SupportedEllipticCurve

Returns the curve parameters for the given standard curve name (crv claim in a JWK).

forSignature(byte[]) - Static method in enum org.forgerock.json.jose.jws.SupportedEllipticCurve

Determines the supported curve parameters for the given signature.

fromIntDate(long) - Static method in class org.forgerock.json.jose.utils.IntDate

Converts an IntDate into a Java Date object.

G

generate(JsonValue) - Method in class org.forgerock.json.jose.tokenhandler.JwtTokenHandler

generateInitialisationVector() - Method in class org.forgerock.json.jose.jwe.handlers.encryption.RSA15AES128CBCHS256EncryptionHandler

Deprecated.

Generates a random JWE Initialisation Vector of the correct size for the encryption algorithm.

generateInitialisationVector() - Method in class org.forgerock.json.jose.jwe.handlers.encryption.AESKeyWrapEncryptionHandler

generateInitialisationVector() - Method in class org.forgerock.json.jose.jwe.handlers.encryption.DirectEncryptionHandler

generateInitialisationVector() - Method in interface org.forgerock.json.jose.jwe.handlers.encryption.EncryptionHandler

Generates a random JWE Initialisation Vector of the correct size for the encryption algorithm, if the EncryptionHandler JweAlgorithm does not required an initialisation vector then the initialisation vector will be an empty octet sequence.

generateInitialisationVector() - Method in class org.forgerock.json.jose.jwe.handlers.encryption.RSAEncryptionHandler

Generates a random JWE Initialisation Vector of the correct size for the encryption algorithm.

generateJWEEncryptedKey(Key, Key) - Method in class org.forgerock.json.jose.jwe.handlers.encryption.RSA15AES128CBCHS256EncryptionHandler

Deprecated.

Generates the JWE Encrypted Key by encrypting the Content Encryption Key (CEK) using the JweAlgorithm RSAES_PCKCS1_V1_5.

generateJWEEncryptedKey(Key, Key) - Method in class org.forgerock.json.jose.jwe.handlers.encryption.AESKeyWrapEncryptionHandler

generateJWEEncryptedKey(Key, Key) - Method in class org.forgerock.json.jose.jwe.handlers.encryption.DirectEncryptionHandler

generateJWEEncryptedKey(Key, Key) - Method in interface org.forgerock.json.jose.jwe.handlers.encryption.EncryptionHandler

Generates the Content Encryption Key (CEK) following the appropriate steps defined by the EncryptionHandler JweAlgorithm.

generateJWEEncryptedKey(Key, Key) - Method in class org.forgerock.json.jose.jwe.handlers.encryption.RSAEncryptionHandler

Generates the JWE Encrypted Key by encrypting the Content Encryption Key (CEK) using the JweAlgorithm RSAES_PCKCS1_V1_5.

generateMapFromJWK(URL) - Method in class org.forgerock.json.jose.jwk.JWKSetParser

Provides a Map of KeyId:Keys as indicated by the JWKSet's URL.

get(String) - Method in class org.forgerock.json.jose.jwt.JWObject

Returns the specified item value.

getAgreementPartyUInfo() - Method in class org.forgerock.json.jose.jwe.JweHeader

Gets the Agreement PartyUInfo header parameter for this JWE.

getAlgorithm() - Method in enum org.forgerock.json.jose.jwe.JweAlgorithm

getAlgorithm() - Method in class org.forgerock.json.jose.jwe.JweHeader

Gets the Algorithm set in the JWT header.

getAlgorithm() - Method in class org.forgerock.json.jose.jwk.JWK

Gets the alg parameter of the JWK.

getAlgorithm() - Method in enum org.forgerock.json.jose.jws.JwsAlgorithm

getAlgorithm() - Method in class org.forgerock.json.jose.jws.JwsHeader

Gets the Algorithm set in the JWT header.

getAlgorithm() - Method in interface org.forgerock.json.jose.jwt.Algorithm

Gets the actual name of the algorithm that is understood by Java cryptographic operations.

getAlgorithm() - Method in class org.forgerock.json.jose.jwt.JwtHeader

Gets the Algorithm set in the JWT header.

getAlgorithmString() - Method in class org.forgerock.json.jose.jwt.JwtHeader

Gets the string representation of the Algorithm set in the JWT header.

getAlgorithmType() - Method in enum org.forgerock.json.jose.jwe.JweAlgorithm

Gets the JweAlgorithmType of the JweAlgorithm.

getAlgorithmType() - Method in enum org.forgerock.json.jose.jws.JwsAlgorithm

Gets the JwsAlgorithmType of the JwsAlgorithm.

getAudience() - Method in class org.forgerock.json.jose.jwt.JwtClaimsSet

Gets the intended audience for the JWT from the Claims Set.

getAuthenticationTag() - Method in class org.forgerock.json.jose.jwe.JweEncryption

Gets the authentication tag from the result of the encryption.

getCacheMissCacheTime() - Method in class org.forgerock.json.jose.jwk.store.JwksStore

Get the cache time before reload the cache in case of cache miss.

getCacheTimeout() - Method in class org.forgerock.json.jose.jwk.store.JwksStore

Get the cache timeout.

getCiphertext() - Method in class org.forgerock.json.jose.jwe.JweEncryption

Gets the ciphertext from the result of the encryption.

getClaim(String) - Method in class org.forgerock.json.jose.jwt.JwtClaimsSet

Gets a claim value for the specified key.

getClaim(String, Class<T>) - Method in class org.forgerock.json.jose.jwt.JwtClaimsSet

Gets a claim value for the specified claim name and then casts it to the specified type.

getClaimSetKey(String) - Static method in enum org.forgerock.json.jose.jwt.JwtClaimsSetKey

Gets the JwtClaimsSetKey constant that matches the given String (case-insensitive).

getClaimsSet() - Method in class org.forgerock.json.jose.jwe.EncryptedJwt

getClaimsSet() - Method in class org.forgerock.json.jose.jwe.SignedThenEncryptedJwt

getClaimsSet() - Method in class org.forgerock.json.jose.jws.EncryptedThenSignedJwt

Gets the claims set object for the nested Encrypted JWT that is the payload of this JWS.

getClaimsSet() - Method in class org.forgerock.json.jose.jws.SignedJwt

Gets the claims set object for the Jwt, which contains all of the claims (name value pairs) conveyed by the JWT.

getClaimsSet() - Method in interface org.forgerock.json.jose.jwt.Jwt

Gets the claims set object for the Jwt, which contains all of the claims (name value pairs) conveyed by the JWT.

getCompressionAlgorithm() - Method in class org.forgerock.json.jose.jws.JwtSecureHeader

Gets the Compression Algorithm header parameter for this JWE.

getCompressionHandler(CompressionAlgorithm) - Method in class org.forgerock.json.jose.jwe.CompressionManager

Gets the appropriate CompressionHandler that can perform the required compression using the given compression algorithm.

getContentEncryptionKey() - Method in class org.forgerock.json.jose.jwe.handlers.encryption.RSA15AES128CBCHS256EncryptionHandler

Deprecated.

Creates a Content Encryption Key (CEK) by generating a random key value with a length equal to the EncryptionMethod A128CBC_HS256 key size.

getContentEncryptionKey() - Method in class org.forgerock.json.jose.jwe.handlers.encryption.AESKeyWrapEncryptionHandler

getContentEncryptionKey() - Method in class org.forgerock.json.jose.jwe.handlers.encryption.DirectEncryptionHandler

getContentEncryptionKey() - Method in interface org.forgerock.json.jose.jwe.handlers.encryption.EncryptionHandler

Creates a Content Encryption Key (CEK) following the appropriate steps defined by the EncryptionHandler JweAlgorithm.

getContentEncryptionKey() - Method in class org.forgerock.json.jose.jwe.handlers.encryption.RSAEncryptionHandler

Creates a Content Encryption Key (CEK) by generating a random key value with a length equal to the EncryptionMethod A128CBC_HS256 key size.

getContentType() - Method in class org.forgerock.json.jose.jws.JwtSecureHeader

Gets the content type header parameter for this JWS.

getCriticalHeaders() - Method in class org.forgerock.json.jose.jws.JwtSecureHeader

Gets the critical header parameters for this JWS.

getCRTCoefficient() - Method in class org.forgerock.json.jose.jwk.RsaJWK

Get the RSA First CRT Coefficient value.

getCRTCoefficient() - Method in class org.forgerock.json.jose.jwk.RsaJWK.OtherFactors

Get the T value.

getCRTExponent() - Method in class org.forgerock.json.jose.jwk.RsaJWK.OtherFactors

Get the D value.

getCurve() - Method in class org.forgerock.json.jose.jwk.EcJWK

Gets the known curve to use.

getD() - Method in class org.forgerock.json.jose.jwk.EcJWK

Gets the unsigned big-endian base64 url encoding of the d value for the elliptical curve private key.

getEllipticCurveName() - Method in enum org.forgerock.json.jose.jws.JwsAlgorithm

Return the standard name of the elliptic curve definition.

getEncryptionAlgorithm() - Method in enum org.forgerock.json.jose.jwe.EncryptionMethod

Gets the Java Cryptographic algorithm name for the algorithm that will create the Content Encryption Key (CEK).

getEncryptionHandler(JweHeader) - Method in class org.forgerock.json.jose.jwe.EncryptionManager

Gets the appropriate EncryptionHandler that can perform the required encryption algorithm, as described by the JweAlgorithm and EncryptionMethod in the given JweHeader.

getEncryptionMethod() - Method in class org.forgerock.json.jose.jwe.JweHeader

Gets the Encryption Method header parameter for this JWE.

getEphemeralPublicKey() - Method in class org.forgerock.json.jose.jwe.JweHeader

Gets the Ephemeral Public Key header parameter for this JWE.

getExpirationTime() - Method in class org.forgerock.json.jose.jwt.JwtClaimsSet

Gets the expiration time of the JWT from the Claims Set.

getFactor() - Method in class org.forgerock.json.jose.jwk.RsaJWK.OtherFactors

Get the R value.

getHeader() - Method in class org.forgerock.json.jose.jwe.EncryptedJwt

getHeader() - Method in class org.forgerock.json.jose.jws.SignedJwt

Gets the header object for the JWT, which contains properties which describe the cryptographic operations applied to the JWT, among other properties.

getHeader() - Method in interface org.forgerock.json.jose.jwt.Jwt

Gets the header object for the JWT, which contains properties which describe the cryptographic operations applied to the JWT, among other properties.

getHeaderKey(String) - Static method in enum org.forgerock.json.jose.jwe.JweHeaderKey

Gets the JweHeaderKey constant that matches the given String.

getHeaderKey(String) - Static method in enum org.forgerock.json.jose.jws.JwsHeaderKey

Gets the JwsHeaderKey constant that matches the given String.

getHeaderKey(String) - Static method in enum org.forgerock.json.jose.jwt.JwtHeaderKey

Gets the JwtHeaderKey constant that matches the given String.

getHeaders() - Method in class org.forgerock.json.jose.builders.JwtHeaderBuilder

Gets the header parameters for the JWT.

getIssuedAtTime() - Method in class org.forgerock.json.jose.jwt.JwtClaimsSet

Gets the time the JWT was issued at, from the Claims Set.

getIssuer() - Method in class org.forgerock.json.jose.jwt.JwtClaimsSet

Gets the issuer this JWT was issued by.

getJsonWebKey() - Method in class org.forgerock.json.jose.jws.JwtSecureHeader

Gets the JSON Web Key header parameter for this JWS.

getJwaAlgorithmName() - Method in enum org.forgerock.json.jose.jwe.JweAlgorithm

getJwaAlgorithmName() - Method in enum org.forgerock.json.jose.jws.JwsAlgorithm

getJwaAlgorithmName() - Method in interface org.forgerock.json.jose.jwt.Algorithm

Gets the name of the algorithm as defined in the JWA standard.

getJWKsAsJsonValue() - Method in class org.forgerock.json.jose.jwk.JWKSet

Get the JWKs in the set.

getJWKsAsList() - Method in class org.forgerock.json.jose.jwk.JWKSet

Get the JWKs in the set.

getJwkSetUrl() - Method in class org.forgerock.json.jose.jws.JwtSecureHeader

Gets the JWK Set URL header parameter for this JWS.

getJwksStore(String) - Method in class org.forgerock.json.jose.jwk.store.JwksStoreService

Returns the appropriate JWKs store.

getJwkUrl() - Method in class org.forgerock.json.jose.jwk.store.JwksStore

The JWKs URI.

getJwsAlgorithm() - Method in enum org.forgerock.json.jose.jws.SupportedEllipticCurve

Returns the JwsAlgorithm that corresponds to this elliptic curve.

getJwsAlgorithm(String) - Static method in enum org.forgerock.json.jose.jws.JwsAlgorithm

Deprecated.

Replaced by JwsAlgorithm.parseCryptographicAlgorithm(String)

getJwtId() - Method in class org.forgerock.json.jose.jwt.JwtClaimsSet

Gets the unique ID of the JWT.

getKey() - Method in class org.forgerock.json.jose.jwk.OctJWK

Gets the symmetric key.

getKeyId() - Method in class org.forgerock.json.jose.jwk.JWK

Gets the kid parameter of the JWK.

getKeyId() - Method in class org.forgerock.json.jose.jws.JwtSecureHeader

Gets the Key ID header parameter for this JWS.

getKeyOffset() - Method in enum org.forgerock.json.jose.jwe.EncryptionMethod

Gets the number of octets in each of the CEK and MAC key.

getKeySize() - Method in enum org.forgerock.json.jose.jwe.EncryptionMethod

Gets the bit length of the Content Encryption Key (CEK).

getKeyType() - Method in class org.forgerock.json.jose.jwk.JWK

Gets the kty parameter of the JWK.

getKeyType(String) - Static method in enum org.forgerock.json.jose.jwk.KeyType

Get the KeyType given a string.

getKeyUse(String) - Static method in enum org.forgerock.json.jose.jwk.KeyUse

Get the KeyUse.

getMacAlgorithm() - Method in enum org.forgerock.json.jose.jwe.EncryptionMethod

Gets the Java Cryptographic algorithm name for the algorithm that will generate the MAC key.

getMdAlgorithm() - Method in enum org.forgerock.json.jose.jws.JwsAlgorithm

Returns the Java-friendly name of the message digest algorithm implementation.

getModulus() - Method in class org.forgerock.json.jose.jwk.RsaJWK

Get the RSA modulus value.

getName() - Method in enum org.forgerock.json.jose.jwe.EncryptionMethod

Gets the full name of the encryption method.

getNotBeforeTime() - Method in class org.forgerock.json.jose.jwt.JwtClaimsSet

Gets the time the JWT is not allowed to be processed before, from the Claims Set.

getOtherFactors() - Method in class org.forgerock.json.jose.jwk.RsaJWK

Get the RSA other factors value.

getParameter(String) - Method in class org.forgerock.json.jose.jwe.JweHeader

getParameter(String) - Method in class org.forgerock.json.jose.jws.JwtSecureHeader

Gets a header parameter for the specified key.

getParameter(String) - Method in class org.forgerock.json.jose.jwt.JwtHeader

Gets a header parameter for the specified key.

getParameter(String, Class<T>) - Method in class org.forgerock.json.jose.jwt.JwtHeader

Gets a header parameter for the specified key and then casts it to the specified type.

getParameters() - Method in enum org.forgerock.json.jose.jws.SupportedEllipticCurve

Returns the parameters for the given elliptic curve.

getParameters() - Method in class org.forgerock.json.jose.jwt.JwtHeader

Returns this JwtHeader's parameters.

getPayload() - Method in class org.forgerock.json.jose.jws.SignedJwt

Gets the payload for the JWS, which will either be a JWT Claims Set, SignedJwt.getClaimsSet(), or a nested EncryptedJwt, EncryptedJwt.

getPrimeP() - Method in class org.forgerock.json.jose.jwk.RsaJWK

Get the RSA First Prime Factor value.

getPrimePExponent() - Method in class org.forgerock.json.jose.jwk.RsaJWK

Get the RSA First Factor CRT Exponent value.

getPrimeQ() - Method in class org.forgerock.json.jose.jwk.RsaJWK

Get the RSA Second Prime Factor value.

getPrimeQExponent() - Method in class org.forgerock.json.jose.jwk.RsaJWK

Get the RSA Second factor CRT Exponent value.

getPrivateExponent() - Method in class org.forgerock.json.jose.jwk.RsaJWK

Get the RSA Private Exponent value.

getPublicExponent() - Method in class org.forgerock.json.jose.jwk.RsaJWK

Get the RSA Public Exponent.

getSignatureSize() - Method in enum org.forgerock.json.jose.jws.SupportedEllipticCurve

Returns the size of the signature produced by this curve in octets.

getStandardName() - Method in enum org.forgerock.json.jose.jws.SupportedEllipticCurve

Return the name of the curve as used for the "crv" claim in a JWK.

getSubject() - Method in class org.forgerock.json.jose.jwt.JwtClaimsSet

Gets the subject this JWT is issued to.

getTransformation() - Method in enum org.forgerock.json.jose.jwe.EncryptionMethod

Gets the Java Cryptographic algorithm name for the algorithm that will eb used to encrypt the plaintext.

getType() - Method in class org.forgerock.json.jose.jwt.JwtClaimsSet

Gets the type of the contents of the Claims Set.

getType() - Method in class org.forgerock.json.jose.jwt.JwtHeader

Gets the type of JWT this header represents.

getUid() - Method in class org.forgerock.json.jose.jwk.store.JwksStore

Get the UID.

getUse() - Method in class org.forgerock.json.jose.jwk.JWK

Gets the use parameter of the JWK.

getX() - Method in class org.forgerock.json.jose.jwk.EcJWK

Gets the unsigned big-endian base64 url encoding of the elliptical curve point x coordinate.

getX509CertificateChain() - Method in class org.forgerock.json.jose.jws.JwtSecureHeader

Gets the X.509 Certificate Chain header parameter for this JWS.

getX509CertificateThumbprint() - Method in class org.forgerock.json.jose.jws.JwtSecureHeader

Gets the X.509 Certificate Thumbprint header parameter for this JWS.

getX509Chain() - Method in class org.forgerock.json.jose.jwk.JWK

Gets a List of X509 chain certs.

getX509Thumbnail() - Method in class org.forgerock.json.jose.jwk.JWK

Gets the X509 thumbnail.

getX509Url() - Method in class org.forgerock.json.jose.jws.JwtSecureHeader

Gets the X.509 URL header parameter for this JWS.

getX509URL() - Method in class org.forgerock.json.jose.jwk.JWK

Gets the X509 URL.

getY() - Method in class org.forgerock.json.jose.jwk.EcJWK

Gets the unsigned big-endian base64 url encoding of the elliptical curve point y coordinate.

H

hashCode() - Method in class org.forgerock.json.jose.jwe.JweEncryption

header(String, Object) - Method in class org.forgerock.json.jose.builders.JwtHeaderBuilder

Adds a custom header parameter to the JWT header.

headerIfNotNull(String, Object) - Method in class org.forgerock.json.jose.builders.JwtHeaderBuilder

Adds a customer header parameter to the JWT header if the value is not null.

headers() - Method in class org.forgerock.json.jose.builders.AbstractJwtBuilder

Gets the JwtHeaderBuilder that this JwtBuilder will use to build the JWT's header parameters.

headers() - Method in class org.forgerock.json.jose.builders.EncryptedJwtBuilder

Gets the JweHeaderBuilder that this JwtBuilder will use to build the JWE's header parameters.

headers() - Method in class org.forgerock.json.jose.builders.EncryptedThenSignedJwtBuilder

headers() - Method in class org.forgerock.json.jose.builders.SignedJwtBuilderImpl

Gets the JwsHeaderBuilder that this JwtBuilder will use to build the JWS' header parameters.

headers() - Method in class org.forgerock.json.jose.builders.SignedThenEncryptedJwtBuilder

HMAC - Enum constant in enum org.forgerock.json.jose.jws.JwsAlgorithmType

HMAC signing algorithm.

HmacSigningHandler - Class in org.forgerock.json.jose.jws.handlers

An implementation of the SigningHandler which can sign and verify using algorithms from the HMAC family.

HmacSigningHandler(byte[]) - Constructor for class org.forgerock.json.jose.jws.handlers.HmacSigningHandler

Constructs a new HmacSigningHandler.

HS256 - Enum constant in enum org.forgerock.json.jose.jws.JwsAlgorithm

HMAC using SHA-256 hash algorithm.

HS384 - Enum constant in enum org.forgerock.json.jose.jws.JwsAlgorithm

HMAC using SHA-384 hash algorithm.

HS512 - Enum constant in enum org.forgerock.json.jose.jws.JwsAlgorithm

HMAC using SHA-512 hash algorithm.

I

iat(Date) - Method in class org.forgerock.json.jose.builders.JwtClaimsSetBuilder

Sets the time the JWT was issued at, in the Claims Set.

IAT - Enum constant in enum org.forgerock.json.jose.jwt.JwtClaimsSetKey

Issued At Claim.

IntDate - Class in org.forgerock.json.jose.utils

This class provides utility methods for converting Java Date objects into and from IntDates.

INTEGER_TAG - Static variable in class org.forgerock.json.jose.utils.DerUtils

DER tag for integer values.

InvalidJwtException - Exception in org.forgerock.json.jose.exceptions

Represents an exception that occurs when a JWT is determined as invalid.

InvalidJwtException(String) - Constructor for exception org.forgerock.json.jose.exceptions.InvalidJwtException

Constructs a new JwtReconstructionException with the provided exception message.

InvalidJwtException(String, Throwable) - Constructor for exception org.forgerock.json.jose.exceptions.InvalidJwtException

Constructs a new JwtReconstructionException with the provided exception message and underlying throwable.

InvalidJwtException(Throwable) - Constructor for exception org.forgerock.json.jose.exceptions.InvalidJwtException

Constructs a new JwtReconstructionException with the provided underlying throwable.

isDefined(String) - Method in class org.forgerock.json.jose.jwt.JWObject

Returns true if this JWObject contains the specified item.

iss(String) - Method in class org.forgerock.json.jose.builders.JwtClaimsSetBuilder

Sets the issuer this JWT was issued by.

iss(URI) - Method in class org.forgerock.json.jose.builders.JwtClaimsSetBuilder

Sets the issuer this JWT was issued by.

ISS - Enum constant in enum org.forgerock.json.jose.jwt.JwtClaimsSetKey

Issuer Claim.

isValueOfType(Object, Class<?>) - Method in class org.forgerock.json.jose.jwt.JWObject

Checks to see if the given value is of an assignable type from the required class.

J

jku(URL) - Method in class org.forgerock.json.jose.builders.JwtSecureHeaderBuilder

Sets the JWK Set URL header parameter for this JWS.

JKU - Enum constant in enum org.forgerock.json.jose.jws.JwsHeaderKey

JWK Set URL header parameter.

jti(String) - Method in class org.forgerock.json.jose.builders.JwtClaimsSetBuilder

Sets the unique ID of the JWT.

JTI - Enum constant in enum org.forgerock.json.jose.jwt.JwtClaimsSetKey

JWT ID Claim.

jwe(Key) - Method in class org.forgerock.json.jose.builders.JwtBuilderFactory

Creates a builder for building an encrypted JWT into a base64url UTF-8 encoded JWT string.

JWE - Enum constant in enum org.forgerock.json.jose.jwt.JwtType

Used when encrypting a nested JWT.

JweAlgorithm - Enum in org.forgerock.json.jose.jwe

An Enum of the possible encryption algorithms that can be used to encrypt a JWT.

JweAlgorithmType - Enum in org.forgerock.json.jose.jwe

An Enum of the possible types of JWE algorithms that can be used to encrypt a JWT.

JweCompressionException - Exception in org.forgerock.json.jose.exceptions

Represents an exception for when compression/decompression of the plaintext fails.

JweCompressionException(String) - Constructor for exception org.forgerock.json.jose.exceptions.JweCompressionException

Constructs a new JweCompressionException with the provided exception message.

JweCompressionException(String, Throwable) - Constructor for exception org.forgerock.json.jose.exceptions.JweCompressionException

Constructs a new JweCompressionException with the provided exception message and underlying throwable.

JweCompressionException(Throwable) - Constructor for exception org.forgerock.json.jose.exceptions.JweCompressionException

Constructs a new JweCompressionException with the provided underlying throwable.

JweDecryptionException - Exception in org.forgerock.json.jose.exceptions

Represents an exception for when decryption of the JWE fails.

JweDecryptionException() - Constructor for exception org.forgerock.json.jose.exceptions.JweDecryptionException

Constructs a new JweDecryptionException.

JweEncryption - Class in org.forgerock.json.jose.jwe

This class represents the result from the encryption process of the JWT plaintext.

JweEncryption(byte[], byte[]) - Constructor for class org.forgerock.json.jose.jwe.JweEncryption

Constructs a new JweEncryption object with the given ciphertext and authentication tag.

JweEncryptionException - Exception in org.forgerock.json.jose.exceptions

Represents an exception for when encryption of the JWE fails.

JweEncryptionException(String) - Constructor for exception org.forgerock.json.jose.exceptions.JweEncryptionException

Constructs a new JweEncryptionException with the provided exception message.

JweEncryptionException(String, Throwable) - Constructor for exception org.forgerock.json.jose.exceptions.JweEncryptionException

Constructs a new JweEncryptionException with the provided exception message and underlying throwable.

JweEncryptionException(Throwable) - Constructor for exception org.forgerock.json.jose.exceptions.JweEncryptionException

Constructs a new JweEncryptionException with the provided underlying throwable.

JweException - Exception in org.forgerock.json.jose.exceptions

Represents a generic exception for JWE operations.

JweException(String) - Constructor for exception org.forgerock.json.jose.exceptions.JweException

Constructs a new JweException with the provided exception message.

JweException(String, Throwable) - Constructor for exception org.forgerock.json.jose.exceptions.JweException

Constructs a new JweException with the provided exception message and underlying throwable.

JweException(Throwable) - Constructor for exception org.forgerock.json.jose.exceptions.JweException

Constructs a new JweException with the provided underlying throwable.

JweHeader - Class in org.forgerock.json.jose.jwe

An implementation for the JWE Header parameters.

JweHeader() - Constructor for class org.forgerock.json.jose.jwe.JweHeader

Constructs an new, empty JweHeader.

JweHeader(Map<String, Object>) - Constructor for class org.forgerock.json.jose.jwe.JweHeader

Constructs a new JweHeader with its parameters set to the contents of the given Map.

JweHeaderBuilder<B extends EncryptedJwtBuilder> - Class in org.forgerock.json.jose.builders

An implementation of a JWE Header builder that provides a fluent builder pattern to create JWE headers.

JweHeaderBuilder(B) - Constructor for class org.forgerock.json.jose.builders.JweHeaderBuilder

Constructs a new JweHeaderBuilder, parented by the given JwtBuilder.

JweHeaderKey - Enum in org.forgerock.json.jose.jwe

An Enum for the additional JWE Header parameter names.

jwk(JWK) - Method in class org.forgerock.json.jose.builders.JwtSecureHeaderBuilder

Sets the JSON Web Key header parameter for this JWS.

JWK - Class in org.forgerock.json.jose.jwk

The abstract base class for the 3 implementations of JWK.

JWK - Enum constant in enum org.forgerock.json.jose.jws.JwsHeaderKey

JSON Web Key header parameter.

JWK(KeyType, KeyUse, String, String) - Constructor for class org.forgerock.json.jose.jwk.JWK

Creates a JWK given the basic parameters.

JWK(KeyType, KeyUse, String, String, String, String, List<String>) - Constructor for class org.forgerock.json.jose.jwk.JWK

Creates a JWK given the basic parameters.

JWKLookup - Class in org.forgerock.json.jose.jwk

Helper class to look up and return the keys from specific JWK implementation algorithm types.

JWKLookup() - Constructor for class org.forgerock.json.jose.jwk.JWKLookup

JWKS_STORE_DEFAULT_CACHE_MISS_CACHE_TIME_MS - Static variable in class org.forgerock.json.jose.jwk.store.JwksStoreService

The default cache time before reload the cache in case of cache miss ms.

JWKS_STORE_DEFAULT_CACHE_TIMEOUT_MS - Static variable in class org.forgerock.json.jose.jwk.store.JwksStoreService

The default cache timeout in ms.

jwkSet(URL) - Method in class org.forgerock.json.jose.jwk.JWKSetParser

Provides a jwks set as indicated by the JWKSet's URL.

JWKSet - Class in org.forgerock.json.jose.jwk

Holds a Set of JWKs.

JWKSet() - Constructor for class org.forgerock.json.jose.jwk.JWKSet

Constructs an empty JWKSet.

JWKSet(List<JWK>) - Constructor for class org.forgerock.json.jose.jwk.JWKSet

Construct a JWKSet from a List of JWKs.

JWKSet(JWK) - Constructor for class org.forgerock.json.jose.jwk.JWKSet

Construct a JWKSet from a single JWK.

JWKSet(JsonValue) - Constructor for class org.forgerock.json.jose.jwk.JWKSet

Construct a JWKSet from a single JWK.

JWKSetParser - Class in org.forgerock.json.jose.jwk

Provides methods to gather a JWKSet from a URL and return a map of key ids to keys as dictated by that JWKS.

JWKSetParser(int, int) - Constructor for class org.forgerock.json.jose.jwk.JWKSetParser

Constructor allowing the configuration of the read and connection timeouts used by the HTTP client for this parser.

JWKSetParser(SimpleHTTPClient) - Constructor for class org.forgerock.json.jose.jwk.JWKSetParser

Alternative constructor allowing the calling class to pass in an already-configured SimpleHTTPClient.

JWKSetParser(SimpleHTTPClient, JWKLookup) - Constructor for class org.forgerock.json.jose.jwk.JWKSetParser

Alternative constructor allowing the calling class to pass in an already-configured SimpleHTTPClient.

jwkSetToMap(JWKSet) - Method in class org.forgerock.json.jose.jwk.JWKSetParser

Converts a supplied JWKSet into a map of key:values, where the keys are the keyIds and the values are verification keys.

JwksStore - Class in org.forgerock.json.jose.jwk.store

Store JWKs into a jwkSet from a JWKs_URI and refresh the jwkSet when necessary.

JwksStoreService - Class in org.forgerock.json.jose.jwk.store

Manage the jwks store, to avoid having more than one jwks store for the same JWKs_URI unnecessary.

JwksStoreService() - Constructor for class org.forgerock.json.jose.jwk.store.JwksStoreService

Default constructor.

JwksStoreService(int, int) - Constructor for class org.forgerock.json.jose.jwk.store.JwksStoreService

Constructor with read and connection timeout.

JwksStoreService(SimpleHTTPClient) - Constructor for class org.forgerock.json.jose.jwk.store.JwksStoreService

Constructor with a HTTP client, that will be used to connect to the JWKS_URI.

JWObject - Class in org.forgerock.json.jose.jwt

A base implementation class for a JSON Web object.

JWObject() - Constructor for class org.forgerock.json.jose.jwt.JWObject

Constructs a new, empty JWObject.

jws(SigningHandler) - Method in class org.forgerock.json.jose.builders.JwtBuilderFactory

Creates a builder for building a signed JWT into a base64url UTF-8 encoded JWT string.

JWS - Enum constant in enum org.forgerock.json.jose.jwt.JwtType

Used when signing a nested JWT.

JwsAlgorithm - Enum in org.forgerock.json.jose.jws

An Enum of the possible signing algorithms that can be used to sign a JWT.

JwsAlgorithmType - Enum in org.forgerock.json.jose.jws

An Enum of the possible types of JWS algorithms that can be used to sign a JWT.

JwsException - Exception in org.forgerock.json.jose.exceptions

Represents a generic exception for JWS operations.

JwsException(String) - Constructor for exception org.forgerock.json.jose.exceptions.JwsException

Constructs a new JwsException with the provided exception message.

JwsException(String, Throwable) - Constructor for exception org.forgerock.json.jose.exceptions.JwsException

Constructs a new JwsException with the provided exception message and underlying throwable.

JwsException(Throwable) - Constructor for exception org.forgerock.json.jose.exceptions.JwsException

Constructs a new JwsException with the provided underlying throwable.

JwsHeader - Class in org.forgerock.json.jose.jws

An implementation for the JWS Header parameters.

JwsHeader() - Constructor for class org.forgerock.json.jose.jws.JwsHeader

Constructs a new, empty JwsHeader.

JwsHeader(Map<String, Object>) - Constructor for class org.forgerock.json.jose.jws.JwsHeader

Constructs a new JwsHeader, with its parameters set to the contents of the given Map.

JwsHeaderBuilder - Class in org.forgerock.json.jose.builders

An implementation of a JWS Header builder that provides a fluent builder pattern to create JWS headers.

JwsHeaderBuilder(SignedJwtBuilderImpl) - Constructor for class org.forgerock.json.jose.builders.JwsHeaderBuilder

Constructs a new JwsHeaderBuilder, parented by the given JwtBuilder.

JwsHeaderKey - Enum in org.forgerock.json.jose.jws

An Enum for the JWS Header parameter names.

JwsSigningException - Exception in org.forgerock.json.jose.exceptions

Represents an exception for when signing of the JWS fails.

JwsSigningException(String) - Constructor for exception org.forgerock.json.jose.exceptions.JwsSigningException

Constructs a new JwsSigningException with the provided exception message.

JwsSigningException(String, Throwable) - Constructor for exception org.forgerock.json.jose.exceptions.JwsSigningException

Constructs a new JwsSigningException with the provided exception message and underlying throwable.

JwsSigningException(Throwable) - Constructor for exception org.forgerock.json.jose.exceptions.JwsSigningException

Constructs a new JwsSigningException with the provided underlying throwable.

JwsVerifyingException - Exception in org.forgerock.json.jose.exceptions

Represents an exception for when verification of the JWS signature fails.

JwsVerifyingException(String) - Constructor for exception org.forgerock.json.jose.exceptions.JwsVerifyingException

Constructs a new JwsVerifyingException with the provided exception message.

JwsVerifyingException(String, Throwable) - Constructor for exception org.forgerock.json.jose.exceptions.JwsVerifyingException

Constructs a new JwsVerifyingException with the provided exception message and underlying throwable.

JwsVerifyingException(Throwable) - Constructor for exception org.forgerock.json.jose.exceptions.JwsVerifyingException

Constructs a new JwsVerifyingException with the provided underlying throwable.

jwt() - Method in class org.forgerock.json.jose.builders.JwtBuilderFactory

Creates a builder for building a plaintext JWT into base64url UTF-8 encoded JWT string.

Jwt - Interface in org.forgerock.json.jose.jwt

The interface for all types of JSON Web Tokens (JWTs).

JWT - Enum constant in enum org.forgerock.json.jose.jwt.JwtType

Used for plaintext, non-nested signed or non-nested encrypted JWTs.

JwtBuilder - Interface in org.forgerock.json.jose.builders

The base interface for all JwtBuilders for each type of JWT (plaintext, signed or encrypted).

JwtBuilderException - Exception in org.forgerock.json.jose.exceptions

Represents an exception that occurs when creating/rebuilding JWTs.

JwtBuilderException(String) - Constructor for exception org.forgerock.json.jose.exceptions.JwtBuilderException

Constructs a new JwtBuilderException with the provided exception message.

JwtBuilderException(String, Throwable) - Constructor for exception org.forgerock.json.jose.exceptions.JwtBuilderException

Constructs a new JwtBuilderException with the provided exception message and underlying throwable.

JwtBuilderException(Throwable) - Constructor for exception org.forgerock.json.jose.exceptions.JwtBuilderException

Constructs a new JwtBuilderException with the provided underlying throwable.

JwtBuilderFactory - Class in org.forgerock.json.jose.builders

A factory for getting builders for plaintext, signed and encrypted JWTs and reconstructing JWT strings back into their relevant JWT objects.

JwtBuilderFactory() - Constructor for class org.forgerock.json.jose.builders.JwtBuilderFactory

JwtClaimsSet - Class in org.forgerock.json.jose.jwt

An implementation that holds a JWT's Claims Set.

JwtClaimsSet() - Constructor for class org.forgerock.json.jose.jwt.JwtClaimsSet

Constructs a new, empty JwtClaimsSet.

JwtClaimsSet(Map<String, Object>) - Constructor for class org.forgerock.json.jose.jwt.JwtClaimsSet

Constructs a new JwtClaimsSet, with its claims set to the contents of the given Map.

JwtClaimsSetBuilder - Class in org.forgerock.json.jose.builders

An implementation of a JWT Claims Set builder that provides a fluent builder pattern to creating JWT Claims Sets.

JwtClaimsSetBuilder() - Constructor for class org.forgerock.json.jose.builders.JwtClaimsSetBuilder

JwtClaimsSetKey - Enum in org.forgerock.json.jose.jwt

An Enum for the JWT Claims Set names.

JwtHeader - Class in org.forgerock.json.jose.jwt

A base implementation class for JWT Headers.

JwtHeader() - Constructor for class org.forgerock.json.jose.jwt.JwtHeader

Constructs a new JwtHeader, with the "typ" parameter set to "JWT".

JwtHeader(Map<String, Object>) - Constructor for class org.forgerock.json.jose.jwt.JwtHeader

Constructs a new JwtHeader, with its parameters set to the contents of the given Map.

JwtHeaderBuilder<T extends JwtBuilder,B extends JwtHeaderBuilder<T,B>> - Class in org.forgerock.json.jose.builders

A base implementation of a JWT header builder that provides a fluent builder pattern to creating JWT headers.

JwtHeaderBuilder(T) - Constructor for class org.forgerock.json.jose.builders.JwtHeaderBuilder

Constructs a new JwtHeaderBuilder, parented by the given JwtBuilder.

JwtHeaderKey - Enum in org.forgerock.json.jose.jwt

An Enum for the JWT Header parameter names.

JwtReconstruction - Class in org.forgerock.json.jose.common

A service that provides a method for reconstruct a JWT string back into its relevant JWT object, (SignedJwt, EncryptedJwt, SignedEncryptedJwt).

JwtReconstruction() - Constructor for class org.forgerock.json.jose.common.JwtReconstruction

JwtReconstructionException - Exception in org.forgerock.json.jose.exceptions

Represents an exception that occurs when reconstructing JWTs.

JwtReconstructionException(String) - Constructor for exception org.forgerock.json.jose.exceptions.JwtReconstructionException

Constructs a new JwtReconstructionException with the provided exception message.

JwtReconstructionException(String, Throwable) - Constructor for exception org.forgerock.json.jose.exceptions.JwtReconstructionException

Constructs a new JwtReconstructionException with the provided exception message and underlying throwable.

JwtReconstructionException(Throwable) - Constructor for exception org.forgerock.json.jose.exceptions.JwtReconstructionException

Constructs a new JwtReconstructionException with the provided underlying throwable.

JwtRuntimeException - Exception in org.forgerock.json.jose.exceptions

Represents a generic exception for JWT operations.

JwtRuntimeException(String) - Constructor for exception org.forgerock.json.jose.exceptions.JwtRuntimeException

Constructs a new JwtRuntimeException with the provided exception message.

JwtRuntimeException(String, Throwable) - Constructor for exception org.forgerock.json.jose.exceptions.JwtRuntimeException

Constructs a new JwtRuntimeException with the provided exception message and underlying throwable.

JwtRuntimeException(Throwable) - Constructor for exception org.forgerock.json.jose.exceptions.JwtRuntimeException

Constructs a new JwtRuntimeException with the provided underlying throwable.

JwtSecureHeader - Class in org.forgerock.json.jose.jws

A base implementation for the common security header parameters shared by the JWS and JWE headers.

JwtSecureHeader() - Constructor for class org.forgerock.json.jose.jws.JwtSecureHeader

Constructs a new, empty JwtSecureHeader.

JwtSecureHeader(Map<String, Object>) - Constructor for class org.forgerock.json.jose.jws.JwtSecureHeader

Constructs a new JwtSecureHeader, with its parameters set to the contents of the given Map.

JwtSecureHeaderBuilder<T extends JwtBuilder,B extends JwtSecureHeaderBuilder<T,B>> - Class in org.forgerock.json.jose.builders

A base implementation of a JWT header builder, for the common security header parameters shared by the JWS and JWE headers, that provides a fluent builder pattern to creating JWT headers.

JwtSecureHeaderBuilder(T) - Constructor for class org.forgerock.json.jose.builders.JwtSecureHeaderBuilder

Constructs a new JwtSecureHeaderBuilder, parented by the given JwtBuilder.

JwtTokenHandler - Class in org.forgerock.json.jose.tokenhandler

Token handler for creating tokens using a JWT as the store.

JwtTokenHandler(JweAlgorithm, EncryptionMethod, KeyPair, JwsAlgorithm, SigningHandler) - Constructor for class org.forgerock.json.jose.tokenhandler.JwtTokenHandler

Constructs a new JWT token handler that never expires.

JwtTokenHandler(JweAlgorithm, EncryptionMethod, KeyPair, JwsAlgorithm, SigningHandler, Optional<Long>) - Constructor for class org.forgerock.json.jose.tokenhandler.JwtTokenHandler

Constructs a new JWT token handler.

jwtType(String) - Static method in enum org.forgerock.json.jose.jwt.JwtType

Finds the value of the String representation of the given JWT type.

JwtType - Enum in org.forgerock.json.jose.jwt

An Enum for the possible types of JWTs.

K

keys() - Method in class org.forgerock.json.jose.jwt.JWObject

Returns the set of keys for this JWObject's values.

KeyType - Enum in org.forgerock.json.jose.jwk

Enum representing the possible KeyTypes.

KeyUse - Enum in org.forgerock.json.jose.jwk

Represents the Possible KeyUse values.

kid(String) - Method in class org.forgerock.json.jose.builders.JwtSecureHeaderBuilder

Sets the Key ID header parameter for this JWS.

KID - Enum constant in enum org.forgerock.json.jose.jws.JwsHeaderKey

Key ID header parameter.

KID - Static variable in class org.forgerock.json.jose.jwk.JWK

The KeyID key.

KTY - Static variable in class org.forgerock.json.jose.jwk.JWK

The KeyType key.

L

lookup(String, KeyType) - Method in class org.forgerock.json.jose.jwk.JWKLookup

Lookup returns the key from the given json, under the assumption it's of the correct keyType.

N

nbf(Date) - Method in class org.forgerock.json.jose.builders.JwtClaimsSetBuilder

Sets the time the JWT is not allowed to be processed before, in the Claims Set.

NBF - Enum constant in enum org.forgerock.json.jose.jwt.JwtClaimsSetKey

Not Before Claim.

newEcdsaSigningHandler(ECPrivateKey) - Method in class org.forgerock.json.jose.jws.SigningManager

Constructs a new handler for signing ES256 signatures.

newEcdsaVerificationHandler(ECPublicKey) - Method in class org.forgerock.json.jose.jws.SigningManager

Constructs a new handler for verifying ES256 signatures.

newHmacSigningHandler(byte[]) - Method in class org.forgerock.json.jose.jws.SigningManager

Constructs a new HmacSigningHandler.

newNopSigningHandler() - Method in class org.forgerock.json.jose.jws.SigningManager

Constructs an implementation of the SigningHandler which does not perform any signing or verifying.

newRsaSigningHandler(Key) - Method in class org.forgerock.json.jose.jws.SigningManager

Constructs a new RSASigningHandler, with a SignatureUtil instance to delegate the signing and verifying calls to.

NONE - Enum constant in enum org.forgerock.json.jose.jwe.CompressionAlgorithm

When no compression is applied.

NONE - Enum constant in enum org.forgerock.json.jose.jws.JwsAlgorithm

No digital signature or MAC value included.

NONE - Enum constant in enum org.forgerock.json.jose.jws.JwsAlgorithmType

No digital signature or MAC value included.

NOPCompressionHandler - Class in org.forgerock.json.jose.jwe.handlers.compression

A NOP implementation of the Compression Handler, which will be used when no compression is to be applied.

NOPCompressionHandler() - Constructor for class org.forgerock.json.jose.jwe.handlers.compression.NOPCompressionHandler

NOPSigningHandler - Class in org.forgerock.json.jose.jws.handlers

An implementation of the SigningHandler which does not perform any signing or verifying.

NOPSigningHandler() - Constructor for class org.forgerock.json.jose.jws.handlers.NOPSigningHandler

O

OCT - Enum constant in enum org.forgerock.json.jose.jwk.KeyType

Octet Key.

OctJWK - Class in org.forgerock.json.jose.jwk

Creates an Octet JWK.

OctJWK(KeyUse, String, String, String, String, String, List<String>) - Constructor for class org.forgerock.json.jose.jwk.OctJWK

Constructs a OctJWK.

org.forgerock.json.jose.builders - package org.forgerock.json.jose.builders

Classes and interfaces for builder to build JWTs using a fluent API.

org.forgerock.json.jose.common - package org.forgerock.json.jose.common

Common classes and interfaces for all types of JWTs.

org.forgerock.json.jose.exceptions - package org.forgerock.json.jose.exceptions

Exceptions for all possible JWT exception scenarios.

org.forgerock.json.jose.jwe - package org.forgerock.json.jose.jwe

Classes and interfaces for JWT encryption and JWEs.

org.forgerock.json.jose.jwe.handlers.compression - package org.forgerock.json.jose.jwe.handlers.compression

Compression Handler classes for each possible compression algorithm.

org.forgerock.json.jose.jwe.handlers.encryption - package org.forgerock.json.jose.jwe.handlers.encryption

Encryption Handler classes for each possible encryption algorithm.

org.forgerock.json.jose.jwk - package org.forgerock.json.jose.jwk

Classes and interfaces for creating and manipulating JWKs.

org.forgerock.json.jose.jwk.store - package org.forgerock.json.jose.jwk.store

This package contains classes to manage a JWKs URI.

org.forgerock.json.jose.jws - package org.forgerock.json.jose.jws

Classes and interfaces for JWT signing and JWS'.

org.forgerock.json.jose.jws.handlers - package org.forgerock.json.jose.jws.handlers

Signing Handler classes for each possible signing algorithm.

org.forgerock.json.jose.jwt - package org.forgerock.json.jose.jwt

Classes and interfaces for JWTs.

org.forgerock.json.jose.tokenhandler - package org.forgerock.json.jose.tokenhandler

JWT implementation(s) of TokenHandler.

org.forgerock.json.jose.utils - package org.forgerock.json.jose.utils

Utility classes for JWT creation and manipulation.

OtherFactors(String, String, String) - Constructor for class org.forgerock.json.jose.jwk.RsaJWK.OtherFactors

Creates the other prime factors.

OtherFactors(RSAOtherPrimeInfo) - Constructor for class org.forgerock.json.jose.jwk.RsaJWK.OtherFactors

Create other prime factors.

P

P256 - Enum constant in enum org.forgerock.json.jose.jws.SupportedEllipticCurve

NIST P-256.

P384 - Enum constant in enum org.forgerock.json.jose.jws.SupportedEllipticCurve

NIST P-384.

P521 - Enum constant in enum org.forgerock.json.jose.jws.SupportedEllipticCurve

NIST P-521.

parse(String) - Static method in class org.forgerock.json.jose.jwk.EcJWK

Parses a JWK from a string json object.

parse(String) - Static method in class org.forgerock.json.jose.jwk.JWK

Parses a String into the proper JWK type.

parse(String) - Static method in class org.forgerock.json.jose.jwk.JWKSet

Parses a JWKSet object from a string json object.

parse(String) - Static method in class org.forgerock.json.jose.jwk.OctJWK

Parses a OctJWK object from a string json object.

parse(String) - Static method in class org.forgerock.json.jose.jwk.RsaJWK

Parses a RsaJWK from a json string.

parse(JsonValue) - Static method in class org.forgerock.json.jose.jwk.EcJWK

Parses a JWK from a JsonValue json object.

parse(JsonValue) - Static method in class org.forgerock.json.jose.jwk.JWK

Parses a JsonValue into the proper JWK type.

parse(JsonValue) - Static method in class org.forgerock.json.jose.jwk.JWKSet

Parses a JWKSet object from a jsonValue object.

parse(JsonValue) - Static method in class org.forgerock.json.jose.jwk.OctJWK

Parses a OctJWK object from a jsonValue object.

parse(JsonValue) - Static method in class org.forgerock.json.jose.jwk.RsaJWK

Parses a RsaJWK from a jsonValue Object.

parseAlgorithm(String) - Static method in enum org.forgerock.json.jose.jwe.CompressionAlgorithm

Parses the given algorithm string to find the matching CompressionAlgorithm enum constant.

parseAlgorithm(String) - Static method in enum org.forgerock.json.jose.jwe.JweAlgorithm

Parses the given algorithm string to find the matching EncryptionMethod enum constant.

parseCryptographicAlgorithm(String) - Static method in enum org.forgerock.json.jose.jws.JwsAlgorithm

Parses the given algorithm string to find the matching Java Cryptographic algorithm name.

parseJson(String) - Static method in class org.forgerock.json.jose.utils.Utils

Parses the given JSON string into a NoDuplicatesMap.

parseMethod(String) - Static method in enum org.forgerock.json.jose.jwe.EncryptionMethod

Parses the given algorithm string to find the matching EncryptionMethod enum constant.

Payload - Interface in org.forgerock.json.jose.jwt

The interface represents the body of a JWT.

put(String, Object) - Method in class org.forgerock.json.jose.jwt.JWObject

Sets or removes the value of the specified member.

R

readLength(ByteBuffer) - Static method in class org.forgerock.json.jose.utils.DerUtils

Reads a DER-encoded length field from the given byte buffer.

readUnsignedInteger(ByteBuffer, byte[], int, int) - Static method in class org.forgerock.json.jose.utils.DerUtils

Reads an unsigned integer value into the given byte array.

reconstruct(String, Class<T>) - Method in class org.forgerock.json.jose.builders.JwtBuilderFactory

Reconstructs the given JWT string into a JWT object of the specified type.

reconstructJwt(String, Class<T>) - Method in class org.forgerock.json.jose.common.JwtReconstruction

Reconstructs the given JWT string into a JWT object of the specified type.

removeJwksStore(String) - Method in class org.forgerock.json.jose.jwk.store.JwksStoreService

Remove the corresponding jwks store if exist.

RS256 - Enum constant in enum org.forgerock.json.jose.jws.JwsAlgorithm

RSA using SHA-256 hash algorithm.

RSA - Enum constant in enum org.forgerock.json.jose.jwe.JweAlgorithmType

RSA encryption algorithm.

RSA - Enum constant in enum org.forgerock.json.jose.jwk.KeyType

RSA key.

RSA - Enum constant in enum org.forgerock.json.jose.jws.JwsAlgorithmType

RSA signing algorithm.

RSA_OAEP - Enum constant in enum org.forgerock.json.jose.jwe.JweAlgorithm

RSA in ECB mode with OAEP with SHA-1 and MGF1 padding.

RSA_OAEP_256 - Enum constant in enum org.forgerock.json.jose.jwe.JweAlgorithm

RSA in ECB mode with OAEP with SHA-256 and MGF1 with SHA-256 padding.

RSA15AES128CBCHS256EncryptionHandler - Class in org.forgerock.json.jose.jwe.handlers.encryption

Deprecated.

Use RSAEncryptionHandler and AESCBCHMACSHA2ContentEncryptionHandler instead.

RSA15AES128CBCHS256EncryptionHandler(SigningManager) - Constructor for class org.forgerock.json.jose.jwe.handlers.encryption.RSA15AES128CBCHS256EncryptionHandler

Deprecated.

Constructs a new RSA15AES128CBCHS256EncryptionHandler.

RSA15AES256CBCHS512EncryptionHandler - Class in org.forgerock.json.jose.jwe.handlers.encryption

Deprecated.

Use RSAEncryptionHandler and AESCBCHMACSHA2ContentEncryptionHandler instead.

RSA15AES256CBCHS512EncryptionHandler(SigningManager) - Constructor for class org.forgerock.json.jose.jwe.handlers.encryption.RSA15AES256CBCHS512EncryptionHandler

Deprecated.

Constructs a new RSA15AES256CBCHS512EncryptionHandler.

RSAEncryptionHandler - Class in org.forgerock.json.jose.jwe.handlers.encryption

Abstract base class for implementations of the RSAES-PKCS1-v1_5 and RSA-OAEP encryption schemes.

RSAEncryptionHandler(EncryptionMethod, JweAlgorithm) - Constructor for class org.forgerock.json.jose.jwe.handlers.encryption.RSAEncryptionHandler

Constructs a new RSAEncryptionHandler instance.

RSAES_PKCS1_V1_5 - Enum constant in enum org.forgerock.json.jose.jwe.JweAlgorithm

RSA in ECB mode with PKCS1 Padding.

RsaJWK - Class in org.forgerock.json.jose.jwk

Implements a RsaJWK.

RsaJWK(RSAPublicKey, RSAPrivateCrtKey, KeyUse, String, String, String, String, List<String>) - Constructor for class org.forgerock.json.jose.jwk.RsaJWK

Creates a RsaJWK.

RsaJWK(RSAPublicKey, RSAPrivateKey, KeyUse, String, String, String, String, List<String>) - Constructor for class org.forgerock.json.jose.jwk.RsaJWK

Creates a RsaJWK.

RsaJWK(RSAPublicKey, KeyUse, String, String, String, String, List<String>) - Constructor for class org.forgerock.json.jose.jwk.RsaJWK

Creates a RsaJWK.

RsaJWK(KeyUse, String, String, String, String, String, String, String, String, String, String, String, List<String>) - Constructor for class org.forgerock.json.jose.jwk.RsaJWK

Creates a RsaJWK.

RsaJWK(KeyUse, String, String, String, String, String, String, String, String, String, String, List<RsaJWK.OtherFactors>, String, String, List<String>) - Constructor for class org.forgerock.json.jose.jwk.RsaJWK

Creates a RsaJWK.

RsaJWK(KeyUse, String, String, String, String, String, String, String, List<String>) - Constructor for class org.forgerock.json.jose.jwk.RsaJWK

Creates a RsaJWK.

RsaJWK(KeyUse, String, String, String, String, String, String, List<String>) - Constructor for class org.forgerock.json.jose.jwk.RsaJWK

Creates a RsaJWK.

RsaJWK.OtherFactors - Class in org.forgerock.json.jose.jwk

Holds the other prime factors.

RSASigningHandler - Class in org.forgerock.json.jose.jws.handlers

An implementation of the SigningHandler which can sign and verify using algorithms from the RSA family.

RSASigningHandler(Key, SignatureUtil) - Constructor for class org.forgerock.json.jose.jws.handlers.RSASigningHandler

Constructs a new RSASigningHandler, with a SignatureUtil instance to delegate the signing and verifying calls to.

S

SEQUENCE_TAG - Static variable in class org.forgerock.json.jose.utils.DerUtils

DER tag for sequence values.

setAgreementPartyUInfo(String) - Method in class org.forgerock.json.jose.jwe.JweHeader

Sets the Agreement PartyUInfo header parameter for this JWE.

setAlgorithm(Algorithm) - Method in class org.forgerock.json.jose.jwt.JwtHeader

Sets the algorithm used to perform cryptographic signing and/or encryption on the JWT.

setCacheMissCacheTime(Duration) - Method in class org.forgerock.json.jose.jwk.store.JwksStore

Update the cache time before reload the cache in case of cache miss.

setCacheTimeout(Duration) - Method in class org.forgerock.json.jose.jwk.store.JwksStore

Update the cache timeout.

setClaim(String, Object) - Method in class org.forgerock.json.jose.jwt.JwtClaimsSet

Sets a claim with the specified name and value.

setClaims(Map<String, Object>) - Method in class org.forgerock.json.jose.jwt.JwtClaimsSet

Sets claims using the values contained in the specified map.

setCompressionAlgorithm(CompressionAlgorithm) - Method in class org.forgerock.json.jose.jws.JwtSecureHeader

Sets the Compression Algorithm header parameter for this JWE.

setContentType(String) - Method in class org.forgerock.json.jose.jws.JwtSecureHeader

Sets the content type header parameter for this JWS.

setCriticalHeaders(List<String>) - Method in class org.forgerock.json.jose.jws.JwtSecureHeader

Sets the critical header parameters for this JWS.

setEncryptionMethod(EncryptionMethod) - Method in class org.forgerock.json.jose.jwe.JweHeader

Sets the Encryption Method header parameter for this JWE.

setEphemeralPublicKey(JWK) - Method in class org.forgerock.json.jose.jwe.JweHeader

Sets the Ephemeral Public Key header parameter for this JWE.

setExpirationTime(Date) - Method in class org.forgerock.json.jose.jwt.JwtClaimsSet

Sets the expiration time of the JWT in the Claims Set.

setIssuedAtTime(Date) - Method in class org.forgerock.json.jose.jwt.JwtClaimsSet

Sets the time the JWT was issued at, in the Claims Set.

setIssuer(String) - Method in class org.forgerock.json.jose.jwt.JwtClaimsSet

Sets the issuer this JWT was issued by.

setIssuer(URI) - Method in class org.forgerock.json.jose.jwt.JwtClaimsSet

Sets the issuer this JWT was issued by.

setJsonWebKey(JWK) - Method in class org.forgerock.json.jose.jws.JwtSecureHeader

Sets the JSON Web Key header parameter for this JWS.

setJwkSetUrl(URL) - Method in class org.forgerock.json.jose.jws.JwtSecureHeader

Sets the JWK Set URL header parameter for this JWS.

setJwkUrl(URL) - Method in class org.forgerock.json.jose.jwk.store.JwksStore

Update the JWKs URI.

setJwtId(String) - Method in class org.forgerock.json.jose.jwt.JwtClaimsSet

Sets the unique ID of the JWT.

setKeyId(String) - Method in class org.forgerock.json.jose.jws.JwtSecureHeader

Sets the Key ID header parameter for this JWS.

setNotBeforeTime(Date) - Method in class org.forgerock.json.jose.jwt.JwtClaimsSet

Sets the time the JWT is not allowed to be processed before, in the Claims Set.

setParameter(String, Object) - Method in class org.forgerock.json.jose.jwe.JweHeader

setParameter(String, Object) - Method in class org.forgerock.json.jose.jws.JwtSecureHeader

Sets a header parameter with the specified key and value.

setParameter(String, Object) - Method in class org.forgerock.json.jose.jwt.JwtHeader

Sets a header parameter with the specified key and value.

setParameters(Map<String, Object>) - Method in class org.forgerock.json.jose.jwt.JwtHeader

Sets header parameters using the values contained in the specified map.

setSubject(String) - Method in class org.forgerock.json.jose.jwt.JwtClaimsSet

Sets the subject this JWT is issued to.

setSubject(URI) - Method in class org.forgerock.json.jose.jwt.JwtClaimsSet

Sets the subject this JWT is issued to.

setType(String) - Method in class org.forgerock.json.jose.jwt.JwtClaimsSet

Gets the type of the contents of the Claims Set.

setType(JwtType) - Method in class org.forgerock.json.jose.jwt.JwtHeader

Sets the type of JWT this header represents.

setX509CertificateChain(List<String>) - Method in class org.forgerock.json.jose.jws.JwtSecureHeader

Sets the X.509 Certificate Chain header parameter for this JWS.

setX509CertificateThumbprint(String) - Method in class org.forgerock.json.jose.jws.JwtSecureHeader

Sets the X.509 Certificate Thumbprint header parameter for this JWS.

setX509Url(URL) - Method in class org.forgerock.json.jose.jws.JwtSecureHeader

Sets the X.509 URL header parameter for this JWS.

SIG - Enum constant in enum org.forgerock.json.jose.jwk.KeyUse

Use Key as a signature key.

sign(SigningHandler, JwsAlgorithm) - Method in class org.forgerock.json.jose.builders.EncryptedJwtBuilder

Deprecated.

Use EncryptedJwtBuilder.signedWith(SigningHandler, JwsAlgorithm) instead.

sign(JwsAlgorithm, byte[]) - Method in class org.forgerock.json.jose.jws.handlers.ECDSASigningHandler

sign(JwsAlgorithm, byte[]) - Method in class org.forgerock.json.jose.jws.handlers.HmacSigningHandler

Signs the given raw data bytes using the Java Cryptographic algorithm defined by the JwsAlgorithm.

sign(JwsAlgorithm, byte[]) - Method in class org.forgerock.json.jose.jws.handlers.NOPSigningHandler

Returns an empty byte array.

sign(JwsAlgorithm, byte[]) - Method in class org.forgerock.json.jose.jws.handlers.RSASigningHandler

Signs the given raw data bytes using the Java Cryptographic algorithm defined by the JwsAlgorithm.

sign(JwsAlgorithm, byte[]) - Method in interface org.forgerock.json.jose.jws.handlers.SigningHandler

Signs the given raw data bytes using the Java Cryptographic algorithm defined by the JwsAlgorithm.

sign(JwsAlgorithm, String) - Method in class org.forgerock.json.jose.jws.handlers.ECDSASigningHandler

sign(JwsAlgorithm, String) - Method in class org.forgerock.json.jose.jws.handlers.HmacSigningHandler

Signs the given String data using the Java Cryptographic algorithm defined by the JwsAlgorithm.

sign(JwsAlgorithm, String) - Method in class org.forgerock.json.jose.jws.handlers.NOPSigningHandler

Simply returns a byte array of a UTF-8 empty string.

sign(JwsAlgorithm, String) - Method in class org.forgerock.json.jose.jws.handlers.RSASigningHandler

Signs the given String data using the Java Cryptographic algorithm defined by the JwsAlgorithm.

sign(JwsAlgorithm, String) - Method in interface org.forgerock.json.jose.jws.handlers.SigningHandler

Signs the given String data using the Java Cryptographic algorithm defined by the JwsAlgorithm.

SignedEncryptedJwsHeaderBuilder - Class in org.forgerock.json.jose.builders

Deprecated.

Use EncryptedThenSignedJwtHeaderBuilder instead.

SignedEncryptedJwsHeaderBuilder(EncryptedThenSignedJwtBuilder) - Constructor for class org.forgerock.json.jose.builders.SignedEncryptedJwsHeaderBuilder

Deprecated.

Constructs a new JwsHeaderBuilder, parented by the given JwtBuilder.

SignedEncryptedJwt - Class in org.forgerock.json.jose.jws

Deprecated.

Use EncryptedThenSignedJwt instead.

SignedEncryptedJwt(JwsHeader, EncryptedJwt, byte[], byte[]) - Constructor for class org.forgerock.json.jose.jws.SignedEncryptedJwt

Deprecated.

Constructs a reconstructed SignedEncryptedJwt from its constituent parts, the JwsHeader, nested Encrypted JWT, signing input and signature.

SignedEncryptedJwt(JwsHeader, EncryptedJwt, SigningHandler) - Constructor for class org.forgerock.json.jose.jws.SignedEncryptedJwt

Deprecated.

Constructs a fresh, new SignedEncryptedJwt from the given JwsHeader and nested Encrypted JWT.

SignedEncryptedJwtBuilder - Class in org.forgerock.json.jose.builders

Deprecated.

Use EncryptedThenSignedJwtBuilder instead.

SignedEncryptedJwtBuilder(EncryptedJwtBuilder, SigningHandler, JwsAlgorithm) - Constructor for class org.forgerock.json.jose.builders.SignedEncryptedJwtBuilder

Deprecated.

Constructs a new SignedEncryptedJwtBuilder that will use the given EncryptedJwtBuilder, to build the nested Encrypted JWT, and the private key and JwsAlgorithm to sign the outer JWT.

SignedJwt - Class in org.forgerock.json.jose.jws

A JWS implementation of the Jwt interface.

SignedJwt(JwsHeader, JwtClaimsSet, byte[], byte[]) - Constructor for class org.forgerock.json.jose.jws.SignedJwt

Constructs a reconstructed SignedJwt from its constituent parts, the JwsHeader, JwtClaimsSet, signing input and signature.

SignedJwt(JwsHeader, JwtClaimsSet, SigningHandler) - Constructor for class org.forgerock.json.jose.jws.SignedJwt

Constructs a fresh, new SignedJwt from the given JwsHeader and JwtClaimsSet.

SignedJwt(JwsHeader, Payload, byte[], byte[]) - Constructor for class org.forgerock.json.jose.jws.SignedJwt

Constructs a reconstructed SignedJwt from its constituent parts, the JwsHeader, nested Encrypted JWT, signing input and signature.

SignedJwt(JwsHeader, Payload, SigningHandler) - Constructor for class org.forgerock.json.jose.jws.SignedJwt

Constructs a fresh, new SignedJwt from the given JwsHeader and nested Encrypted JWT.

SignedJwtBuilder - Interface in org.forgerock.json.jose.builders

A base interface for both SignedJwtBuilder and SignedEncryptedJwtBuilder to create Signed JWTs and Signed and Encrypted JWTs.

SignedJwtBuilderImpl - Class in org.forgerock.json.jose.builders

An implementation of a JwtBuilder that can build a JWT and sign it, resulting in a SignedJwt object.

SignedJwtBuilderImpl(SigningHandler) - Constructor for class org.forgerock.json.jose.builders.SignedJwtBuilderImpl

Constructs a new SignedJwtBuilderImpl that will use the given private key to sign the JWT.

SignedThenEncryptedJwt - Class in org.forgerock.json.jose.jwe

A nested signed-then-encrypted JWT.

SignedThenEncryptedJwt(JweHeader, String, byte[], byte[], byte[], byte[]) - Constructor for class org.forgerock.json.jose.jwe.SignedThenEncryptedJwt

Reconstructs a signed-then-encrypted JWT from components parts of the encrypted JWT string.

SignedThenEncryptedJwt(JweHeader, SignedJwt, Key) - Constructor for class org.forgerock.json.jose.jwe.SignedThenEncryptedJwt

Constructs a fresh signed-then-encrypted JWT with the given signed JWT payload, JWE headers and encryption key.

SignedThenEncryptedJwtBuilder - Class in org.forgerock.json.jose.builders

Builder for nested signed-then-encrypted JWT.

signedWith(SigningHandler, JwsAlgorithm) - Method in class org.forgerock.json.jose.builders.EncryptedJwtBuilder

Returns an EncryptedThenSignedJwtBuilder that will build a signed JWT with this builder's encrypted JWT as its payload.

SigningHandler - Interface in org.forgerock.json.jose.jws.handlers

The interface for SigningHandlers for all the different signing algorithms.

SigningManager - Class in org.forgerock.json.jose.jws

A service to get the appropriate SigningHandler for a specific Java Cryptographic signing algorithm.

SigningManager() - Constructor for class org.forgerock.json.jose.jws.SigningManager

StringOrURI - Class in org.forgerock.json.jose.utils

This class provides an utility method for validating that a String is either an arbitrary string without any ":" characters or if the String does contain a ":" character then the String is a valid URI.

sub(String) - Method in class org.forgerock.json.jose.builders.JwtClaimsSetBuilder

Sets the subject this JWT is issued to.

sub(URI) - Method in class org.forgerock.json.jose.builders.JwtClaimsSetBuilder

Sets the subject this JWT is issued to.

SUB - Enum constant in enum org.forgerock.json.jose.jwt.JwtClaimsSetKey

Subject Claim.

SupportedEllipticCurve - Enum in org.forgerock.json.jose.jws

Enumerates all supported elliptic curve parameters for ESXXX signature formats.

T

toBytesUnsigned(BigInteger) - Static method in class org.forgerock.json.jose.utils.BigIntegerUtils

Returns the magnitude big-endian byte array of a big integer.

toECPrivateKey() - Method in class org.forgerock.json.jose.jwk.EcJWK

Converts the JWK to a ECPrivateKey.

toECPublicKey() - Method in class org.forgerock.json.jose.jwk.EcJWK

Converts the JWK to a ECPublicKey.

toIntDate(Date) - Static method in class org.forgerock.json.jose.utils.IntDate

Converts a Java Date object into an IntDate.

toJsonString() - Method in class org.forgerock.json.jose.jwk.EcJWK

Prints the JWK as a String json object.

toJsonString() - Method in class org.forgerock.json.jose.jwk.JWK

Prints the JWK Object as a json string.

toJsonString() - Method in class org.forgerock.json.jose.jwk.JWKSet

Prints the JWK Set as a json string.

toJsonString() - Method in class org.forgerock.json.jose.jwk.OctJWK

Prints the JWK as a json string.

toJsonString() - Method in class org.forgerock.json.jose.jwk.RsaJWK

Prints the RsaJWK object as a json string.

toJsonValue() - Method in class org.forgerock.json.jose.jwt.JWObject

Returns a json representation of the JWObject.

toJsonValue(String) - Static method in class org.forgerock.json.jose.jwk.JWK

Converts a String into a JsonValue.

toJsonValue(String) - Static method in class org.forgerock.json.jose.jwk.JWKSet

Converts a json string to a jsonValue.

toKeyPair() - Method in class org.forgerock.json.jose.jwk.EcJWK

Converts the JWK to a KeyPair.

toKeyPair() - Method in class org.forgerock.json.jose.jwk.RsaJWK

Create a KeyPair using the JWK.

toRSAPrivateKey() - Method in class org.forgerock.json.jose.jwk.RsaJWK

Creates a RSAPrivateKey from the JWK.

toRSAPublicKey() - Method in class org.forgerock.json.jose.jwk.RsaJWK

Creates a RSAPublicKey from the JWK.

toString() - Method in enum org.forgerock.json.jose.jwe.EncryptionMethod

Turns the EncryptionMethod constant into a JSON value string.

toString() - Method in enum org.forgerock.json.jose.jwe.JweAlgorithm

Turns the JweAlgorithm constant into a JSON value string.

toString() - Method in enum org.forgerock.json.jose.jwe.JweAlgorithmType

Turns the JweAlgorithmType constant into a JSON value string.

toString() - Method in enum org.forgerock.json.jose.jwe.JweHeaderKey

Turns the JweHeaderKey constant into a lowercase String.

toString() - Method in enum org.forgerock.json.jose.jwk.KeyType

Gets the value of the KeyType.

toString() - Method in enum org.forgerock.json.jose.jwk.KeyUse

Prints the KeyUse value.

toString() - Method in enum org.forgerock.json.jose.jws.JwsAlgorithm

Turns the JwsAlgorithm constant into a JSON value string.

toString() - Method in enum org.forgerock.json.jose.jws.JwsAlgorithmType

Turns the JwsAlgorithmType constant into a JSON value string.

toString() - Method in enum org.forgerock.json.jose.jws.JwsHeaderKey

Turns the JwsHeaderKey constant into a lowercase String.

toString() - Method in class org.forgerock.json.jose.jwt.JWObject

Returns a string representation of the JWObject.

toString() - Method in enum org.forgerock.json.jose.jwt.JwtClaimsSetKey

Turns the JwtClaimsSetKey constant into a lowercase String.

toString() - Method in enum org.forgerock.json.jose.jwt.JwtHeaderKey

Turns the JwtHeaderKey constant into a lowercase String.

typ(JwtType) - Method in class org.forgerock.json.jose.builders.JwtClaimsSetBuilder

Sets the type of the contents of the Claims Set.

TYP - Enum constant in enum org.forgerock.json.jose.jwt.JwtClaimsSetKey

Type Claim.

TYP - Enum constant in enum org.forgerock.json.jose.jwt.JwtHeaderKey

Type JWT header parameter..

U

USE - Static variable in class org.forgerock.json.jose.jwk.JWK

The KeyUse key.

Utils - Class in org.forgerock.json.jose.utils

This class provides utility methods to share common behaviour.

V

validate(String) - Method in class org.forgerock.json.jose.tokenhandler.JwtTokenHandler

validateAndExtractState(String) - Method in class org.forgerock.json.jose.tokenhandler.JwtTokenHandler

validateStringOrURI(String) - Static method in class org.forgerock.json.jose.utils.StringOrURI

Validates that the given String is either an arbitrary string without any ":" characters, otherwise validates that the String is a valid URI.

value() - Method in enum org.forgerock.json.jose.jwe.JweHeaderKey

Returns a lowercase String of the JweHeaderKey constant.

value() - Method in enum org.forgerock.json.jose.jwk.KeyType

Get the value of the KeyType.

value() - Method in enum org.forgerock.json.jose.jwk.KeyUse

Get the Value of the KeyUse.

value() - Method in enum org.forgerock.json.jose.jws.JwsHeaderKey

Returns a lowercase String of the JwsHeaderKey constant.

value() - Method in enum org.forgerock.json.jose.jwt.JwtClaimsSetKey

Returns a lowercase String of the JwtClaimsSetKey constant.

value() - Method in enum org.forgerock.json.jose.jwt.JwtHeaderKey

Returns a lowercase String of the JwtHeaderKey constant.

valueOf(String) - Static method in enum org.forgerock.json.jose.jwe.CompressionAlgorithm

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

valueOf(String) - Static method in enum org.forgerock.json.jose.jwe.EncryptionMethod

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

valueOf(String) - Static method in enum org.forgerock.json.jose.jwe.JweAlgorithm

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

valueOf(String) - Static method in enum org.forgerock.json.jose.jwe.JweAlgorithmType

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

valueOf(String) - Static method in enum org.forgerock.json.jose.jwe.JweHeaderKey

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

valueOf(String) - Static method in enum org.forgerock.json.jose.jwk.KeyType

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

valueOf(String) - Static method in enum org.forgerock.json.jose.jwk.KeyUse

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

valueOf(String) - Static method in enum org.forgerock.json.jose.jws.JwsAlgorithm

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

valueOf(String) - Static method in enum org.forgerock.json.jose.jws.JwsAlgorithmType

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

valueOf(String) - Static method in enum org.forgerock.json.jose.jws.JwsHeaderKey

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

valueOf(String) - Static method in enum org.forgerock.json.jose.jws.SupportedEllipticCurve

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

valueOf(String) - Static method in enum org.forgerock.json.jose.jwt.JwtClaimsSetKey

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

valueOf(String) - Static method in enum org.forgerock.json.jose.jwt.JwtHeaderKey

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

valueOf(String) - Static method in enum org.forgerock.json.jose.jwt.JwtType

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

values() - Static method in enum org.forgerock.json.jose.jwe.CompressionAlgorithm

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

values() - Static method in enum org.forgerock.json.jose.jwe.EncryptionMethod

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

values() - Static method in enum org.forgerock.json.jose.jwe.JweAlgorithm

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

values() - Static method in enum org.forgerock.json.jose.jwe.JweAlgorithmType

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

values() - Static method in enum org.forgerock.json.jose.jwe.JweHeaderKey

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

values() - Static method in enum org.forgerock.json.jose.jwk.KeyType

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

values() - Static method in enum org.forgerock.json.jose.jwk.KeyUse

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

values() - Static method in enum org.forgerock.json.jose.jws.JwsAlgorithm

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

values() - Static method in enum org.forgerock.json.jose.jws.JwsAlgorithmType

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

values() - Static method in enum org.forgerock.json.jose.jws.JwsHeaderKey

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

values() - Static method in enum org.forgerock.json.jose.jws.SupportedEllipticCurve

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

values() - Static method in enum org.forgerock.json.jose.jwt.JwtClaimsSetKey

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

values() - Static method in enum org.forgerock.json.jose.jwt.JwtHeaderKey

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

values() - Static method in enum org.forgerock.json.jose.jwt.JwtType

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

verify(SigningHandler) - Method in class org.forgerock.json.jose.jwe.SignedThenEncryptedJwt

Verifies that the signature is valid on the nested signed JWT.

verify(SigningHandler) - Method in class org.forgerock.json.jose.jws.SignedJwt

Verifies that the JWS signature is valid for the contents of its payload.

verify(JwsAlgorithm, byte[], byte[]) - Method in class org.forgerock.json.jose.jws.handlers.ECDSASigningHandler

verify(JwsAlgorithm, byte[], byte[]) - Method in class org.forgerock.json.jose.jws.handlers.HmacSigningHandler

Verifies that the given signature is valid for the given data.

verify(JwsAlgorithm, byte[], byte[]) - Method in class org.forgerock.json.jose.jws.handlers.NOPSigningHandler

Verifies that the signature length is zero.

verify(JwsAlgorithm, byte[], byte[]) - Method in class org.forgerock.json.jose.jws.handlers.RSASigningHandler

Verifies that the given signature is valid for the given data.

verify(JwsAlgorithm, byte[], byte[]) - Method in interface org.forgerock.json.jose.jws.handlers.SigningHandler

Verifies that the given signature is valid for the given data.

W

writeInteger(ByteBuffer, byte[]) - Static method in class org.forgerock.json.jose.utils.DerUtils

Writes an integer value in DER format to the given buffer.

writeJsonObject(Map<String, Object>) - Static method in class org.forgerock.json.jose.utils.Utils

Writes the given map as a string in JSON object format.

writeLength(ByteBuffer, int) - Static method in class org.forgerock.json.jose.utils.DerUtils

Writes a length field to the output.

X

x5c(List<String>) - Method in class org.forgerock.json.jose.builders.JwtSecureHeaderBuilder

Sets the X.509 Certificate Chain header parameter for this JWS.

X5C - Enum constant in enum org.forgerock.json.jose.jws.JwsHeaderKey

X.509 Certificate Chain header parameter.

X5C - Static variable in class org.forgerock.json.jose.jwk.JWK

The X509 chain key.

x5t(String) - Method in class org.forgerock.json.jose.builders.JwtSecureHeaderBuilder

Sets the X.509 Certificate Thumbprint header parameter for this JWS.

X5T - Enum constant in enum org.forgerock.json.jose.jws.JwsHeaderKey

X.509 Certificate Thumbprint header parameter.

X5T - Static variable in class org.forgerock.json.jose.jwk.JWK

The X509 thumbnail key.

x5u(URL) - Method in class org.forgerock.json.jose.builders.JwtSecureHeaderBuilder

Sets the X.509 URL header parameter for this JWS.

X5U - Enum constant in enum org.forgerock.json.jose.jws.JwsHeaderKey

X.509 URL header parameter.

X5U - Static variable in class org.forgerock.json.jose.jwk.JWK

The X509 URL key.

Z

zip(CompressionAlgorithm) - Method in class org.forgerock.json.jose.builders.JweHeaderBuilder

zip(CompressionAlgorithm) - Method in class org.forgerock.json.jose.builders.JwtSecureHeaderBuilder

Sets the Compression Algorithm header parameter for this JWE.

ZIP - Enum constant in enum org.forgerock.json.jose.jwe.JweHeaderKey

Compression Algorithm header parameter.

A B C D E F G H I J K L N O P R S T U V W X Z
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form