Package org.apereo.cas.ticket

Interface OAuth20Token

All Superinterfaces:
org.apereo.cas.ticket.AuthenticationAwareTicket, Comparable<org.apereo.cas.ticket.Ticket>, Serializable, org.apereo.cas.ticket.ServiceTicket, org.apereo.cas.ticket.Ticket, org.apereo.cas.ticket.TicketGrantingTicketAwareTicket
All Known Subinterfaces:
OAuth20AccessToken, OAuth20Code, OAuth20RefreshToken
public interface OAuth20Token extends org.apereo.cas.ticket.ServiceTicket
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

    Modifier and Type
    Method
    Description
    Map<String,Map<String,Object>>
    getClaims()
    Collection of requested claims, if any.
    String
    getClientId()
    Client id for whom this token was issued.
    OAuth20GrantTypes
    getGrantType()
    Gets grant type.
    OAuth20ResponseTypes
    getResponseType()
    Gets response type.
    Set<String>
    getScopes()
    Get requested scopes requested at the time of issuing this code.
    default boolean
    isCode()
    Is oauth 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

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

    getCountOfUses, getCreationTime, getExpirationPolicy, getId, getLastTimeUsed, getPrefix, getPreviousTimeUsed, isExpired, markTicketExpired, update

    Methods inherited from interface org.apereo.cas.ticket.TicketGrantingTicketAwareTicket

    getTicketGrantingTicket

  • Method Details

    • getScopes

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

    • getClaims

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

    • getClientId

      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

    • isCode

      default boolean isCode()
      Is oauth code?
      Returns:
      true/false