Package com.google.api.client.auth.openidconnect

Class IdToken.Payload

  • All Implemented Interfaces:
    java.lang.Cloneable, java.util.Map<java.lang.String,​java.lang.Object>
    Enclosing class:
    IdToken
    @Beta
public static class IdToken.Payload
extends com.google.api.client.json.webtoken.JsonWebToken.Payload
    Beta
    ID token payload.

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

        com.google.api.client.util.GenericData.Flags

      • 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.String accessTokenHash
      Access token hash value or null for none.
      private java.lang.Long authorizationTimeSeconds
      Time (in seconds) of end-user authorization or null for none.
      private java.lang.String authorizedParty
      Authorized party or null for none.
      private java.lang.String classReference
      Authentication context class reference or null for none.
      private java.util.List<java.lang.String> methodsReferences
      Authentication methods references or null for none.
      private java.lang.String nonce
      Value used to associate a client session with an ID token or null for none.

    • Constructor Summary

      Constructors 
      Constructor Description
      Payload()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      IdToken.Payload clone()  
      java.lang.String getAccessTokenHash()
      Returns the access token hash value or null for none.
      java.lang.Long getAuthorizationTimeSeconds()
      Returns the time (in seconds) of end-user authorization or null for none.
      java.lang.String getAuthorizedParty()
      Returns the authorized party or null for none.
      java.lang.String getClassReference()
      Returns the authentication context class reference or null for none.
      java.util.List<java.lang.String> getMethodsReferences()
      Returns the authentication methods references or null for none.
      java.lang.String getNonce()
      Returns the value used to associate a client session with an ID token or null for none.
      IdToken.Payload set​(java.lang.String fieldName, java.lang.Object value)  
      IdToken.Payload setAccessTokenHash​(java.lang.String accessTokenHash)
      Sets the access token hash value or null for none.
      IdToken.Payload setAudience​(java.lang.Object audience)  
      IdToken.Payload setAuthorizationTimeSeconds​(java.lang.Long authorizationTimeSeconds)
      Sets the time (in seconds) of end-user authorization or null for none.
      IdToken.Payload setAuthorizedParty​(java.lang.String authorizedParty)
      Sets the authorized party or null for none.
      IdToken.Payload setClassReference​(java.lang.String classReference)
      Sets the authentication context class reference or null for none.
      IdToken.Payload setExpirationTimeSeconds​(java.lang.Long expirationTimeSeconds)  
      IdToken.Payload setIssuedAtTimeSeconds​(java.lang.Long issuedAtTimeSeconds)  
      IdToken.Payload setIssuer​(java.lang.String issuer)  
      IdToken.Payload setJwtId​(java.lang.String jwtId)  
      IdToken.Payload setMethodsReferences​(java.util.List<java.lang.String> methodsReferences)
      Sets the authentication methods references or null for none.
      IdToken.Payload setNonce​(java.lang.String nonce)
      Sets the value used to associate a client session with an ID token or null for none.
      IdToken.Payload setNotBeforeTimeSeconds​(java.lang.Long notBeforeTimeSeconds)  
      IdToken.Payload setSubject​(java.lang.String subject)  
      IdToken.Payload setType​(java.lang.String type)  

      • Methods inherited from class com.google.api.client.json.webtoken.JsonWebToken.Payload

        getAudience, getAudienceAsList, getExpirationTimeSeconds, getIssuedAtTimeSeconds, getIssuer, getJwtId, getNotBeforeTimeSeconds, getSubject, getType

      • Methods inherited from class com.google.api.client.json.GenericJson

        getFactory, setFactory, toPrettyString, toString

      • Methods inherited from class com.google.api.client.util.GenericData

        entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

      • Methods inherited from class java.util.AbstractMap

        clear, containsKey, containsValue, equals, hashCode, 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

      • authorizationTimeSeconds

        private java.lang.Long authorizationTimeSeconds
        Time (in seconds) of end-user authorization or null for none.

      • authorizedParty

        private java.lang.String authorizedParty
        Authorized party or null for none.

      • nonce

        private java.lang.String nonce
        Value used to associate a client session with an ID token or null for none.

      • accessTokenHash

        private java.lang.String accessTokenHash
        Access token hash value or null for none.

      • classReference

        private java.lang.String classReference
        Authentication context class reference or null for none.

      • methodsReferences

        private java.util.List<java.lang.String> methodsReferences
        Authentication methods references or null for none.

    • Constructor Detail

      • Payload

        public Payload()

    • Method Detail

      • getAuthorizationTimeSeconds

        public final java.lang.Long getAuthorizationTimeSeconds()
        Returns the time (in seconds) of end-user authorization or null for none.

      • setAuthorizationTimeSeconds

        public IdToken.Payload setAuthorizationTimeSeconds​(java.lang.Long authorizationTimeSeconds)
        Sets the time (in seconds) of end-user authorization or null for none.

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

      • getAuthorizedParty

        public final java.lang.String getAuthorizedParty()
        Returns the authorized party or null for none.

        Upgrade warning: in prior version 1.15 this method returned an Object, but starting with version 1.16 it returns a String.

      • setAuthorizedParty

        public IdToken.Payload setAuthorizedParty​(java.lang.String authorizedParty)
        Sets the authorized party or null for none.

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

        Upgrade warning: in prior version 1.15 the parameter was an Object, but starting with version 1.16 the parameter is a String.

      • getNonce

        public final java.lang.String getNonce()
        Returns the value used to associate a client session with an ID token or null for none.
        Since:
        1.16

      • setNonce

        public IdToken.Payload setNonce​(java.lang.String nonce)
        Sets the value used to associate a client session with an ID token or null for none.

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

        Since:
        1.16

      • getAccessTokenHash

        public final java.lang.String getAccessTokenHash()
        Returns the access token hash value or null for none.
        Since:
        1.16

      • setAccessTokenHash

        public IdToken.Payload setAccessTokenHash​(java.lang.String accessTokenHash)
        Sets the access token hash value or null for none.

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

        Since:
        1.16

      • getClassReference

        public final java.lang.String getClassReference()
        Returns the authentication context class reference or null for none.
        Since:
        1.16

      • setClassReference

        public IdToken.Payload setClassReference​(java.lang.String classReference)
        Sets the authentication context class reference or null for none.

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

        Since:
        1.16

      • getMethodsReferences

        public final java.util.List<java.lang.String> getMethodsReferences()
        Returns the authentication methods references or null for none.
        Since:
        1.16

      • setMethodsReferences

        public IdToken.Payload setMethodsReferences​(java.util.List<java.lang.String> methodsReferences)
        Sets the authentication methods references or null for none.

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

        Since:
        1.16

      • setExpirationTimeSeconds

        public IdToken.Payload setExpirationTimeSeconds​(java.lang.Long expirationTimeSeconds)
        Overrides:
        setExpirationTimeSeconds in class com.google.api.client.json.webtoken.JsonWebToken.Payload

      • setNotBeforeTimeSeconds

        public IdToken.Payload setNotBeforeTimeSeconds​(java.lang.Long notBeforeTimeSeconds)
        Overrides:
        setNotBeforeTimeSeconds in class com.google.api.client.json.webtoken.JsonWebToken.Payload

      • setIssuedAtTimeSeconds

        public IdToken.Payload setIssuedAtTimeSeconds​(java.lang.Long issuedAtTimeSeconds)
        Overrides:
        setIssuedAtTimeSeconds in class com.google.api.client.json.webtoken.JsonWebToken.Payload

      • setIssuer

        public IdToken.Payload setIssuer​(java.lang.String issuer)
        Overrides:
        setIssuer in class com.google.api.client.json.webtoken.JsonWebToken.Payload

      • setAudience

        public IdToken.Payload setAudience​(java.lang.Object audience)
        Overrides:
        setAudience in class com.google.api.client.json.webtoken.JsonWebToken.Payload

      • setJwtId

        public IdToken.Payload setJwtId​(java.lang.String jwtId)
        Overrides:
        setJwtId in class com.google.api.client.json.webtoken.JsonWebToken.Payload

      • setType

        public IdToken.Payload setType​(java.lang.String type)
        Overrides:
        setType in class com.google.api.client.json.webtoken.JsonWebToken.Payload

      • setSubject

        public IdToken.Payload setSubject​(java.lang.String subject)
        Overrides:
        setSubject in class com.google.api.client.json.webtoken.JsonWebToken.Payload

      • set

        public IdToken.Payload set​(java.lang.String fieldName,
                           java.lang.Object value)
        Overrides:
        set in class com.google.api.client.json.webtoken.JsonWebToken.Payload

      • clone

        public IdToken.Payload clone()
        Overrides:
        clone in class com.google.api.client.json.webtoken.JsonWebToken.Payload