Package com.google.api.client.json.webtoken

Class JsonWebToken.Payload

  • All Implemented Interfaces:
    java.lang.Cloneable, java.util.Map<java.lang.String,​java.lang.Object>
    Enclosing class:
    JsonWebToken
    public static class JsonWebToken.Payload
extends GenericJson
    Payload as specified in Reserved Claim Names.

    • Nested Class Summary

      • Nested classes/interfaces inherited from class java.util.AbstractMap

        java.util.AbstractMap.SimpleEntry<K extends java.lang.Object,​V extends java.lang.Object>, java.util.AbstractMap.SimpleImmutableEntry<K extends java.lang.Object,​V extends java.lang.Object>

      • Nested classes/interfaces inherited from interface java.util.Map

        java.util.Map.Entry<K extends java.lang.Object,​V extends java.lang.Object>

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private java.lang.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.
      private java.lang.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.
      private java.lang.Long issuedAtTimeSeconds
      Issued at claim that identifies the time (in seconds) at which the JWT was issued or null for none.
      private java.lang.String issuer
      Issuer claim that identifies the principal that issued the JWT or null for none.
      private java.lang.String jwtId
      JWT ID claim that provides a unique identifier for the JWT or null for none.
      private java.lang.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.
      private java.lang.String subject
      Subject claim identifying the principal that is the subject of the JWT or null for none.
      private java.lang.String type
      Type claim that is used to declare a type for the contents of this JWT Claims Set or null for none.

    • Constructor Summary

      Constructors 
      Constructor Description
      Payload()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      JsonWebToken.Payload clone()
      Makes a "deep" clone of the generic data, in which the clone is completely independent of the original.
      java.lang.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.
      java.util.List<java.lang.String> getAudienceAsList()
      Returns the list of audience claim that identifies the audience that the JWT is intended for or empty for none.
      java.lang.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.
      java.lang.Long getIssuedAtTimeSeconds()
      Returns the issued at claim that identifies the time (in seconds) at which the JWT was issued or null for none.
      java.lang.String getIssuer()
      Returns the issuer claim that identifies the principal that issued the JWT or null for none.
      java.lang.String getJwtId()
      Returns the JWT ID claim that provides a unique identifier for the JWT or null for none.
      java.lang.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.
      java.lang.String getSubject()
      Returns the subject claim identifying the principal that is the subject of the JWT or null for none.
      java.lang.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.
      JsonWebToken.Payload set​(java.lang.String fieldName, java.lang.Object value)
      Sets the given field value (may be null) for the given field name.
      JsonWebToken.Payload setAudience​(java.lang.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.
      JsonWebToken.Payload setExpirationTimeSeconds​(java.lang.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.
      JsonWebToken.Payload setIssuedAtTimeSeconds​(java.lang.Long issuedAtTimeSeconds)
      Sets the issued at claim that identifies the time (in seconds) at which the JWT was issued or null for none.
      JsonWebToken.Payload setIssuer​(java.lang.String issuer)
      Sets the issuer claim that identifies the principal that issued the JWT or null for none.
      JsonWebToken.Payload setJwtId​(java.lang.String jwtId)
      Sets the JWT ID claim that provides a unique identifier for the JWT or null for none.
      JsonWebToken.Payload setNotBeforeTimeSeconds​(java.lang.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.
      JsonWebToken.Payload setSubject​(java.lang.String subject)
      Sets the subject claim identifying the principal that is the subject of the JWT or null for none.
      JsonWebToken.Payload setType​(java.lang.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.

      • Methods inherited from class java.util.AbstractMap

        clear, containsKey, containsValue, isEmpty, keySet, size, values

      • Methods inherited from class java.lang.Object

        finalize, getClass, notify, notifyAll, wait, wait, wait

      • Methods inherited from interface java.util.Map

        compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

    • Field Detail

      • expirationTimeSeconds

        private java.lang.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 java.lang.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 java.lang.Long issuedAtTimeSeconds
        Issued at claim that identifies the time (in seconds) at which the JWT was issued or null for none.

      • issuer

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

      • audience

        private java.lang.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 java.lang.String jwtId
        JWT ID claim that provides a unique identifier for the JWT or null for none.

      • type

        private java.lang.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 java.lang.String subject
        Subject claim identifying the principal that is the subject of the JWT or null for none.

    • Constructor Detail

      • Payload

        public Payload()

    • Method Detail

      • getExpirationTimeSeconds

        public final java.lang.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​(java.lang.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 java.lang.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​(java.lang.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 java.lang.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​(java.lang.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 java.lang.String getIssuer()
        Returns the issuer claim that identifies the principal that issued the JWT or null for none.

      • setIssuer

        public JsonWebToken.Payload setIssuer​(java.lang.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 java.lang.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 java.util.List<java.lang.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​(java.lang.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 java.lang.String getJwtId()
        Returns the JWT ID claim that provides a unique identifier for the JWT or null for none.

      • setJwtId

        public JsonWebToken.Payload setJwtId​(java.lang.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 java.lang.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​(java.lang.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 java.lang.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​(java.lang.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​(java.lang.String fieldName,
                                java.lang.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