Package org.apereo.cas.ticket.accesstoken

Interface AccessToken

  • All Superinterfaces:
    java.lang.Comparable<org.apereo.cas.ticket.Ticket>, OAuthToken, java.io.Serializable, org.apereo.cas.ticket.ServiceTicket, org.apereo.cas.ticket.Ticket
    public interface AccessToken
extends OAuthToken
    An access token is an OAuth token which can be used multiple times and has a long lifetime. It is used to access resources on behalf of a user and OAuth client.
    Since:
    5.0.0

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String PREFIX
      The prefix for access tokens.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String getIdToken()
      Gets id token.
      void setIdToken​(java.lang.String idToken)
      Sets id token.

      • Methods inherited from interface java.lang.Comparable

        compareTo

      • Methods inherited from interface org.apereo.cas.ticket.ServiceTicket

        getService, grantProxyGrantingTicket, isFromNewLogin, isValidFor

      • Methods inherited from interface org.apereo.cas.ticket.Ticket

        getCountOfUses, getCreationTime, getExpirationPolicy, getId, getPrefix, getTicketGrantingTicket, isExpired, markTicketExpired

    • Field Detail

      • PREFIX

        static final java.lang.String PREFIX
        The prefix for access tokens.
        See Also:
        Constant Field Values

    • Method Detail

      • setIdToken

        void setIdToken​(java.lang.String idToken)
        Sets id token.
        Parameters:
        idToken - the id token

      • getIdToken

        java.lang.String getIdToken()
        Gets id token.
        Returns:
        the id token