Package org.forgerock.json.jose.jwk

Class JWK

java.lang.Object

org.forgerock.json.jose.jwt.JWObject

org.forgerock.json.jose.jwk.JWK

Direct Known Subclasses:

EcJWK, OctJWK, RsaJWK

public abstract class JWK
extends JWObject

The abstract base class for the 3 implementations of JWK.

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	ALG	The Algorithm key.
protected static final String	KID	The KeyID key.
protected static final String	KTY	The KeyType key.
protected static final String	USE	The KeyUse key.
protected static final String	X5C	The X509 chain key.
protected static final String	X5T	The X509 thumbnail key.
protected static final String	X5U	The X509 URL key.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	JWK(KeyType kty, KeyUse use, String alg, String kid)	Creates a JWK given the basic parameters.
protected	JWK(KeyType kty, KeyUse use, String alg, String kid, String x5u, String x5t, List<String> x5c)	Creates a JWK given the basic parameters.

Method Summary

Modifier and Type	Method	Description
String	getAlgorithm()	Gets the alg parameter of the JWK.
String	getKeyId()	Gets the kid parameter of the JWK.
KeyType	getKeyType()	Gets the kty parameter of the JWK.
KeyUse	getUse()	Gets the use parameter of the JWK.
List<String>	getX509Chain()	Gets a List of X509 chain certs.
String	getX509Thumbnail()	Gets the X509 thumbnail.
String	getX509URL()	Gets the X509 URL.
static JWK	parse(String json)	Parses a String into the proper JWK type.
static JWK	parse(JsonValue jwk)	Parses a JsonValue into the proper JWK type.
String	toJsonString()	Prints the JWK Object as a json string.
protected static JsonValue	toJsonValue(String json)	Converts a String into a JsonValue.

Methods inherited from class org.forgerock.json.jose.jwt.JWObject

checkListValuesAreOfType, checkValueIsOfType, get, isDefined, isValueOfType, keys, put, toJsonValue, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

KTY

protected static final String KTY

The KeyType key.

See Also:

• Constant Field Values

USE

protected static final String USE

The KeyUse key.

See Also:

• Constant Field Values

ALG

protected static final String ALG

The Algorithm key.

See Also:

• Constant Field Values

KID

protected static final String KID

The KeyID key.

See Also:

• Constant Field Values

X5U

protected static final String X5U

The X509 URL key.

See Also:

• Constant Field Values

X5T

protected static final String X5T

The X509 thumbnail key.

See Also:

• Constant Field Values

X5C

protected static final String X5C

The X509 chain key.

See Also:

• Constant Field Values

Constructor Details

JWK

protected JWK(KeyType kty,
 KeyUse use,
 String alg,
 String kid)

Creates a JWK given the basic parameters.

Parameters:

kty - the JWK key type

use - the JWK use

alg - the JWK algorithm

kid - the JWK key id

JWK

protected JWK(KeyType kty,
 KeyUse use,
 String alg,
 String kid,
 String x5u,
 String x5t,
 List<String> x5c)

Creates a JWK given the basic parameters.

Parameters:

kty - the JWK key type

use - the JWK use

alg - the JWK algorithm

kid - the JWK key id

x5u - the x509 url for the key

x5t - the x509 thumbnail for the key

x5c - the x509 chain as a list of Base64 encoded strings

Method Details

getKeyType

public KeyType getKeyType()

Gets the kty parameter of the JWK.

Returns:

A KeyType for the JWK

getUse

public KeyUse getUse()

Gets the use parameter of the JWK.

Returns:

A String representing the use parameter

getAlgorithm

public String getAlgorithm()

Gets the alg parameter of the JWK.

Returns:

A String representing the alg parameter

getKeyId

public String getKeyId()

Gets the kid parameter of the JWK.

Returns:

A String representing the kid parameter

toJsonString

public String toJsonString()

Prints the JWK Object as a json string.

Returns:

A String representing JWK

parse

public static JWK parse(String json)

Parses a String into the proper JWK type.

Parameters:

json - The json String.

Returns:

A JWK object

Throws:

JsonException - If there is a problem parsing the json String.

parse

public static JWK parse(JsonValue jwk)

Parses a JsonValue into the proper JWK type.

Parameters:

jwk - The JsonValue Object.

Returns:

A JWK object

Throws:

JsonException - If there is a problem parsing the json String.

toJsonValue

protected static JsonValue toJsonValue(String json)

Converts a String into a JsonValue.

Parameters:

json - The json String.

Returns:

A JsonValue object.

Throws:

JsonException - If there is a problem parsing the json String.

getX509URL

public String getX509URL()

Gets the X509 URL.

Returns:

the url of the 509 cert header or null

getX509Thumbnail

public String getX509Thumbnail()

Gets the X509 thumbnail.

Returns:

Base64url of the X509 thumbnail

getX509Chain

public List<String> getX509Chain()

Gets a List of X509 chain certs.

Returns:

X509 Cert Chain as list of encoded strings or null if none are available.