com.nimbusds.jose.jwk

Class JWKMatcher.Builder

java.lang.Object

com.nimbusds.jose.jwk.JWKMatcher.Builder

Enclosing class:

JWKMatcher

public static class JWKMatcher.Builder
extends Object

Builder for constructing JWK matchers.

Example use:

 JWKMatcher matcher = new JWKMatcher().keyID("123").build();
 

Constructor Summary

Constructors

Constructor and Description
JWKMatcher.Builder()

Method Summary

Methods

Modifier and Type	Method and Description
JWKMatcher.Builder	algorithm(Algorithm alg) Sets a single JOSE algorithm to match.
JWKMatcher.Builder	algorithms(Algorithm... algs) Sets multiple JOSE algorithms to match.
JWKMatcher.Builder	algorithms(Set<Algorithm> algs) Sets multiple JOSE algorithms to match.
JWKMatcher	build() Builds a new JWK matcher.
JWKMatcher.Builder	keyID(String id) Sets a single key ID to match.
JWKMatcher.Builder	keyIDs(Set<String> ids) Sets multiple key IDs to match.
JWKMatcher.Builder	keyIDs(String... ids) Sets multiple key IDs to match.
JWKMatcher.Builder	keyOperation(KeyOperation op) Sets a single key operation to match.
JWKMatcher.Builder	keyOperations(KeyOperation... ops) Sets multiple key operations to match.
JWKMatcher.Builder	keyOperations(Set<KeyOperation> ops) Sets multiple key operations to match.
JWKMatcher.Builder	keyType(KeyType kty) Sets a single key type to match.
JWKMatcher.Builder	keyTypes(KeyType... types) Sets multiple key types to match.
JWKMatcher.Builder	keyTypes(Set<KeyType> types) Sets multiple key types to match.
JWKMatcher.Builder	keyUse(KeyUse use) Sets a single public key use to match.
JWKMatcher.Builder	keyUses(KeyUse... uses) Sets multiple public key uses to match.
JWKMatcher.Builder	keyUses(Set<KeyUse> uses) Sets multiple public key uses to match.
JWKMatcher.Builder	privateOnly(boolean privateOnly) Sets the private key matching policy.
JWKMatcher.Builder	publicOnly(boolean publicOnly) Sets the public key matching policy.

Methods inherited from class java.lang.Object

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

Constructor Detail

JWKMatcher.Builder

public JWKMatcher.Builder()

Method Detail

keyType

public JWKMatcher.Builder keyType(KeyType kty)

Sets a single key type to match.

Parameters:

kty - The key type, null if not specified.

Returns:

This builder.

keyTypes

public JWKMatcher.Builder keyTypes(KeyType... types)

Sets multiple key types to match.

Parameters:

types - The key types.

Returns:

This builder.

keyTypes

public JWKMatcher.Builder keyTypes(Set<KeyType> types)

Sets multiple key types to match.

Parameters:

types - The key types, null if not specified.

Returns:

This builder.

keyUse

public JWKMatcher.Builder keyUse(KeyUse use)

Sets a single public key use to match.

Parameters:

use - The public key use, null if not specified.

Returns:

This builder.

keyUses

public JWKMatcher.Builder keyUses(KeyUse... uses)

Sets multiple public key uses to match.

Parameters:

uses - The public key uses.

Returns:

This builder.

keyUses

public JWKMatcher.Builder keyUses(Set<KeyUse> uses)

Sets multiple public key uses to match.

Parameters:

uses - The public key uses, null if not specified.

Returns:

This builder.

keyOperation

public JWKMatcher.Builder keyOperation(KeyOperation op)

Sets a single key operation to match.

Parameters:

op - The key operation, null if not specified.

Returns:

This builder.

keyOperations

public JWKMatcher.Builder keyOperations(KeyOperation... ops)

Sets multiple key operations to match.

Parameters:

ops - The key operations.

Returns:

This builder.

keyOperations

public JWKMatcher.Builder keyOperations(Set<KeyOperation> ops)

Sets multiple key operations to match.

Parameters:

ops - The key operations, null if not specified.

Returns:

This builder.

algorithm

public JWKMatcher.Builder algorithm(Algorithm alg)

Sets a single JOSE algorithm to match.

Parameters:

alg - The JOSE algorithm, null if not specified.

Returns:

This builder.

algorithms

public JWKMatcher.Builder algorithms(Algorithm... algs)

Sets multiple JOSE algorithms to match.

Parameters:

algs - The JOSE algorithms.

Returns:

This builder.

algorithms

public JWKMatcher.Builder algorithms(Set<Algorithm> algs)

Sets multiple JOSE algorithms to match.

Parameters:

algs - The JOSE algorithms, null if not specified.

Returns:

This builder.

keyID

public JWKMatcher.Builder keyID(String id)

Sets a single key ID to match.

Parameters:

id - The key ID, null if not specified.

Returns:

This builder.

keyIDs

public JWKMatcher.Builder keyIDs(String... ids)

Sets multiple key IDs to match.

Parameters:

ids - The key IDs.

Returns:

This builder.

keyIDs

public JWKMatcher.Builder keyIDs(Set<String> ids)

Sets multiple key IDs to match.

Parameters:

ids - The key IDs, null if not specified.

Returns:

This builder.

privateOnly

public JWKMatcher.Builder privateOnly(boolean privateOnly)

Sets the private key matching policy.

Parameters:

privateOnly - If true only private keys are matched.

Returns:

This builder.

publicOnly

public JWKMatcher.Builder publicOnly(boolean publicOnly)

Sets the public key matching policy.

Parameters:

publicOnly - If true only public keys are matched.

Returns:

This builder.

build

public JWKMatcher build()

Builds a new JWK matcher.

Returns:

The JWK matcher.