com.nimbusds.jose.jwk

Class JWKSelector

java.lang.Object

com.nimbusds.jose.jwk.JWKSelector

public class JWKSelector
extends Object

Utility for selecting one or more JSON Web Keys (JWKs) from a JWK set.

Supports key selection by:

• Any, unspecified, one or more key types (typ).
• Any, unspecified, one or more key uses (use).
• Any, unspecified, one or more key operations (key_ops).
• Any, unspecified, one or more key algorithms (alg).
• Any, unspecified, one or more key identifiers (kid).
• Private only key.
• Public only key.

Selection by X.509 certificate URL, thumbprint and chain is not supported.

Version:

$version$ (2014-04-03)

Author:

Vladimir Dzhuvinov

Constructor Summary

Constructors

Constructor and Description
JWKSelector()

Method Summary

Methods

Modifier and Type	Method and Description
Set<Algorithm>	getAlgorithms() Gets the selected JOSE algorithms.
Set<String>	getKeyIDs() Gets the selected key IDs.
Set<KeyOperation>	getKeyOperations() Gets the selected key operations.
Set<KeyType>	getKeyTypes() Gets the selected key types.
Set<KeyUse>	getKeyUses() Gets the selected public key uses.
boolean	isPrivateOnly() Gets the selection of private keys.
boolean	isPublicOnly() Gets the selection of public keys.
List<JWK>	select(JWKSet jwkSet) Selects the keys from the specified JWK set that match the configured criteria.
void	setAlgorithm(Algorithm alg) Sets a singled selected JOSE algorithm.
void	setAlgorithms(Algorithm... algs) Sets the selected JOSE algorithms.
void	setAlgorithms(Set<Algorithm> algs) Sets the selected JOSE algorithms.
void	setKeyID(String id) Sets a single selected key ID.
void	setKeyIDs(Set<String> ids) Sets the selected key IDs.
void	setKeyIDs(String... ids) Sets the selected key IDs.
void	setKeyOperation(KeyOperation op) Sets a single selected key operation.
void	setKeyOperations(KeyOperation... ops) Sets the selected key operations.
void	setKeyOperations(Set<KeyOperation> ops) Sets the selected key operations.
void	setKeyType(KeyType kty) Sets a single selected key type.
void	setKeyTypes(KeyType... types) Sets the selected key types.
void	setKeyTypes(Set<KeyType> types) Sets the selected key types.
void	setKeyUse(KeyUse use) Sets a single selected public key use.
void	setKeyUses(KeyUse... uses) Sets the selected public key uses.
void	setKeyUses(Set<KeyUse> uses) Sets the selected public key uses.
void	setPrivateOnly(boolean privateOnly) Sets the selection of private keys.
void	setPublicOnly(boolean publicOnly) Sets the selection of public keys.

Methods inherited from class java.lang.Object

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

Constructor Detail

JWKSelector

public JWKSelector()

Method Detail

getKeyTypes

public Set<KeyType> getKeyTypes()

Gets the selected key types.

Returns:

The key types, null if not specified.

setKeyType

public void setKeyType(KeyType kty)

Sets a single selected key type.

Parameters:

kty - The key type, null if not specified.

setKeyTypes

public void setKeyTypes(KeyType... types)

Sets the selected key types.

Parameters:

types - The key types.

setKeyTypes

public void setKeyTypes(Set<KeyType> types)

Sets the selected key types.

Parameters:

types - The key types, null if not specified.

getKeyUses

public Set<KeyUse> getKeyUses()

Gets the selected public key uses.

Returns:

The public key uses, null if not specified.

setKeyUse

public void setKeyUse(KeyUse use)

Sets a single selected public key use.

Parameters:

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

setKeyUses

public void setKeyUses(KeyUse... uses)

Sets the selected public key uses.

Parameters:

uses - The public key uses.

setKeyUses

public void setKeyUses(Set<KeyUse> uses)

Sets the selected public key uses.

Parameters:

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

getKeyOperations

public Set<KeyOperation> getKeyOperations()

Gets the selected key operations.

Returns:

The key operations, null if not specified.

setKeyOperation

public void setKeyOperation(KeyOperation op)

Sets a single selected key operation.

Parameters:

op - The key operation, null if not specified.

setKeyOperations

public void setKeyOperations(KeyOperation... ops)

Sets the selected key operations.

Parameters:

ops - The key operations.

setKeyOperations

public void setKeyOperations(Set<KeyOperation> ops)

Sets the selected key operations.

Parameters:

ops - The key operations, null if not specified.

getAlgorithms

public Set<Algorithm> getAlgorithms()

Gets the selected JOSE algorithms.

Returns:

The JOSE algorithms, null if not specified.

setAlgorithm

public void setAlgorithm(Algorithm alg)

Sets a singled selected JOSE algorithm.

Parameters:

alg - The JOSE algorithm, null if not specified.

setAlgorithms

public void setAlgorithms(Algorithm... algs)

Sets the selected JOSE algorithms.

Parameters:

algs - The JOSE algorithms.

setAlgorithms

public void setAlgorithms(Set<Algorithm> algs)

Sets the selected JOSE algorithms.

Parameters:

algs - The JOSE algorithms, null if not specified.

getKeyIDs

public Set<String> getKeyIDs()

Gets the selected key IDs.

Returns:

The key IDs, null if not specified.

setKeyIDs

public void setKeyIDs(String... ids)

Sets the selected key IDs.

Parameters:

ids - The key IDs.

setKeyIDs

public void setKeyIDs(Set<String> ids)

Sets the selected key IDs.

Parameters:

ids - The key IDs, null if not specified.

setKeyID

public void setKeyID(String id)

Sets a single selected key ID.

Parameters:

id - The key ID, null if not specified.

isPrivateOnly

public boolean isPrivateOnly()

Gets the selection of private keys.

Returns:

If true only private keys are selected.

setPrivateOnly

public void setPrivateOnly(boolean privateOnly)

Sets the selection of private keys.

Parameters:

privateOnly - If true only private keys are selected.

isPublicOnly

public boolean isPublicOnly()

Gets the selection of public keys.

Returns:

If true only public keys are selected.

setPublicOnly

public void setPublicOnly(boolean publicOnly)

Sets the selection of public keys.

Parameters:

publicOnly - If true only public keys are selected.

select

public List<JWK> select(JWKSet jwkSet)

Selects the keys from the specified JWK set that match the configured criteria.

Parameters:

jwkSet - The JWK set. May be null.

Returns:

The selected keys, ordered by their position in the JWK set, empty list if none were matched or the JWK is null.