Package org.jose4j.jwk

Class JsonWebKey

java.lang.Object

org.jose4j.jwk.JsonWebKey

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

OctetSequenceJsonWebKey, PublicJsonWebKey

public abstract class JsonWebKey
extends Object
implements Serializable

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JsonWebKey.Factory
static enum	JsonWebKey.OutputControlLevel

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ALGORITHM_PARAMETER
protected Key	key
static final String	KEY_ID_PARAMETER
static final String	KEY_OPERATIONS
static final String	KEY_TYPE_PARAMETER
protected Map<String,Object>	otherParameters
static final String	USE_PARAMETER

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	JsonWebKey(Key key)
protected	JsonWebKey(Map<String,Object> params)

Method Summary

Modifier and Type	Method	Description
String	calculateBase64urlEncodedThumbprint(String hashAlgorithm)
byte[]	calculateThumbprint(String hashAlgorithm)
String	calculateThumbprintUri(String hashAlgorithm)
protected abstract void	fillTypeSpecificParams(Map<String,Object> params, JsonWebKey.OutputControlLevel outputLevel)
String	getAlgorithm()
Key	getKey()
String	getKeyId()
List<String>	getKeyOps()
abstract String	getKeyType()
<T> T	getOtherParameterValue(String name, Class<T> type)
PublicKey	getPublicKey()	Deprecated. deprecated in favor getKey() or PublicJsonWebKey.getPublicKey()
protected static String	getString(Map<String,Object> params, String name)
protected static String	getString(Map<String,Object> params, String name, boolean required)
protected static String	getStringRequired(Map<String,Object> params, String name)
String	getUse()
protected abstract String	produceThumbprintHashInput()
protected void	putIfNotNull(String name, Object value, Map<String,Object> params)
protected void	removeFromOtherParams(String... names)
void	setAlgorithm(String algorithm)
void	setKeyId(String keyId)
void	setKeyOps(List<String> keyOps)
void	setOtherParameter(String name, Object value)
void	setUse(String use)
String	toJson()
String	toJson(JsonWebKey.OutputControlLevel outputLevel)
Map<String,Object>	toParams(JsonWebKey.OutputControlLevel outputLevel)
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

KEY_TYPE_PARAMETER

public static final String KEY_TYPE_PARAMETER

See Also:

• Constant Field Values

USE_PARAMETER

public static final String USE_PARAMETER

See Also:

• Constant Field Values

KEY_ID_PARAMETER

public static final String KEY_ID_PARAMETER

See Also:

• Constant Field Values

ALGORITHM_PARAMETER

public static final String ALGORITHM_PARAMETER

See Also:

• Constant Field Values

KEY_OPERATIONS

public static final String KEY_OPERATIONS

See Also:

• Constant Field Values

otherParameters

protected Map<String,Object> otherParameters

key

protected Key key

Constructor Details

JsonWebKey

protected JsonWebKey(Key key)

JsonWebKey

protected JsonWebKey(Map<String,Object> params)
              throws JoseException

Throws:

JoseException

Method Details

getKeyType

public abstract String getKeyType()

fillTypeSpecificParams

protected abstract void fillTypeSpecificParams(Map<String,Object> params,
 JsonWebKey.OutputControlLevel outputLevel)

getPublicKey

public PublicKey getPublicKey()

Deprecated.

deprecated in favor getKey() or PublicJsonWebKey.getPublicKey()

Returns:

PublicKey

getKey

public Key getKey()

getUse

public String getUse()

setUse

public void setUse(String use)

getKeyId

public String getKeyId()

setKeyId

public void setKeyId(String keyId)

getAlgorithm

public String getAlgorithm()

setAlgorithm

public void setAlgorithm(String algorithm)

getKeyOps

public List<String> getKeyOps()

setKeyOps

public void setKeyOps(List<String> keyOps)

setOtherParameter

public void setOtherParameter(String name,
 Object value)

getOtherParameterValue

public <T> T getOtherParameterValue(String name,
 Class<T> type)

removeFromOtherParams

protected void removeFromOtherParams(String... names)

toParams

public Map<String,Object> toParams(JsonWebKey.OutputControlLevel outputLevel)

toJson

public String toJson()

toJson

public String toJson(JsonWebKey.OutputControlLevel outputLevel)

toString

public String toString()

Overrides:

toString in class Object

calculateBase64urlEncodedThumbprint

public String calculateBase64urlEncodedThumbprint(String hashAlgorithm)

calculateThumbprint

public byte[] calculateThumbprint(String hashAlgorithm)

calculateThumbprintUri

public String calculateThumbprintUri(String hashAlgorithm)

produceThumbprintHashInput

protected abstract String produceThumbprintHashInput()

putIfNotNull

protected void putIfNotNull(String name,
 Object value,
 Map<String,Object> params)

getString

protected static String getString(Map<String,Object> params,
 String name)
                           throws JoseException

Throws:

JoseException

getStringRequired

protected static String getStringRequired(Map<String,Object> params,
 String name)
                                   throws JoseException

Throws:

JoseException

getString

protected static String getString(Map<String,Object> params,
 String name,
 boolean required)
                           throws JoseException

Throws:

JoseException