JWTClaimsSet (Nimbus JOSE + JWT v. 3.10)

java.lang.Object
- com.nimbusds.jwt.JWTClaimsSet

All Implemented Interfaces:

ReadOnlyJWTClaimsSet
```
public class JWTClaimsSet
extends 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
The set may also contain custom claims; these will be serialised and parsed along the registered ones.
Version:

$version$ (2015-02-13)

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.

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
`Map<String,Object>`	`getAllClaims()` Gets all claims, both registered and custom, as a single map.
`List<String>`	`getAudience()` Gets the audience (`aud`) clam.
`Boolean`	`getBooleanClaim(String name)` Gets the specified claim (registered or custom) as `Boolean`.
`Object`	`getClaim(String name)` Gets the specified claim (registered or custom).
`Object`	`getCustomClaim(String name)` Gets a custom (non-registered) claim.
`Map<String,Object>`	`getCustomClaims()` Gets the custom (non-registered) claims.
`Double`	`getDoubleClaim(String name)` Gets the specified claim (registered or custom) as `Double`.
`Date`	`getExpirationTime()` Gets the expiration time (`exp`) claim.
`Float`	`getFloatClaim(String name)` Gets the specified claim (registered or custom) as `Float`.
`Integer`	`getIntegerClaim(String name)` Gets the specified claim (registered or custom) as `Integer`.
`String`	`getIssuer()` Gets the issuer (`iss`) claim.
`Date`	`getIssueTime()` Gets the issued-at (`iat`) claim.
`String`	`getJWTID()` Gets the JWT ID (`jti`) claim.
`Long`	`getLongClaim(String name)` Gets the specified claim (registered or custom) as `Long`.
`Date`	`getNotBeforeTime()` Gets the not-before (`nbf`) claim.
`static Set<String>`	`getRegisteredNames()` Gets the registered JWT claim names.
`String[]`	`getStringArrayClaim(String name)` Gets the specified claims (registered or custom) as a `String` array.
`String`	`getStringClaim(String name)` Gets the specified claim (registered or custom) as `String`.
`List<String>`	`getStringListClaim(String name)` Gets the specified claims (registered or custom) as a `String` list.
`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(String s)` Parses a JSON Web Token (JWT) claims set from the specified JSON object string representation.
`void`	`setAllClaims(Map<String,Object> newClaims)` Sets the claims of this JWT claims set, replacing any existing ones.
`void`	`setAudience(List<String> aud)` Sets the audience (`aud`) claim.
`void`	`setAudience(String aud)` Sets a single-valued audience (`aud`) claim.
`void`	`setClaim(String name, Object value)` Sets the specified claim, whether registered or custom.
`void`	`setCustomClaim(String name, Object value)` Sets a custom (non-registered) claim.
`void`	`setCustomClaims(Map<String,Object> customClaims)` Sets the custom (non-registered) claims.
`void`	`setExpirationTime(Date exp)` Sets the expiration time (`exp`) claim.
`void`	`setIssuer(String iss)` Sets the issuer (`iss`) claim.
`void`	`setIssueTime(Date iat)` Sets the issued-at (`iat`) claim.
`void`	`setJWTID(String jti)` Sets the JWT ID (`jti`) claim.
`void`	`setNotBeforeTime(Date nbf)` Sets the not-before (`nbf`) claim.
`void`	`setSubject(String sub)` Sets the subject (`sub`) claim.
`net.minidev.json.JSONObject`	`toJSONObject()` Returns the JSON object representation of the claims set.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, 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
  - getRegisteredNames
```
public static Set<String> getRegisteredNames()
```
    Gets the registered JWT claim names.
    
    Returns:
    The registered claim names, as a unmodifiable set.
  - getIssuer
```
public 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(String iss)
```
    Sets the issuer (iss) claim.
    
    Parameters:
    iss - The issuer claim, null if not specified.
  - getSubject
```
public 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(String sub)
```
    Sets the subject (sub) claim.
    
    Parameters:
    sub - The subject claim, null if not specified.
  - getAudience
```
public List<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(List<String> aud)
```
    Sets the audience (aud) claim.
    
    Parameters:
    aud - The audience claim, null if not specified.
  - setAudience
```
public void setAudience(String aud)
```
    Sets a single-valued audience (aud) claim.
    
    Parameters:
    aud - The audience claim, null if not specified.
  - getExpirationTime
```
public 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(Date exp)
```
    Sets the expiration time (exp) claim.
    
    Parameters:
    exp - The expiration time, null if not specified.
  - getNotBeforeTime
```
public 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(Date nbf)
```
    Sets the not-before (nbf) claim.
    
    Parameters:
    nbf - The not-before claim, null if not specified.
  - getIssueTime
```
public 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(Date iat)
```
    Sets the issued-at (iat) claim.
    
    Parameters:
    iat - The issued-at claim, null if not specified.
  - getJWTID
```
public 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(String jti)
```
    Sets the JWT ID (jti) claim.
    
    Parameters:
    jti - The JWT ID claim, null if not specified.
  - getCustomClaim
```
public Object getCustomClaim(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(String name,
                  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:
    
    IllegalArgumentException - If the specified custom claim name matches a registered claim name.
  - getCustomClaims
```
public Map<String,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(Map<String,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 Object getClaim(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 String getStringClaim(String name)
                      throws 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:
    
    ParseException - If the claim value is not of the required type.
  - getStringArrayClaim
```
public String[] getStringArrayClaim(String name)
                             throws ParseException
```
    Description copied from interface: ReadOnlyJWTClaimsSet
    
    Gets the specified claims (registered or custom) as a String array.
    
    Specified by:
    
    getStringArrayClaim 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:
    
    ParseException - If the claim value is not of the required type.
  - getStringListClaim
```
public List<String> getStringListClaim(String name)
                                throws ParseException
```
    Description copied from interface: ReadOnlyJWTClaimsSet
    
    Gets the specified claims (registered or custom) as a String list.
    
    Specified by:
    
    getStringListClaim 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:
    
    ParseException - If the claim value is not of the required type.
  - getBooleanClaim
```
public Boolean getBooleanClaim(String name)
                        throws 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:
    
    ParseException - If the claim value is not of the required type.
  - getIntegerClaim
```
public Integer getIntegerClaim(String name)
                        throws 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:
    
    ParseException - If the claim value is not of the required type.
  - getLongClaim
```
public Long getLongClaim(String name)
                  throws 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:
    
    ParseException - If the claim value is not of the required type.
  - getFloatClaim
```
public Float getFloatClaim(String name)
                    throws 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:
    
    ParseException - If the claim value is not of the required type.
  - getDoubleClaim
```
public Double getDoubleClaim(String name)
                      throws 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:
    
    ParseException - If the claim value is not of the required type.
  - setClaim
```
public void setClaim(String name,
            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:
    
    IllegalArgumentException - If the claim is registered and its value is not of the expected type.
  - getAllClaims
```
public Map<String,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(Map<String,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 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:
    
    ParseException - If the specified JSON object doesn't represent a valid JWT claims set.
  - parse
```
public static JWTClaimsSet parse(String s)
                          throws 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:
    
    ParseException - If the specified JSON object string doesn't represent a valid JWT claims set.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class JWTClaimsSet

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

JWTClaimsSet

JWTClaimsSet

Method Detail

getRegisteredNames

getIssuer

setIssuer

getSubject

setSubject

getAudience

setAudience

setAudience

getExpirationTime

setExpirationTime

getNotBeforeTime

setNotBeforeTime

getIssueTime

setIssueTime

getJWTID

setJWTID

getCustomClaim

setCustomClaim

getCustomClaims

setCustomClaims

getClaim

getStringClaim

getStringArrayClaim

getStringListClaim

getBooleanClaim

getIntegerClaim

getLongClaim

getFloatClaim

getDoubleClaim

setClaim

getAllClaims

setAllClaims

toJSONObject

parse

parse

toString