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 usage:

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

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

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	curve(Curve curve) Sets a single curve to match (for EC and OKP keys).
JWKMatcher.Builder	curves(Curve... curves) Sets multiple curves to match (for EC and OKP keys).
JWKMatcher.Builder	curves(Set<Curve> curves) Sets multiple curves to match (for EC and OKP keys).
JWKMatcher.Builder	hasKeyID(boolean hasID) Sets key ID presence matching.
JWKMatcher.Builder	hasKeyUse(boolean hasUse) Sets key use presence matching.
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	keySize(int keySizeBits) Sets the key size.
JWKMatcher.Builder	keySizes(int... keySizesBits) Sets the key sizes.
JWKMatcher.Builder	keySizes(Set<Integer> keySizesBits) Sets the key sizes.
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	maxKeySize(int maxSizeBits) Sets the maximum key size.
JWKMatcher.Builder	minKeySize(int minSizeBits) Sets the minimal key size.
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

Builder

public 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.

hasKeyUse

public JWKMatcher.Builder hasKeyUse(boolean hasUse)

Sets key use presence matching.

Parameters:

hasUse - true to match a key with a set use.

Returns:

This builder.

hasKeyID

public JWKMatcher.Builder hasKeyID(boolean hasID)

Sets key ID presence matching.

Parameters:

hasID - true to match a key with a set ID.

Returns:

This builder.

privateOnly

public JWKMatcher.Builder privateOnly(boolean privateOnly)

Sets the private key matching policy.

Parameters:

privateOnly - true to match a private key.

Returns:

This builder.

publicOnly

public JWKMatcher.Builder publicOnly(boolean publicOnly)

Sets the public key matching policy.

Parameters:

publicOnly - true to match a public only key.

Returns:

This builder.

minKeySize

public JWKMatcher.Builder minKeySize(int minSizeBits)

Sets the minimal key size.

Parameters:

minSizeBits - The minimum key size in bits, zero implies no minimum key size limit.

Returns:

This builder.

maxKeySize

public JWKMatcher.Builder maxKeySize(int maxSizeBits)

Sets the maximum key size.

Parameters:

maxSizeBits - The maximum key size in bits, zero implies no maximum key size limit.

Returns:

This builder.

keySize

public JWKMatcher.Builder keySize(int keySizeBits)

Sets the key size.

Parameters:

keySizeBits - The key size in bits, zero if not specified.

Returns:

This builder.

keySizes

public JWKMatcher.Builder keySizes(int... keySizesBits)

Sets the key sizes.

Parameters:

keySizesBits - The key sizes in bits.

Returns:

This builder.

keySizes

public JWKMatcher.Builder keySizes(Set<Integer> keySizesBits)

Sets the key sizes.

Parameters:

keySizesBits - The key sizes in bits.

Returns:

This builder.

curve

public JWKMatcher.Builder curve(Curve curve)

Sets a single curve to match (for EC and OKP keys).

Parameters:

curve - The curve, null if not specified.

Returns:

This builder.

curves

public JWKMatcher.Builder curves(Curve... curves)

Sets multiple curves to match (for EC and OKP keys).

Parameters:

curves - The curves.

Returns:

This builder.

curves

public JWKMatcher.Builder curves(Set<Curve> curves)

Sets multiple curves to match (for EC and OKP keys).

Parameters:

curves - The curves, null if not specified.

Returns:

This builder.

build

public JWKMatcher build()

Builds a new JWK matcher.

Returns:

The JWK matcher.