com.nimbusds.jwt

Interface ReadOnlyJWTClaimsSet

All Known Implementing Classes:

JWTClaimsSet

public interface ReadOnlyJWTClaimsSet

Read-only view of a JWTClaimsSet.

Version:

$version$ (2013-10-07)

Author:

Vladimir Dzhuvinov, Justin Richer

Method Summary

Methods

Modifier and Type	Method and Description
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.
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.
net.minidev.json.JSONObject	toJSONObject() Returns the JSON object representation of the claims set.

Method Detail

getIssuer

java.lang.String getIssuer()

Gets the issuer (iss) claim.

Returns:

The issuer claim, null if not specified.

getSubject

java.lang.String getSubject()

Gets the subject (sub) claim.

Returns:

The subject claim, null if not specified.

getAudience

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

Gets the audience (aud) clam.

Returns:

The audience claim, null if not specified.

getExpirationTime

java.util.Date getExpirationTime()

Gets the expiration time (exp) claim.

Returns:

The expiration time, null if not specified.

getNotBeforeTime

java.util.Date getNotBeforeTime()

Gets the not-before (nbf) claim.

Returns:

The not-before claim, null if not specified.

getIssueTime

java.util.Date getIssueTime()

Gets the issued-at (iat) claim.

Returns:

The issued-at claim, null if not specified.

getJWTID

java.lang.String getJWTID()

Gets the JWT ID (jti) claim.

Returns:

The JWT ID claim, null if not specified.

getType

java.lang.String getType()

Gets the type (typ) claim.

Returns:

The type claim, null if not specified.

getCustomClaim

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

Gets a custom (non-registered) claim.

Parameters:

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

Returns:

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

getCustomClaims

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

Gets the custom (non-registered) claims.

Returns:

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

getClaim

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

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.

getBooleanClaim

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

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

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.

getFloatClaim

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

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.

getAllClaims

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

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.

Returns:

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

toJSONObject

net.minidev.json.JSONObject toJSONObject()

Returns the JSON object representation of the claims set.

Returns:

The JSON object representation.