Module iu.util.crypt.impl

Package iu.crypt

Class JoseBuilder<B extends JoseBuilder<B>>

java.lang.Object

edu.iu.client.IuJsonBuilder<B>

iu.crypt.CertificateReferenceBuilder<B>

iu.crypt.KeyReferenceBuilder<B>

iu.crypt.JoseBuilder<B>

Type Parameters:

B - builder type

All Implemented Interfaces:

WebCertificateReference.Builder<B>, WebCryptoHeader.Builder<B>, WebKeyReference.Builder<B>

Direct Known Subclasses:

JweRecipientBuilder, JweRecipientBuilder.EncryptedKeyBuilder

class JoseBuilder<B extends JoseBuilder<B>>
extends KeyReferenceBuilder<B>
implements WebCryptoHeader.Builder<B>

Builds a web signature or encryption header.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	JoseBuilder(WebKey.Algorithm algorithm)	Constructor.

Method Summary

Modifier and Type	Method	Description
B	contentType(String contentType)	Sets the header content type parameter value.
protected <S extends IuJsonBuilder<S>> B	copy(S builder)	Copies all values from another builder to this one
B	crit(String... name)	Sets critical parameter names.
protected Jwk	key()	Returns the key to use for signing or encryption.
B	key(WebKey key)	The key to use for encrypting or signing.
<T> B	param(WebCryptoHeader.Param param, T value)	Sets a registered parameter value
<T> B	param(String paramName, T value)	Sets a parameter value.
protected <T> B	param(String name, T value, IuJsonAdapter<T> adapter)	Sets a parameter value.
B	type(String type)	Sets the header type parameter value.
B	wellKnown(WebKey key)	Sets the key to include with the header.
B	wellKnown(URI uri)	Sets the URI where JWKS well-known key data can be retrieved.

Methods inherited from class iu.crypt.KeyReferenceBuilder

algorithm, keyId

Methods inherited from class iu.crypt.CertificateReferenceBuilder

cert, cert, pem, pem, x5t, x5t256

Methods inherited from class edu.iu.client.IuJsonBuilder

build, param, paramNames, toJson

Methods inherited from class java.lang.Object

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

Methods inherited from interface edu.iu.crypt.WebCertificateReference.Builder

cert, cert, pem, pem, x5t, x5t256

Methods inherited from interface edu.iu.crypt.WebCryptoHeader.Builder

keyId

Constructor Details

JoseBuilder

protected JoseBuilder(WebKey.Algorithm algorithm)

Constructor.

Parameters:

algorithm - algorithm

Method Details

copy

protected <S extends IuJsonBuilder<S>> B copy(S builder)

Description copied from class: IuJsonBuilder

Copies all values from another builder to this one

Overrides:

copy in class IuJsonBuilder<B extends JoseBuilder<B>>

Type Parameters:

S - source builder type

Parameters:

builder - source builder

Returns:

this

wellKnown

public B wellKnown(URI uri)

Description copied from interface: WebCryptoHeader.Builder

Sets the URI where JWKS well-known key data can be retrieved.

Specified by:

wellKnown in interface WebCryptoHeader.Builder<B extends JoseBuilder<B>>

Parameters:

uri - JWKS URI

Returns:

this

wellKnown

public B wellKnown(WebKey key)

Description copied from interface: WebCryptoHeader.Builder

Sets the key to include with the header.

Specified by:

wellKnown in interface WebCryptoHeader.Builder<B extends JoseBuilder<B>>

Parameters:

key - may include private/secret key data to use for encryption/signing; only WebKey.wellKnown() will be included in the header.

Returns:

this

key

public B key(WebKey key)

Description copied from interface: WebCryptoHeader.Builder

The key to use for encrypting or signing.

Specified by:

key in interface WebCryptoHeader.Builder<B extends JoseBuilder<B>>

Parameters:

key - key to use for encryption or signing; will not be included in the header. Use WebCryptoHeader.Builder.wellKnown(WebKey) to set the key and include well-known component in the header.

Returns:

this

type

public B type(String type)

Description copied from interface: WebCryptoHeader.Builder

Sets the header type parameter value.

Specified by:

type in interface WebCryptoHeader.Builder<B extends JoseBuilder<B>>

Parameters:

type - header type parameter value.

Returns:

this

contentType

public B contentType(String contentType)

Description copied from interface: WebCryptoHeader.Builder

Sets the header content type parameter value.

Specified by:

contentType in interface WebCryptoHeader.Builder<B extends JoseBuilder<B>>

Parameters:

contentType - header type parameter value.

Returns:

this

crit

public B crit(String... name)

Description copied from interface: WebCryptoHeader.Builder

Sets critical parameter names.

Specified by:

crit in interface WebCryptoHeader.Builder<B extends JoseBuilder<B>>

Parameters:

name - critical parameter names

Returns:

this

param

public <T> B param(WebCryptoHeader.Param param,
 T value)

Description copied from interface: WebCryptoHeader.Builder

Sets a registered parameter value

Specified by:

param in interface WebCryptoHeader.Builder<B extends JoseBuilder<B>>

Type Parameters:

T - value type

Parameters:

param - parameter

value - parameter value

Returns:

this

param

public <T> B param(String paramName,
 T value)

Description copied from class: IuJsonBuilder

Sets a parameter value.

Specified by:

param in interface WebCryptoHeader.Builder<B extends JoseBuilder<B>>

Overrides:

param in class IuJsonBuilder<B extends JoseBuilder<B>>

Type Parameters:

T - value type

Parameters:

paramName - parameter name

value - parameter value

Returns:

this

param

protected <T> B param(String name,
 T value,
 IuJsonAdapter<T> adapter)

Description copied from class: IuJsonBuilder

Sets a parameter value.

Overrides:

param in class IuJsonBuilder<B extends JoseBuilder<B>>

Type Parameters:

T - value type

Parameters:

name - parameter name

value - parameter value

adapter - JSON type adapter

Returns:

this

key

protected Jwk key()

Returns the key to use for signing or encryption.

Returns:

signing/encryption key