com.nimbusds.jose.jwk

Class JWKSet

java.lang.Object

com.nimbusds.jose.jwk.JWKSet

public class JWKSet
extends java.lang.Object

JSON Web Key (JWK) set. Represented by a JSON object that contains an array of JSON Web Keys (JWKs) as the value of its "keys" member. Additional (custom) members of the JWK Set JSON object are also supported.

Example JSON Web Key (JWK) set:

 {
   "keys" : [ { "kty" : "EC",
                "crv" : "P-256",
                "x"   : "MKBCTNIcKUSDii11ySs3526iDZ8AiTo7Tu6KPAqv7D4",
                "y"   : "4Etl6SRW2YiLUrN5vfvVHuhp7x8PxltmWWlbbM4IFyM",
                "use" : "enc",
                "kid" : "1" },

              { "kty" : "RSA",
                "n"   : "0vx7agoebGcQSuuPiLJXZptN9nndrQmbXEps2aiAFbWhM78LhWx
                         4cbbfAAtVT86zwu1RK7aPFFxuhDR1L6tSoc_BJECPebWKRXjBZCiFV4n3oknjhMs
                         tn64tZ_2W-5JsGY4Hc5n9yBXArwl93lqt7_RN5w6Cf0h4QyQ5v-65YGjQR0_FDW2
                         QvzqY368QQMicAtaSqzs8KJZgnYb9c7d0zgdAZHzu6qMQvRL5hajrn1n91CbOpbI
                         SD08qNLyrdkt-bFTWhAI4vMQFh6WeZu0fM4lFd2NcRwr3XPksINHaQ-G_xBniIqb
                         w0Ls1jF44-csFCur-kEgU8awapJzKnqDKgw",
                "e"   : "AQAB",
                "alg" : "RS256",
                "kid" : "2011-04-29" } ]
 }
 

Version:

2014-12-14

Author:

Vladimir Dzhuvinov

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	MIME_TYPE The MIME type of JWK set objects: application/jwk-set+json; charset=UTF-8

Constructor Summary

Constructors

Constructor and Description
JWKSet() Creates a new empty JSON Web Key (JWK) set.
JWKSet(JWK key) Creates a new JSON Web Key (JWK) set with a single key.
JWKSet(java.util.List<JWK> keys) Creates a new JSON Web Key (JWK) set with the specified keys.
JWKSet(java.util.List<JWK> keys, java.util.Map<java.lang.String,java.lang.Object> customMembers) Creates a new JSON Web Key (JWK) set with the specified keys and additional custom members.

Method Summary

Methods

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.Object>	getAdditionalMembers() Gets the additional custom members of this JSON Web Key (JWK) set.
JWK	getKeyByKeyId(java.lang.String kid) Gets the key from this JSON Web Key (JWK) set as identified by its Key ID (kid) member.
java.util.List<JWK>	getKeys() Gets the keys (ordered) of this JSON Web Key (JWK) set.
static JWKSet	load(java.io.File file) Loads a JSON Web Key (JWK) set from the specified file.
static JWKSet	load(java.net.URL url) Loads a JSON Web Key (JWK) set from the specified URL.
static JWKSet	load(java.net.URL url, int connectTimeout, int readTimeout, int sizeLimit) Loads a JSON Web Key (JWK) set from the specified URL.
static JWKSet	parse(net.minidev.json.JSONObject json) Parses the specified JSON object representing a JSON Web Key (JWK) set.
static JWKSet	parse(java.lang.String s) Parses the specified string representing a JSON Web Key (JWK) set.
net.minidev.json.JSONObject	toJSONObject() Returns the JSON object representation of this JSON Web Key (JWK) set.
net.minidev.json.JSONObject	toJSONObject(boolean publicKeysOnly) Returns the JSON object representation of this JSON Web Key (JWK) set.
JWKSet	toPublicJWKSet() Returns a copy of this JSON Web Key (JWK) set with all private keys and parameters removed.
java.lang.String	toString() Returns the JSON object string representation of this JSON Web Key (JWK) set.

Methods inherited from class java.lang.Object

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

Field Detail

MIME_TYPE

public static final java.lang.String MIME_TYPE

The MIME type of JWK set objects: application/jwk-set+json; charset=UTF-8

See Also:

Constant Field Values

Constructor Detail

JWKSet

public JWKSet()

Creates a new empty JSON Web Key (JWK) set.

JWKSet

public JWKSet(JWK key)

Creates a new JSON Web Key (JWK) set with a single key.

Parameters:

key - The JWK. Must not be null.

JWKSet

public JWKSet(java.util.List<JWK> keys)

Creates a new JSON Web Key (JWK) set with the specified keys.

Parameters:

keys - The JWK list. Must not be null.

JWKSet

public JWKSet(java.util.List<JWK> keys,
      java.util.Map<java.lang.String,java.lang.Object> customMembers)

Creates a new JSON Web Key (JWK) set with the specified keys and additional custom members.

Parameters:

keys - The JWK list. Must not be null.

customMembers - The additional custom members. Must not be null.

Method Detail

getKeys

public java.util.List<JWK> getKeys()

Gets the keys (ordered) of this JSON Web Key (JWK) set.

Returns:

The keys, empty list if none.

getKeyByKeyId

public JWK getKeyByKeyId(java.lang.String kid)

Gets the key from this JSON Web Key (JWK) set as identified by its Key ID (kid) member.

If more than one key exists in the JWK Set with the same identifier, this function returns only the first one in the set.

Returns:

The key identified by kid or null if no key exists.

getAdditionalMembers

public java.util.Map<java.lang.String,java.lang.Object> getAdditionalMembers()

Gets the additional custom members of this JSON Web Key (JWK) set.

Returns:

The additional custom members, empty map if none.

toPublicJWKSet

public JWKSet toPublicJWKSet()

Returns a copy of this JSON Web Key (JWK) set with all private keys and parameters removed.

Returns:

A copy of this JWK set with all private keys and parameters removed.

toJSONObject

public net.minidev.json.JSONObject toJSONObject()

Returns the JSON object representation of this JSON Web Key (JWK) set. Private keys and parameters will be omitted from the output. Use the alternative toJSONObject(boolean) method if you wish to include them.

Returns:

The JSON object representation.

toJSONObject

public net.minidev.json.JSONObject toJSONObject(boolean publicKeysOnly)

Returns the JSON object representation of this JSON Web Key (JWK) set.

Parameters:

publicKeysOnly - Controls the inclusion of private keys and parameters into the output JWK members. If true private keys and parameters will be omitted. If false all available key parameters will be included.

Returns:

The JSON object representation.

toString

public java.lang.String toString()

Returns the JSON object string representation of this JSON Web Key (JWK) set.

Overrides:

toString in class java.lang.Object

Returns:

The JSON object string representation.

parse

public static JWKSet parse(java.lang.String s)
                    throws java.text.ParseException

Parses the specified string representing a JSON Web Key (JWK) set.

Parameters:

s - The string to parse. Must not be null.

Returns:

The JSON Web Key (JWK) set.

Throws:

java.text.ParseException - If the string couldn't be parsed to a valid JSON Web Key (JWK) set.

parse

public static JWKSet parse(net.minidev.json.JSONObject json)
                    throws java.text.ParseException

Parses the specified JSON object representing a JSON Web Key (JWK) set.

Parameters:

json - The JSON object to parse. Must not be null.

Returns:

The JSON Web Key (JWK) set.

Throws:

java.text.ParseException - If the string couldn't be parsed to a valid JSON Web Key (JWK) set.

load

public static JWKSet load(java.io.File file)
                   throws java.io.IOException,
                          java.text.ParseException

Loads a JSON Web Key (JWK) set from the specified file.

Parameters:

file - The JWK set file. Must not be null.

Returns:

The JSON Web Key (JWK) set.

Throws:

java.io.IOException - If the file couldn't be read.

java.text.ParseException - If the file couldn't be parsed to a valid JSON Web Key (JWK) set.

load

public static JWKSet load(java.net.URL url,
          int connectTimeout,
          int readTimeout,
          int sizeLimit)
                   throws java.io.IOException,
                          java.text.ParseException

Loads a JSON Web Key (JWK) set from the specified URL.

Parameters:

url - The JWK set URL. Must not be null.

connectTimeout - The URL connection timeout, in milliseconds. If zero no (infinite) timeout.

readTimeout - The URL read timeout, in milliseconds. If zero no (infinite) timeout.

sizeLimit - The read size limit, in bytes. If negative no limit.

Returns:

The JSON Web Key (JWK) set.

Throws:

java.io.IOException - If the file couldn't be read.

java.text.ParseException - If the file couldn't be parsed to a valid JSON Web Key (JWK) set.

load

public static JWKSet load(java.net.URL url)
                   throws java.io.IOException,
                          java.text.ParseException

Loads a JSON Web Key (JWK) set from the specified URL.

Parameters:

url - The JWK set URL. Must not be null.

Returns:

The JSON Web Key (JWK) set.

Throws:

java.io.IOException - If the file couldn't be read.

java.text.ParseException - If the file couldn't be parsed to a valid JSON Web Key (JWK) set.