com.nimbusds.jose

Class UnprotectedHeader.Builder

java.lang.Object

com.nimbusds.jose.UnprotectedHeader.Builder

Enclosing class:

UnprotectedHeader

public static class UnprotectedHeader.Builder
extends Object

Builder for constructing an unprotected JWS or JWE header.

Constructor Summary

Constructors

Constructor and Description
Builder() Creates a new unprotected header builder.

Method Summary

Modifier and Type	Method and Description
UnprotectedHeader	build() Builds a new unprotected header.
UnprotectedHeader.Builder	keyID(String kid) Sets the key ID (kid) parameter.
UnprotectedHeader.Builder	param(String name, Object value) Sets a parameter.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Creates a new unprotected header builder.

Method Detail

keyID

public UnprotectedHeader.Builder keyID(String kid)

Sets the key ID (kid) parameter.

Parameters:

kid - The key ID parameter, null if not specified.

Returns:

This builder.

param

public UnprotectedHeader.Builder param(String name,
                                       Object value)

Sets a parameter.

Parameters:

name - The name of the parameter. Must not be null.

value - The value of the parameter, should map to a valid JSON entity, null if not specified.

Returns:

This builder.

build

public UnprotectedHeader build()

Builds a new unprotected header.

Returns:

The unprotected header.