Package org.apereo.cas.ticket

Interface OAuth20Token

  • All Superinterfaces:
    org.apereo.cas.ticket.AuthenticationAwareTicket, java.lang.Comparable<org.apereo.cas.ticket.Ticket>, java.io.Serializable, org.apereo.cas.ticket.ServiceTicket, org.apereo.cas.ticket.Ticket
    All Known Subinterfaces:
    OAuth20AccessToken, OAuth20Code, OAuth20RefreshToken
    public interface OAuth20Token
extends org.apereo.cas.ticket.ServiceTicket, org.apereo.cas.ticket.AuthenticationAwareTicket
    OAuth tokens are mostly like service tickets: they deal with authentication and service.
    Since:
    5.0.0

    • Field Summary

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

        PREFIX

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.util.Map<java.lang.String,​java.util.Map<java.lang.String,​java.lang.Object>> getClaims()
      Collection of requested claims, if any.
      java.lang.String getClientId()
      Client id for whom this token was issued.
      OAuth20GrantTypes getGrantType()
      Gets grant type.
      OAuth20ResponseTypes getResponseType()
      Gets response type.
      java.util.Set<java.lang.String> getScopes()
      Get requested scopes requested at the time of issuing this code.

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

        getAuthentication

      • Methods inherited from interface java.lang.Comparable

        compareTo

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

        getService, grantProxyGrantingTicket, isFromNewLogin

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

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

    • Method Detail

      • getScopes

        java.util.Set<java.lang.String> getScopes()
        Get requested scopes requested at the time of issuing this code.
        Returns:
        requested scopes.

      • getClaims

        java.util.Map<java.lang.String,​java.util.Map<java.lang.String,​java.lang.Object>> getClaims()
        Collection of requested claims, if any.
        Returns:
        map of requested claims.

      • getClientId

        java.lang.String getClientId()
        Client id for whom this token was issued.
        Returns:
        client id.

      • getResponseType

        OAuth20ResponseTypes getResponseType()
        Gets response type.
        Returns:
        the response type

      • getGrantType

        OAuth20GrantTypes getGrantType()
        Gets grant type.
        Returns:
        the grant type