org.forgerock.json.jose.jwk

Class JWK.Builder<B extends JWK.Builder>

java.lang.Object

org.forgerock.json.jose.jwk.JWK.Builder<B>

Type Parameters:

B - The current builder.

Direct Known Subclasses:

EcJWK.Builder, OctJWK.Builder, OkpJWK.Builder, RsaJWK.Builder

Enclosing class:

JWK

public abstract static class JWK.Builder<B extends JWK.Builder>
extends Object

JWK builder.

Field Summary

Fields

Modifier and Type	Field and Description
protected Algorithm	algorithm The intended JOSE algorithm for the key, optional.
protected String	keyId The key ID, optional.
protected Set<KeyOperation>	keyOperations The key operations, optional.
protected KeyType	keyType The key type, required.
protected KeyUse	use The key use, optional.
protected List<String>	x509Chain The X.509 certificate chain, optional.
protected String	x509Thumbnail X.509 certificate thumbprint, optional.
protected String	x509url X.509 certificate URL, optional.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Builder(KeyType keyType) The builder constructor.

Method Summary

Modifier and Type	Method and Description
B	algorithm(Algorithm algorithm) Sets the algorithm parameter of the JWK.
B	algorithm(String algorithm) Sets the algorithm parameter of the JWK.
abstract JWK	build() Builds the JWK.
B	keyId(String keyId) Sets the keyId parameter of the JWK.
B	keyOperations(Set<KeyOperation> keyOperations) Set the key operations parameter of the JWK.
B	keyUse(KeyUse use) Set the key use parameter of the JWK.
B	x509Chain(List<String> x509Chain) Set the X509 certificates attributes.
B	x509Thumbnail(String x509Thumbnail) Gets the X509 thumbnail.
B	x509Url(String x509url) Gets the X509 URL.

Methods inherited from class java.lang.Object

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

Field Detail

keyType

protected KeyType keyType

The key type, required.

use

protected KeyUse use

The key use, optional.

keyOperations

protected Set<KeyOperation> keyOperations

The key operations, optional.

algorithm

protected Algorithm algorithm

The intended JOSE algorithm for the key, optional.

keyId

protected String keyId

The key ID, optional.

x509url

protected String x509url

X.509 certificate URL, optional.

x509Thumbnail

protected String x509Thumbnail

X.509 certificate thumbprint, optional.

x509Chain

protected List<String> x509Chain

The X.509 certificate chain, optional.

Constructor Detail

Builder

protected Builder(KeyType keyType)

The builder constructor.

Parameters:

keyType - the JWK key type

Method Detail

keyUse

public B keyUse(KeyUse use)

Set the key use parameter of the JWK.

Parameters:

use - the JWK use

Returns:

the current builder

keyOperations

public B keyOperations(Set<KeyOperation> keyOperations)

Set the key operations parameter of the JWK.

Parameters:

keyOperations - the JWK key Operations

Returns:

the current builder

algorithm

public B algorithm(Algorithm algorithm)

Sets the algorithm parameter of the JWK.

Parameters:

algorithm - the JWK algorithm

Returns:

the current builder

algorithm

public B algorithm(String algorithm)

Sets the algorithm parameter of the JWK.

Parameters:

algorithm - the JWK algorithm

Returns:

the current builder

keyId

public B keyId(String keyId)

Sets the keyId parameter of the JWK.

Parameters:

keyId - the JWK key id

Returns:

the current builder

x509Url

public B x509Url(String x509url)

Gets the X509 URL.

Parameters:

x509url - the x509 url for the key

Returns:

the current builder

x509Thumbnail

public B x509Thumbnail(String x509Thumbnail)

Gets the X509 thumbnail.

Parameters:

x509Thumbnail - the x509 thumbnail for the key

Returns:

the current builder

x509Chain

public B x509Chain(List<String> x509Chain)

Set the X509 certificates attributes.

Parameters:

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

Returns:

the current builder

build

public abstract JWK build()

Builds the JWK.

Returns:

the JWK.