io.jsonwebtoken.security

Interface JwkSetBuilder

All Superinterfaces:

Builder<JwkSet>, KeyOperationPolicied<JwkSetBuilder>, MapMutator<String,Object,JwkSetBuilder>, SecurityBuilder<JwkSet,JwkSetBuilder>

public interface JwkSetBuilder
extends MapMutator<String,Object,JwkSetBuilder>, SecurityBuilder<JwkSet,JwkSetBuilder>, KeyOperationPolicied<JwkSetBuilder>

A builder that produces JwkSets containing Jwks. Jwks with any key operations will be validated by the operationPolicy first before being added.

Since:

0.12.0

See Also:

KeyOperationPolicied.operationPolicy(KeyOperationPolicy), SecurityBuilder.provider(Provider)

Method Summary

Methods

Modifier and Type	Method and Description
JwkSetBuilder	add(Collection<Jwk<?>> c) Appends the specified Jwk collection to the JWK Set.
JwkSetBuilder	add(Jwk<?> jwk) Appends the specified jwk to the set.
JwkSetBuilder	keys(Collection<Jwk<?>> c) Sets the JwkSet keys parameter value; per standard Java setter idioms, this is a full replacement operation, removing any previous keys from the set.

Methods inherited from interface io.jsonwebtoken.lang.MapMutator

add, add, delete, empty

Methods inherited from interface io.jsonwebtoken.security.SecurityBuilder

provider, random

Methods inherited from interface io.jsonwebtoken.lang.Builder

build

Methods inherited from interface io.jsonwebtoken.security.KeyOperationPolicied

operationPolicy

Method Detail

add

JwkSetBuilder add(Jwk<?> jwk)

Appends the specified jwk to the set. If the jwk has any key operations, it will be validated with the operationPolicy first before being added.

Parameters:

jwk - the jwk to add to the JWK Set. A null jwk is ignored.

Returns:

the builder for method chaining

add

JwkSetBuilder add(Collection<Jwk<?>> c)

Appends the specified Jwk collection to the JWK Set. If any Jwk in the collection has any key operations, it will be validated with the operationPolicy first before being added.

Parameters:

c - the collection of Jwks to add to the JWK Set. A null or empty collection is ignored.

Returns:

the builder for method chaining

keys

JwkSetBuilder keys(Collection<Jwk<?>> c)

Sets the JwkSet keys parameter value; per standard Java setter idioms, this is a full replacement operation, removing any previous keys from the set. A null or empty collection removes all keys from the set.

Parameters:

c - the (possibly null or empty) collection of Jwks to set as the JWK set keys parameter value.

Returns:

the builder for method chaining