org.forgerock.json.jose.jwk

Class OctJWK

java.lang.Object

org.forgerock.json.jose.jwk.JWK

org.forgerock.json.jose.jwk.OctJWK

public class OctJWK
extends JWK

Creates an Octet JWK.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OctJWK.Builder The Octet JWK builder.

Field Summary

Fields inherited from class org.forgerock.json.jose.jwk.JWK

JSON_KEY_ALG, JSON_KEY_KID, JSON_KEY_KTY, JSON_KEY_OPERATIONS, JSON_KEY_USE, JSON_KEY_X5C, JSON_KEY_X5T, JSON_KEY_X5U

Constructor Summary

Constructors

Constructor and Description
OctJWK(KeyUse use, String alg, String kid, String key, String x5u, String x5t, List<String> x5c) Deprecated. Use the builder instead.

Method Summary

Modifier and Type	Method and Description
static OctJWK.Builder	builder(String key) Get the Octet JWK builder.
String	getKey() Gets the symmetric key.
protected Optional<JWK.Builder<?>>	getPublicJwkBuilder() Return a builder with all the values set for representing the public components of the JWK.
boolean	isPrivate() Indicates if any private key attributes are present in the JWK.
static OctJWK	parse(JsonValue json) Parses a OctJWK object from a jsonValue object.
static OctJWK	parse(String json) Parses a OctJWK object from a string json object.
String	toJsonString() Prints the JWK as a json string.
JsonValue	toJsonValue() Returns a json representation of the JWK.
SecretKey	toSecretKey() Returns the key as a secret key.

Methods inherited from class org.forgerock.json.jose.jwk.JWK

getAlgorithm, getAlgorithm, getJwaAlgorithm, getKeyId, getKeyOperations, getKeyType, getUse, getX509Chain, getX509Thumbnail, getX509URL, loadJWKFromJson, putField, toJsonValue, toPublicJwk

Methods inherited from class java.lang.Object

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

Constructor Detail

OctJWK

@Deprecated
public OctJWK(KeyUse use,
                          String alg,
                          String kid,
                          String key,
                          String x5u,
                          String x5t,
                          List<String> x5c)

Deprecated. Use the builder instead.

Constructs a OctJWK.

Parameters:

use - the JWK use

alg - the JWK algorithm

kid - the JWK key id

key - the symmetric key

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 Detail

builder

public static OctJWK.Builder builder(String key)

Get the Octet JWK builder.

Parameters:

key - the symmetric key

Returns:

the builder

getKey

public String getKey()

Gets the symmetric key.

Returns:

the symmetric key that is Base64url encoded

toSecretKey

public SecretKey toSecretKey()

Returns the key as a secret key.

Returns:

the secret key bytes.

parse

public static OctJWK parse(String json)

Parses a OctJWK object from a string json object.

Parameters:

json - string json object

Returns:

a OctJWK

parse

public static OctJWK parse(JsonValue json)

Parses a OctJWK object from a jsonValue object.

Parameters:

json - an JsonValue object

Returns:

a OctJWK

toJsonString

public String toJsonString()

Prints the JWK as a json string.

Overrides:

toJsonString in class JWK

Returns:

json string

toJsonValue

public JsonValue toJsonValue()

Description copied from class: JWK

Returns a json representation of the JWK.

Overrides:

toJsonValue in class JWK

Returns:

A JSON representation.

isPrivate

public boolean isPrivate()

Description copied from class: JWK

Indicates if any private key attributes are present in the JWK.

Overrides:

isPrivate in class JWK

Returns:

true if this JWK contains any private key attributes.

getPublicJwkBuilder

protected Optional<JWK.Builder<?>> getPublicJwkBuilder()

Description copied from class: JWK

Return a builder with all the values set for representing the public components of the JWK. Common JWK attributes will be added in JWK.toPublicJwk().

Specified by:

getPublicJwkBuilder in class JWK

Returns:

The builder.