JsonWebKey (jose4j 0.5.0 API)

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 and Description

static class JsonWebKey.Factory

static class JsonWebKey.OutputControlLevel

Nested Classes
Modifier and Type	Class and Description
`static class`	`JsonWebKey.Factory`
`static class`	`JsonWebKey.OutputControlLevel`

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ALGORITHM_PARAMETER`
`protected Key`	`key`
`static String`	`KEY_ID_PARAMETER`
`static String`	`KEY_TYPE_PARAMETER`
`static String`	`USE_PARAMETER`

Constructor Summary

Constructors
Modifier Constructor and Description

protected JsonWebKey(Key key)

protected JsonWebKey(Map<String,Object> params)

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

Method Summary

Methods
Modifier and Type	Method and Description
`String`	`calculateBase64urlEncodedThumbprint(String hashAlgorithm)`
`byte[]`	`calculateThumbprint(String hashAlgorithm)`
`protected abstract void`	`fillTypeSpecificParams(Map<String,Object> params, JsonWebKey.OutputControlLevel outputLevel)`
`String`	`getAlgorithm()`
`Key`	`getKey()`
`String`	`getKeyId()`
`abstract String`	`getKeyType()`
`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, String value, Map<String,Object> params)`
`void`	`setAlgorithm(String algorithm)`
`void`	`setKeyId(String keyId)`
`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 Detail

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
```
protected Key key
```

Constructor Detail

JsonWebKey
```
protected JsonWebKey(Key key)
```

JsonWebKey

protected JsonWebKey(Map<String,Object> params)

Method Detail

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()

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)

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)

produceThumbprintHashInput

protected abstract String produceThumbprintHashInput()

putIfNotNull

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

getString

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

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

Class JsonWebKey

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

KEY_TYPE_PARAMETER

USE_PARAMETER

KEY_ID_PARAMETER

ALGORITHM_PARAMETER

key

Constructor Detail

JsonWebKey

JsonWebKey

Method Detail

getKeyType

fillTypeSpecificParams

getPublicKey

getKey

getUse

setUse

getKeyId

setKeyId

getAlgorithm

setAlgorithm

toParams

toJson

toJson

toString

calculateBase64urlEncodedThumbprint

calculateThumbprint

produceThumbprintHashInput

putIfNotNull

getString

getStringRequired

getString