com.nimbusds.jwt

Class JWTClaimsSet

java.lang.Object

com.nimbusds.jwt.JWTClaimsSet

@Immutable
public final class JWTClaimsSet
extends java.lang.Object

JSON Web Token (JWT) claims set. This class is immutable.

Supports all getRegisteredNames() registered claims} of the JWT specification:

• iss - Issuer
• sub - Subject
• aud - Audience
• exp - Expiration Time
• nbf - Not Before
• iat - Issued At
• jti - JWT ID

The set may also contain custom claims; these will be serialised and parsed along the registered ones.

Example JWT claims set:

 {
   "sub"                        : "joe",
   "exp"                        : 1300819380,
   "http://example.com/is_root" : true
 }
 

Example usage:

 JWTClaimsSet claimsSet = new JWTClaimsSet.Builder()
     .subject("joe")
     .expirationDate(new Date(1300819380 * 1000l)
     .claim("http://example.com/is_root", true)
     .build();
 

Version:

2015-08-22

Author:

Vladimir Dzhuvinov, Justin Richer

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JWTClaimsSet.Builder Builder for constructing JSON Web Token (JWT) claims sets.

Method Summary

Methods

Modifier and Type	Method and Description
java.util.List<java.lang.String>	getAudience() Gets the audience (aud) clam.
java.lang.Boolean	getBooleanClaim(java.lang.String name) Gets the specified claim (registered or custom) as Boolean.
java.lang.Object	getClaim(java.lang.String name) Gets the specified claim (registered or custom).
java.util.Map<java.lang.String,java.lang.Object>	getClaims() Gets the claims (registered and custom).
java.util.Date	getDateClaim(java.lang.String name) Gets the specified claim (registered or custom) as Date.
java.lang.Double	getDoubleClaim(java.lang.String name) Gets the specified claim (registered or custom) as Double.
java.util.Date	getExpirationTime() Gets the expiration time (exp) claim.
java.lang.Float	getFloatClaim(java.lang.String name) Gets the specified claim (registered or custom) as Float.
java.lang.Integer	getIntegerClaim(java.lang.String name) Gets the specified claim (registered or custom) as Integer.
java.lang.String	getIssuer() Gets the issuer (iss) claim.
java.util.Date	getIssueTime() Gets the issued-at (iat) claim.
java.lang.String	getJWTID() Gets the JWT ID (jti) claim.
java.lang.Long	getLongClaim(java.lang.String name) Gets the specified claim (registered or custom) as Long.
java.util.Date	getNotBeforeTime() Gets the not-before (nbf) claim.
static java.util.Set<java.lang.String>	getRegisteredNames() Gets the registered JWT claim names.
java.lang.String[]	getStringArrayClaim(java.lang.String name) Gets the specified claims (registered or custom) as a String array.
java.lang.String	getStringClaim(java.lang.String name) Gets the specified claim (registered or custom) as String.
java.util.List<java.lang.String>	getStringListClaim(java.lang.String name) Gets the specified claims (registered or custom) as a List list of strings.
java.lang.String	getSubject() Gets the subject (sub) claim.
static JWTClaimsSet	parse(net.minidev.json.JSONObject json) Parses a JSON Web Token (JWT) claims set from the specified JSON object representation.
static JWTClaimsSet	parse(java.lang.String s) Parses a JSON Web Token (JWT) claims set from the specified JSON object string representation.
net.minidev.json.JSONObject	toJSONObject() Returns the JSON object representation of the claims set.
java.lang.String	toString()
<T> T	toType(JWTClaimsSetTransformer<T> transformer) Returns a transformation of this JWT claims set.

Methods inherited from class java.lang.Object

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

Method Detail

getRegisteredNames

public static java.util.Set<java.lang.String> getRegisteredNames()

Gets the registered JWT claim names.

Returns:

The registered claim names, as a unmodifiable set.

getIssuer

public java.lang.String getIssuer()

Gets the issuer (iss) claim.

Returns:

The issuer claim, null if not specified.

getSubject

public java.lang.String getSubject()

Gets the subject (sub) claim.

Returns:

The subject claim, null if not specified.

getAudience

public java.util.List<java.lang.String> getAudience()

Gets the audience (aud) clam.

Returns:

The audience claim, null if not specified.

getExpirationTime

public java.util.Date getExpirationTime()

Gets the expiration time (exp) claim.

Returns:

The expiration time, null if not specified.

getNotBeforeTime

public java.util.Date getNotBeforeTime()

Gets the not-before (nbf) claim.

Returns:

The not-before claim, null if not specified.

getIssueTime

public java.util.Date getIssueTime()

Gets the issued-at (iat) claim.

Returns:

The issued-at claim, null if not specified.

getJWTID

public java.lang.String getJWTID()

Gets the JWT ID (jti) claim.

Returns:

The JWT ID claim, null if not specified.

getClaim

public java.lang.Object getClaim(java.lang.String name)

Gets the specified claim (registered or custom).

Parameters:

name - The name of the claim. Must not be null.

Returns:

The value of the claim, null if not specified.

getStringClaim

public java.lang.String getStringClaim(java.lang.String name)
                                throws java.text.ParseException

Gets the specified claim (registered or custom) as String.

Parameters:

name - The name of the claim. Must not be null.

Returns:

The value of the claim, null if not specified.

Throws:

java.text.ParseException - If the claim value is not of the required type.

getStringArrayClaim

public java.lang.String[] getStringArrayClaim(java.lang.String name)
                                       throws java.text.ParseException

Gets the specified claims (registered or custom) as a String array.

Parameters:

name - The name of the claim. Must not be null.

Returns:

The value of the claim, null if not specified.

Throws:

java.text.ParseException - If the claim value is not of the required type.

getStringListClaim

public java.util.List<java.lang.String> getStringListClaim(java.lang.String name)
                                                    throws java.text.ParseException

Gets the specified claims (registered or custom) as a List list of strings.

Parameters:

name - The name of the claim. Must not be null.

Returns:

The value of the claim, null if not specified.

Throws:

java.text.ParseException - If the claim value is not of the required type.

getBooleanClaim

public java.lang.Boolean getBooleanClaim(java.lang.String name)
                                  throws java.text.ParseException

Gets the specified claim (registered or custom) as Boolean.

Parameters:

name - The name of the claim. Must not be null.

Returns:

The value of the claim, null if not specified.

Throws:

java.text.ParseException - If the claim value is not of the required type.

getIntegerClaim

public java.lang.Integer getIntegerClaim(java.lang.String name)
                                  throws java.text.ParseException

Gets the specified claim (registered or custom) as Integer.

Parameters:

name - The name of the claim. Must not be null.

Returns:

The value of the claim, null if not specified.

Throws:

java.text.ParseException - If the claim value is not of the required type.

getLongClaim

public java.lang.Long getLongClaim(java.lang.String name)
                            throws java.text.ParseException

Gets the specified claim (registered or custom) as Long.

Parameters:

name - The name of the claim. Must not be null.

Returns:

The value of the claim, null if not specified.

Throws:

java.text.ParseException - If the claim value is not of the required type.

getDateClaim

public java.util.Date getDateClaim(java.lang.String name)
                            throws java.text.ParseException

Gets the specified claim (registered or custom) as Date. The claim may be represented by a Date object or a number of a seconds since the Unix epoch.

Parameters:

name - The name of the claim. Must not be null.

Returns:

The value of the claim, null if not specified.

Throws:

java.text.ParseException - If the claim value is not of the required type.

getFloatClaim

public java.lang.Float getFloatClaim(java.lang.String name)
                              throws java.text.ParseException

Gets the specified claim (registered or custom) as Float.

Parameters:

name - The name of the claim. Must not be null.

Returns:

The value of the claim, null if not specified.

Throws:

java.text.ParseException - If the claim value is not of the required type.

getDoubleClaim

public java.lang.Double getDoubleClaim(java.lang.String name)
                                throws java.text.ParseException

Gets the specified claim (registered or custom) as Double.

Parameters:

name - The name of the claim. Must not be null.

Returns:

The value of the claim, null if not specified.

Throws:

java.text.ParseException - If the claim value is not of the required type.

getClaims

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

Gets the claims (registered and custom).

Note that the registered claims Expiration-Time (exp), Not-Before-Time (nbf) and Issued-At (iat) will be returned as java.util.Date instances.

Returns:

The claims, as an unmodifiable map, empty map if none.

toJSONObject

public net.minidev.json.JSONObject toJSONObject()

Returns the JSON object representation of the claims set. The claims are serialised according to their insertion order.

Returns:

The JSON object representation.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toType

public <T> T toType(JWTClaimsSetTransformer<T> transformer)

Returns a transformation of this JWT claims set.

Parameters:

transformer - The JWT claims set transformer. Must not be null.

Returns:

The transformed JWT claims set.

parse

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

Parses a JSON Web Token (JWT) claims set from the specified JSON object representation.

Parameters:

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

Returns:

The JWT claims set.

Throws:

java.text.ParseException - If the specified JSON object doesn't represent a valid JWT claims set.

parse

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

Parses a JSON Web Token (JWT) claims set from the specified JSON object string representation.

Parameters:

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

Returns:

The JWT claims set.

Throws:

java.text.ParseException - If the specified JSON object string doesn't represent a valid JWT claims set.