Class JsonWebToken.Payload (1.42.3)

public static class JsonWebToken.Payload extends GenericJson

Payload as specified in Reserved Claim Names.

Inheritance

Object > AbstractMap > GenericData > GenericJson > JsonWebToken.Payload

Inherited Members

GenericJson.clone()

GenericJson.getFactory()

GenericJson.set(String,Object)

GenericJson.setFactory(JsonFactory)

GenericJson.toPrettyString()

GenericJson.toString()

GenericData.entrySet()

GenericData.equals(Object)

GenericData.get(Object)

GenericData.getClassInfo()

GenericData.getUnknownKeys()

GenericData.hashCode()

GenericData.put(String,Object)

GenericData.putAll(Map<? extends String,?>)

GenericData.remove(Object)

GenericData.setUnknownKeys(Map<String,Object>)

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

AbstractMap.clear()

AbstractMap.containsKey(Object)

AbstractMap.containsValue(Object)

AbstractMap.isEmpty()

AbstractMap.keySet()

AbstractMap.put(K,V)

AbstractMap.putAll(Map<? extends K,? extends V>)

AbstractMap.size()

AbstractMap.values()

Constructors

Payload()

public Payload()

Methods

clone()

public JsonWebToken.Payload clone()

Makes a "deep" clone of the generic data, in which the clone is completely independent of the original.

Returns

Type	Description
`JsonWebToken.Payload`

Overrides

GenericJson.clone()

getAudience()

public final Object getAudience()

Returns the audience claim that identifies the audience that the JWT is intended for (should either be a String or a List<String>) or null for none.

Returns

Type	Description
`Object`

getAudienceAsList()

public final List<String> getAudienceAsList()

Returns the list of audience claim that identifies the audience that the JWT is intended for or empty for none.

Returns

Type	Description
`List<String>`

getExpirationTimeSeconds()

public final Long getExpirationTimeSeconds()

Returns the expiration time (in seconds) claim that identifies the expiration time on or after which the token MUST NOT be accepted for processing or null for none.

Returns

Type	Description
`Long`

getIssuedAtTimeSeconds()

public final Long getIssuedAtTimeSeconds()

Returns the issued at claim that identifies the time (in seconds) at which the JWT was issued or null for none.

Returns

Type	Description
`Long`

getIssuer()

public final String getIssuer()

Returns the issuer claim that identifies the principal that issued the JWT or null for none.

Returns

Type	Description
`String`

getJwtId()

public final String getJwtId()

Returns the JWT ID claim that provides a unique identifier for the JWT or null for none.

Returns

Type	Description
`String`

getNotBeforeTimeSeconds()

public final Long getNotBeforeTimeSeconds()

Returns the not before claim that identifies the time (in seconds) before which the token MUST NOT be accepted for processing or null for none.

Returns

Type	Description
`Long`

getSubject()

public final String getSubject()

Returns the subject claim identifying the principal that is the subject of the JWT or null for none.

Returns

Type	Description
`String`

getType()

public final String getType()

Returns the type claim that is used to declare a type for the contents of this JWT Claims Set or null for none.

Returns

Type	Description
`String`

set(String fieldName, Object value)

public JsonWebToken.Payload set(String fieldName, Object value)

Sets the given field value (may be null) for the given field name. Any existing value for the field will be overwritten. It may be more slightly more efficient than #put(String, Object) because it avoids accessing the field's original value.

Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

Parameters

Name	Description
`fieldName`	`String`
`value`	`Object`

Returns

Type	Description
`JsonWebToken.Payload`

Overrides

GenericJson.set(String fieldName, Object value)

setAudience(Object audience)

public JsonWebToken.Payload setAudience(Object audience)

Sets the audience claim that identifies the audience that the JWT is intended for (should either be a String or a List<String>) or null for none.

Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

Parameter

Name	Description
`audience`	`Object`

Returns

Type	Description
`JsonWebToken.Payload`

setExpirationTimeSeconds(Long expirationTimeSeconds)

public JsonWebToken.Payload setExpirationTimeSeconds(Long expirationTimeSeconds)

Sets the expiration time claim that identifies the expiration time (in seconds) on or after which the token MUST NOT be accepted for processing or null for none.

Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

Parameter

Name	Description
`expirationTimeSeconds`	`Long`

Returns

Type	Description
`JsonWebToken.Payload`

setIssuedAtTimeSeconds(Long issuedAtTimeSeconds)

public JsonWebToken.Payload setIssuedAtTimeSeconds(Long issuedAtTimeSeconds)

Sets the issued at claim that identifies the time (in seconds) at which the JWT was issued or null for none.

Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

Parameter

Name	Description
`issuedAtTimeSeconds`	`Long`

Returns

Type	Description
`JsonWebToken.Payload`

setIssuer(String issuer)

public JsonWebToken.Payload setIssuer(String issuer)

Sets the issuer claim that identifies the principal that issued the JWT or null for none.

Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

Parameter

Name	Description
`issuer`	`String`

Returns

Type	Description
`JsonWebToken.Payload`

setJwtId(String jwtId)

public JsonWebToken.Payload setJwtId(String jwtId)

Sets the JWT ID claim that provides a unique identifier for the JWT or null for none.

Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

Parameter

Name	Description
`jwtId`	`String`

Returns

Type	Description
`JsonWebToken.Payload`

setNotBeforeTimeSeconds(Long notBeforeTimeSeconds)

public JsonWebToken.Payload setNotBeforeTimeSeconds(Long notBeforeTimeSeconds)

Sets the not before claim that identifies the time (in seconds) before which the token MUST NOT be accepted for processing or null for none.

Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

Parameter

Name	Description
`notBeforeTimeSeconds`	`Long`

Returns

Type	Description
`JsonWebToken.Payload`

setSubject(String subject)

public JsonWebToken.Payload setSubject(String subject)

Sets the subject claim identifying the principal that is the subject of the JWT or null for none.

Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

Parameter

Name	Description
`subject`	`String`

Returns

Type	Description
`JsonWebToken.Payload`

setType(String type)

public JsonWebToken.Payload setType(String type)

Sets the type claim that is used to declare a type for the contents of this JWT Claims Set or null for none.

Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

Parameter

Name	Description
`type`	`String`

Returns

Type	Description
`JsonWebToken.Payload`