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 java.lang.Object

Builder for constructing octet sequence JWKs.

Example use:

 OctetSequenceKey key = new OctetSequenceKey.Builder(k).
                        algorithm(JWSAlgorithm.HS512).
                        keyID("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.Builder	algorithm(Algorithm alg) Sets the intended JOSE algorithm (alg) for the JWK.
OctetSequenceKey	build() Builds a new octet sequence JWK.
OctetSequenceKey.Builder	keyID(java.lang.String kid) Sets the ID (kid) of the JWK.
OctetSequenceKey.Builder	keyOperations(java.util.Set<KeyOperation> ops) Sets the operations (key_ops) of the JWK (for a non-public key).
OctetSequenceKey.Builder	keyUse(KeyUse use) Sets the use (use) of the JWK.
OctetSequenceKey.Builder	x509CertChain(java.util.List<Base64> x5c) Sets the X.509 certificate chain (x5c) of the JWK.
OctetSequenceKey.Builder	x509CertThumbprint(Base64URL x5t) Sets the X.509 certificate thumbprint (x5t) of the JWK.
OctetSequenceKey.Builder	x509CertURL(java.net.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

keyUse

public OctetSequenceKey.Builder keyUse(KeyUse 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.

keyOperations

public OctetSequenceKey.Builder keyOperations(java.util.Set<KeyOperation> ops)

Sets the operations (key_ops) of the JWK (for a non-public key).

Parameters:

ops - The key operations, null if not specified.

Returns:

This builder.

algorithm

public OctetSequenceKey.Builder algorithm(Algorithm alg)

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

Parameters:

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

Returns:

This builder.

keyID

public OctetSequenceKey.Builder keyID(java.lang.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.

x509CertURL

public OctetSequenceKey.Builder x509CertURL(java.net.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.

x509CertThumbprint

public OctetSequenceKey.Builder x509CertThumbprint(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.

x509CertChain

public OctetSequenceKey.Builder x509CertChain(java.util.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.

Throws:

java.lang.IllegalStateException - If the JWK parameters were inconsistently specified.