com.nimbusds.jose.jwk

Class OctetSequenceKey.Builder

java.lang.Object

com.nimbusds.jose.jwk.OctetSequenceKey.Builder

Enclosing class:

OctetSequenceKey

public static class OctetSequenceKey.Builder
extends Object

Implements a builder pattern for constructing octet sequence JWKs.

Example use:

 OctetSequenceKey key = new OctetSequenceKey.Builder(k).
                        setAlgorithm(JWSAlgorithm.HS512).
                        setKeyID("123").
                        build();
 

Constructor Summary

Constructors

Constructor and Description
OctetSequenceKey.Builder(Base64URL k) Creates a new octet sequence JWK builder.

Method Summary

Methods

Modifier and Type	Method and Description
OctetSequenceKey	build() Builds a new octet sequence JWK.
OctetSequenceKey.Builder	setAlgorithm(Algorithm alg) Sets the intended JOSE algorithm (alg) for the JWK.
OctetSequenceKey.Builder	setKeyID(String kid) Sets the ID (kid) of the JWK.
OctetSequenceKey.Builder	setKeyUse(Use use) Sets the use (use) of the JWK.
OctetSequenceKey.Builder	setX509CertChain(List<Base64> x5c) Sets the X.509 certificate chain (x5c) of the JWK.
OctetSequenceKey.Builder	setX509CertThumbprint(Base64URL x5t) Sets the X.509 certificate thumbprint (x5t) of the JWK.
OctetSequenceKey.Builder	setX509CertURL(URL x5u) Sets the X.509 certificate URL (x5u) of the JWK.

Methods inherited from class java.lang.Object

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

Constructor Detail

OctetSequenceKey.Builder

public OctetSequenceKey.Builder(Base64URL k)

Creates a new octet sequence JWK builder.

Parameters:

k - The key value. It is represented as the Base64URL encoding of value's big endian representation. Must not be null.

Method Detail

setKeyUse

public OctetSequenceKey.Builder setKeyUse(Use use)

Sets the use (use) of the JWK.

Parameters:

use - The key use, null if not specified or if the key is intended for signing as well as encryption.

Returns:

This builder.

setAlgorithm

public OctetSequenceKey.Builder setAlgorithm(Algorithm alg)

Sets the intended JOSE algorithm (alg) for the JWK.

Parameters:

alg - The intended JOSE algorithm, null if not specified.

Returns:

This builder.

setKeyID

public OctetSequenceKey.Builder setKeyID(String kid)

Sets the ID (kid) of the JWK. The key ID can be used to match a specific key. This can be used, for instance, to choose a key within a JWKSet during key rollover. The key ID may also correspond to a JWS/JWE kid header parameter value.

Parameters:

kid - The key ID, null if not specified.

Returns:

This builder.

setX509CertURL

public OctetSequenceKey.Builder setX509CertURL(URL x5u)

Sets the X.509 certificate URL (x5u) of the JWK.

Parameters:

x5u - The X.509 certificate URL, null if not specified.

Returns:

This builder.

setX509CertThumbprint

public OctetSequenceKey.Builder setX509CertThumbprint(Base64URL x5t)

Sets the X.509 certificate thumbprint (x5t) of the JWK.

Parameters:

x5t - The X.509 certificate thumbprint, null if not specified.

Returns:

This builder.

setX509CertChain

public OctetSequenceKey.Builder setX509CertChain(List<Base64> x5c)

Sets the X.509 certificate chain (x5c) of the JWK.

Parameters:

x5c - The X.509 certificate chain as a unmodifiable list, null if not specified.

Returns:

This builder.

build

public OctetSequenceKey build()

Builds a new octet sequence JWK.

Returns:

The octet sequence JWK.