com.nimbusds.jwt

Class JWTClaimsSet

java.lang.Object

com.nimbusds.jwt.JWTClaimsSet

All Implemented Interfaces:

ReadOnlyJWTClaimsSet

public class JWTClaimsSet
extends java.lang.Object
implements ReadOnlyJWTClaimsSet

JSON Web Token (JWT) claims set.

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
• typ - Type

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

Version:

$version$ (2013-10-07)

Author:

Vladimir Dzhuvinov, Justin Richer

Constructor Summary

Constructors

Constructor and Description
JWTClaimsSet() Creates a new empty JWT claims set.
JWTClaimsSet(ReadOnlyJWTClaimsSet old) Creates a copy of the specified JWT claims set.

Method Summary

Methods

Modifier and Type	Method and Description
protected java.lang.Object	clone()
java.util.Map<java.lang.String,java.lang.Object>	getAllClaims() Gets all claims, both registered and custom, as a single map.
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.lang.Object	getCustomClaim(java.lang.String name) Gets a custom (non-registered) claim.
java.util.Map<java.lang.String,java.lang.Object>	getCustomClaims() Gets the custom (non-registered) claims.
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	getStringClaim(java.lang.String name) Gets the specified claim (registered or custom) as String.
java.lang.String	getSubject() Gets the subject (sub) claim.
java.lang.String	getType() Gets the type (typ) 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.
void	setAllClaims(java.util.Map<java.lang.String,java.lang.Object> newClaims) Sets the claims of this JWT claims set, replacing any existing ones.
void	setAudience(java.util.List<java.lang.String> aud) Sets the audience (aud) claim.
void	setClaim(java.lang.String name, java.lang.Object value) Sets the specified claim, whether registered or custom.
void	setCustomClaim(java.lang.String name, java.lang.Object value) Sets a custom (non-registered) claim.
void	setCustomClaims(java.util.Map<java.lang.String,java.lang.Object> customClaims) Sets the custom (non-registered) claims.
void	setExpirationTime(java.util.Date exp) Sets the expiration time (exp) claim.
void	setIssuer(java.lang.String iss) Sets the issuer (iss) claim.
void	setIssueTime(java.util.Date iat) Sets the issued-at (iat) claim.
void	setJWTID(java.lang.String jti) Sets the JWT ID (jti) claim.
void	setNotBeforeTime(java.util.Date nbf) Sets the not-before (nbf) claim.
void	setSubject(java.lang.String sub) Sets the subject (sub) claim.
void	setType(java.lang.String typ) Sets the type (typ) claim.
net.minidev.json.JSONObject	toJSONObject() Returns the JSON object representation of the claims set.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

JWTClaimsSet

public JWTClaimsSet()

Creates a new empty JWT claims set.

JWTClaimsSet

public JWTClaimsSet(ReadOnlyJWTClaimsSet old)

Creates a copy of the specified JWT claims set.

Parameters:

old - The JWT claims set to copy. Must not be null.

Method Detail

clone

protected java.lang.Object clone()
                          throws java.lang.CloneNotSupportedException

Overrides:

clone in class java.lang.Object

Throws:

java.lang.CloneNotSupportedException

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

Description copied from interface: ReadOnlyJWTClaimsSet

Gets the issuer (iss) claim.

Specified by:

getIssuer in interface ReadOnlyJWTClaimsSet

Returns:

The issuer claim, null if not specified.

setIssuer

public void setIssuer(java.lang.String iss)

Sets the issuer (iss) claim.

Parameters:

iss - The issuer claim, null if not specified.

getSubject

public java.lang.String getSubject()

Description copied from interface: ReadOnlyJWTClaimsSet

Gets the subject (sub) claim.

Specified by:

getSubject in interface ReadOnlyJWTClaimsSet

Returns:

The subject claim, null if not specified.

setSubject

public void setSubject(java.lang.String sub)

Sets the subject (sub) claim.

Parameters:

sub - The subject claim, null if not specified.

getAudience

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

Description copied from interface: ReadOnlyJWTClaimsSet

Gets the audience (aud) clam.

Specified by:

getAudience in interface ReadOnlyJWTClaimsSet

Returns:

The audience claim, null if not specified.

setAudience

public void setAudience(java.util.List<java.lang.String> aud)

Sets the audience (aud) claim.

Parameters:

aud - The audience claim, null if not specified.

getExpirationTime

public java.util.Date getExpirationTime()

Description copied from interface: ReadOnlyJWTClaimsSet

Gets the expiration time (exp) claim.

Specified by:

getExpirationTime in interface ReadOnlyJWTClaimsSet

Returns:

The expiration time, null if not specified.

setExpirationTime

public void setExpirationTime(java.util.Date exp)

Sets the expiration time (exp) claim.

Parameters:

exp - The expiration time, null if not specified.

getNotBeforeTime

public java.util.Date getNotBeforeTime()

Description copied from interface: ReadOnlyJWTClaimsSet

Gets the not-before (nbf) claim.

Specified by:

getNotBeforeTime in interface ReadOnlyJWTClaimsSet

Returns:

The not-before claim, null if not specified.

setNotBeforeTime

public void setNotBeforeTime(java.util.Date nbf)

Sets the not-before (nbf) claim.

Parameters:

nbf - The not-before claim, null if not specified.

getIssueTime

public java.util.Date getIssueTime()

Description copied from interface: ReadOnlyJWTClaimsSet

Gets the issued-at (iat) claim.

Specified by:

getIssueTime in interface ReadOnlyJWTClaimsSet

Returns:

The issued-at claim, null if not specified.

setIssueTime

public void setIssueTime(java.util.Date iat)

Sets the issued-at (iat) claim.

Parameters:

iat - The issued-at claim, null if not specified.

getJWTID

public java.lang.String getJWTID()

Description copied from interface: ReadOnlyJWTClaimsSet

Gets the JWT ID (jti) claim.

Specified by:

getJWTID in interface ReadOnlyJWTClaimsSet

Returns:

The JWT ID claim, null if not specified.

setJWTID

public void setJWTID(java.lang.String jti)

Sets the JWT ID (jti) claim.

Parameters:

jti - The JWT ID claim, null if not specified.

getType

public java.lang.String getType()

Description copied from interface: ReadOnlyJWTClaimsSet

Gets the type (typ) claim.

Specified by:

getType in interface ReadOnlyJWTClaimsSet

Returns:

The type claim, null if not specified.

setType

public void setType(java.lang.String typ)

Sets the type (typ) claim.

Parameters:

typ - The type claim, null if not specified.

getCustomClaim

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

Description copied from interface: ReadOnlyJWTClaimsSet

Gets a custom (non-registered) claim.

Specified by:

getCustomClaim in interface ReadOnlyJWTClaimsSet

Parameters:

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

Returns:

The value of the custom claim, null if not specified.

setCustomClaim

public void setCustomClaim(java.lang.String name,
                  java.lang.Object value)

Sets a custom (non-registered) claim.

Parameters:

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

value - The value of the custom claim, should map to a valid JSON entity, null if not specified.

Throws:

java.lang.IllegalArgumentException - If the specified custom claim name matches a registered claim name.

getCustomClaims

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

Description copied from interface: ReadOnlyJWTClaimsSet

Gets the custom (non-registered) claims.

Specified by:

getCustomClaims in interface ReadOnlyJWTClaimsSet

Returns:

The custom claims, as a unmodifiable map, empty map if none.

setCustomClaims

public void setCustomClaims(java.util.Map<java.lang.String,java.lang.Object> customClaims)

Sets the custom (non-registered) claims. If a claim value doesn't map to a JSON entity it will be ignored during serialisation.

Parameters:

customClaims - The custom claims, empty map or null if none.

getClaim

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

Description copied from interface: ReadOnlyJWTClaimsSet

Gets the specified claim (registered or custom).

Specified by:

getClaim in interface ReadOnlyJWTClaimsSet

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

Description copied from interface: ReadOnlyJWTClaimsSet

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

Specified by:

getStringClaim in interface ReadOnlyJWTClaimsSet

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

Description copied from interface: ReadOnlyJWTClaimsSet

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

Specified by:

getBooleanClaim in interface ReadOnlyJWTClaimsSet

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

Description copied from interface: ReadOnlyJWTClaimsSet

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

Specified by:

getIntegerClaim in interface ReadOnlyJWTClaimsSet

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

Description copied from interface: ReadOnlyJWTClaimsSet

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

Specified by:

getLongClaim in interface ReadOnlyJWTClaimsSet

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

Description copied from interface: ReadOnlyJWTClaimsSet

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

Specified by:

getFloatClaim in interface ReadOnlyJWTClaimsSet

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

Description copied from interface: ReadOnlyJWTClaimsSet

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

Specified by:

getDoubleClaim in interface ReadOnlyJWTClaimsSet

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.

setClaim

public void setClaim(java.lang.String name,
            java.lang.Object value)

Sets the specified claim, whether registered or custom.

Parameters:

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

value - The value of the claim to set, null if not specified.

Throws:

java.lang.IllegalArgumentException - If the claim is registered and its value is not of the expected type.

getAllClaims

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

Description copied from interface: ReadOnlyJWTClaimsSet

Gets all claims, both registered and custom, as a single map.

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

Specified by:

getAllClaims in interface ReadOnlyJWTClaimsSet

Returns:

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

setAllClaims

public void setAllClaims(java.util.Map<java.lang.String,java.lang.Object> newClaims)

Sets the claims of this JWT claims set, replacing any existing ones.

Parameters:

newClaims - The JWT claims. Must not be null.

toJSONObject

public net.minidev.json.JSONObject toJSONObject()

Description copied from interface: ReadOnlyJWTClaimsSet

Returns the JSON object representation of the claims set.

Specified by:

toJSONObject in interface ReadOnlyJWTClaimsSet

Returns:

The JSON object representation.

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.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object