io.jsonwebtoken.impl.security

Class DefaultJwkContext<K extends Key>

java.lang.Object

io.jsonwebtoken.impl.ParameterMap

io.jsonwebtoken.impl.AbstractX509Context<JwkContext<K>>

io.jsonwebtoken.impl.security.DefaultJwkContext<K>

All Implemented Interfaces:

Identifiable, Nameable, ParameterReadable, JwkContext<K>, X509Context<JwkContext<K>>, X509Accessor, X509Mutator<JwkContext<K>>, Map<String,Object>

public class DefaultJwkContext<K extends Key>
extends AbstractX509Context<JwkContext<K>>
implements JwkContext<K>

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Field Summary

Fields inherited from class io.jsonwebtoken.impl.ParameterMap

idiomaticValues, PARAMS, values

Constructor Summary

Constructors

Constructor and Description
DefaultJwkContext()
DefaultJwkContext(Set<Parameter<?>> params)
DefaultJwkContext(Set<Parameter<?>> params, JwkContext<?> other)
DefaultJwkContext(Set<Parameter<?>> params, JwkContext<?> other, boolean removePrivate)
DefaultJwkContext(Set<Parameter<?>> params, JwkContext<?> other, K key)

Method Summary

Methods

Modifier and Type	Method and Description
String	getAlgorithm()
String	getId()
HashAlgorithm	getIdThumbprintAlgorithm()
K	getKey()
String	getName()
Set<KeyOperation>	getOperations()
Provider	getProvider()
PublicKey	getPublicKey()
String	getPublicKeyUse()
SecureRandom	getRandom()
String	getType()
boolean	isSigUse() Returns true if relevant context values indicate JWK use with MAC or digital signature algorithms, false otherwise.
JwkContext<K>	parameter(Parameter<?> param)
void	putAll(Map<? extends String,?> m)
JwkContext<K>	setAlgorithm(String algorithm)
JwkContext<K>	setId(String id)
JwkContext<K>	setIdThumbprintAlgorithm(HashAlgorithm alg)
JwkContext<K>	setKey(K key)
JwkContext<K>	setOperations(Collection<? extends KeyOperation> ops)
JwkContext<K>	setProvider(Provider provider)
JwkContext<K>	setPublicKey(PublicKey publicKey)
JwkContext<K>	setPublicKeyUse(String use)
JwkContext<K>	setRandom(SecureRandom random)
JwkContext<K>	setType(String type)

Methods inherited from class io.jsonwebtoken.impl.AbstractX509Context

getX509Chain, getX509Sha1Thumbprint, getX509Sha256Thumbprint, getX509Url, self, x509Chain, x509Sha1Thumbprint, x509Sha256Thumbprint, x509Url

Methods inherited from class io.jsonwebtoken.impl.ParameterMap

clear, containsKey, containsValue, entrySet, equals, get, get, hashCode, isEmpty, keySet, put, put, remove, replace, size, toString, values

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, remove, size, values

Methods inherited from interface io.jsonwebtoken.impl.lang.ParameterReadable

get

Methods inherited from interface io.jsonwebtoken.security.X509Accessor

getX509Chain, getX509Sha1Thumbprint, getX509Sha256Thumbprint, getX509Url

Methods inherited from interface io.jsonwebtoken.security.X509Mutator

x509Chain, x509Sha1Thumbprint, x509Sha256Thumbprint, x509Url

Constructor Detail

DefaultJwkContext

public DefaultJwkContext()

DefaultJwkContext

public DefaultJwkContext(Set<Parameter<?>> params)

DefaultJwkContext

public DefaultJwkContext(Set<Parameter<?>> params,
                 JwkContext<?> other)

DefaultJwkContext

public DefaultJwkContext(Set<Parameter<?>> params,
                 JwkContext<?> other,
                 K key)

DefaultJwkContext

public DefaultJwkContext(Set<Parameter<?>> params,
                 JwkContext<?> other,
                 boolean removePrivate)

Method Detail

parameter

public JwkContext<K> parameter(Parameter<?> param)

Specified by:

parameter in interface JwkContext<K extends Key>

getName

public String getName()

Specified by:

getName in interface Nameable

Overrides:

getName in class ParameterMap

putAll

public void putAll(Map<? extends String,?> m)

Specified by:

putAll in interface Map<String,Object>

Overrides:

putAll in class ParameterMap

getAlgorithm

public String getAlgorithm()

Specified by:

getAlgorithm in interface JwkContext<K extends Key>

setAlgorithm

public JwkContext<K> setAlgorithm(String algorithm)

Specified by:

setAlgorithm in interface JwkContext<K extends Key>

getId

public String getId()

Specified by:

getId in interface Identifiable

setId

public JwkContext<K> setId(String id)

Specified by:

setId in interface JwkContext<K extends Key>

setIdThumbprintAlgorithm

public JwkContext<K> setIdThumbprintAlgorithm(HashAlgorithm alg)

Specified by:

setIdThumbprintAlgorithm in interface JwkContext<K extends Key>

getIdThumbprintAlgorithm

public HashAlgorithm getIdThumbprintAlgorithm()

Specified by:

getIdThumbprintAlgorithm in interface JwkContext<K extends Key>

getOperations

public Set<KeyOperation> getOperations()

Specified by:

getOperations in interface JwkContext<K extends Key>

setOperations

public JwkContext<K> setOperations(Collection<? extends KeyOperation> ops)

Specified by:

setOperations in interface JwkContext<K extends Key>

getType

public String getType()

Specified by:

getType in interface JwkContext<K extends Key>

setType

public JwkContext<K> setType(String type)

Specified by:

setType in interface JwkContext<K extends Key>

getPublicKeyUse

public String getPublicKeyUse()

Specified by:

getPublicKeyUse in interface JwkContext<K extends Key>

setPublicKeyUse

public JwkContext<K> setPublicKeyUse(String use)

Specified by:

setPublicKeyUse in interface JwkContext<K extends Key>

isSigUse

public boolean isSigUse()

Description copied from interface: JwkContext

Returns true if relevant context values indicate JWK use with MAC or digital signature algorithms, false otherwise. Specifically true is only returned if either:

• "sig".equals(JwkContext.getPublicKeyUse()), OR
• JwkContext.getOperations() is not empty and contains either "sign" or "verify"

otherwise false.

Specified by:

isSigUse in interface JwkContext<K extends Key>

Returns:

true if relevant context values indicate JWK use with MAC or digital signature algorithms, false otherwise.

getKey

public K getKey()

Specified by:

getKey in interface JwkContext<K extends Key>

setKey

public JwkContext<K> setKey(K key)

Specified by:

setKey in interface JwkContext<K extends Key>

getPublicKey

public PublicKey getPublicKey()

Specified by:

getPublicKey in interface JwkContext<K extends Key>

setPublicKey

public JwkContext<K> setPublicKey(PublicKey publicKey)

Specified by:

setPublicKey in interface JwkContext<K extends Key>

getProvider

public Provider getProvider()

Specified by:

getProvider in interface JwkContext<K extends Key>

setProvider

public JwkContext<K> setProvider(Provider provider)

Specified by:

setProvider in interface JwkContext<K extends Key>

getRandom

public SecureRandom getRandom()

Specified by:

getRandom in interface JwkContext<K extends Key>

setRandom

public JwkContext<K> setRandom(SecureRandom random)

Specified by:

setRandom in interface JwkContext<K extends Key>