Class JsonWebToken.Payload

java.lang.Object
java.util.AbstractMap<String,Object>
com.google.api.client.util.GenericData
com.google.api.client.json.GenericJson
com.google.api.client.json.webtoken.JsonWebToken.Payload
All Implemented Interfaces:
Cloneable, Map<String,Object>
Enclosing class:
JsonWebToken
public static class JsonWebToken.Payload extends GenericJson
Payload as specified in Reserved Claim Names.
Since:
1.14 (since 1.7 as com.google.api.client.auth.jsontoken.JsonWebToken)

  • Field Details

    • expirationTimeSeconds

      private Long expirationTimeSeconds
      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.

    • notBeforeTimeSeconds

      private Long notBeforeTimeSeconds
      Not before claim that identifies the time (in seconds) before which the token MUST NOT be accepted for processing or null for none.

    • issuedAtTimeSeconds

      private Long issuedAtTimeSeconds
      Issued at claim that identifies the time (in seconds) at which the JWT was issued or null for none.

    • issuer

      private String issuer
      Issuer claim that identifies the principal that issued the JWT or null for none.

    • audience

      private Object audience
      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.

    • jwtId

      private String jwtId
      JWT ID claim that provides a unique identifier for the JWT or null for none.

    • type

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

    • subject

      private String subject
      Subject claim identifying the principal that is the subject of the JWT or null for none.

  • Constructor Details

    • Payload

      public Payload()

  • Method Details

    • 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.

    • setExpirationTimeSeconds

      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.

    • 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.

    • setNotBeforeTimeSeconds

      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.

    • 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.

    • setIssuedAtTimeSeconds

      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.

    • getIssuer

      public final String getIssuer()
      Returns the issuer claim that identifies the principal that issued the JWT or null for none.

    • setIssuer

      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.

    • 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.

    • 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.

    • setAudience

      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.

    • getJwtId

      public final String getJwtId()
      Returns the JWT ID claim that provides a unique identifier for the JWT or null for none.

    • setJwtId

      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.

    • 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.

    • setType

      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.

    • getSubject

      public final String getSubject()
      Returns the subject claim identifying the principal that is the subject of the JWT or null for none.

    • setSubject

      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.

    • set

      public JsonWebToken.Payload set(String fieldName, Object value)
      Description copied from class: GenericData
      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 GenericData.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.

      Overrides:
      set in class GenericJson

    • clone

      public JsonWebToken.Payload clone()
      Description copied from class: GenericData
      Makes a "deep" clone of the generic data, in which the clone is completely independent of the original.
      Overrides:
      clone in class GenericJson