Package org.apereo.cas.ticket.code

Interface OAuthCode

  • 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 OAuthCode
extends OAuthToken
    An OAuth code is an OAuth token which can be used only once and has a short lifetime. It is used to grant access tokens.
    Since:
    5.0.0

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String PREFIX
      The prefix for OAuth codes.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String getCodeChallenge()
      The PKCE code challenge.
      java.lang.String getCodeChallengeMethod()
      The PKCE code challenge method.

      • 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 OAuth codes.
        See Also:
        Constant Field Values

    • Method Detail

      • getCodeChallenge

        java.lang.String getCodeChallenge()
        The PKCE code challenge.
        Returns:
        code challenge

      • getCodeChallengeMethod

        java.lang.String getCodeChallengeMethod()
        The PKCE code challenge method.
        Returns:
        code challenge method (i.e. plain, S256, etc)