Interface ProxyHandler

  • Functional Interface:
    This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

    @FunctionalInterface
    public interface ProxyHandler
    Abstraction for what needs to be done to handle proxies. Useful because the generic flow for all authentication is similar the actions taken for proxying are different. One can swap in/out implementations but keep the flow of events the same.
    Since:
    3.0.0
    • Method Summary

      All Methods Instance Methods Abstract Methods Default Methods 
      Modifier and Type Method Description
      default boolean canHandle​(org.apereo.cas.authentication.Credential credential)
      Whether this handler can support the proxy request identified by the given credentials.
      java.lang.String handle​(org.apereo.cas.authentication.Credential credential, TicketGrantingTicket proxyGrantingTicketId)
      Method to actually process the proxy request.
    • Method Detail

      • handle

        java.lang.String handle​(org.apereo.cas.authentication.Credential credential,
                                TicketGrantingTicket proxyGrantingTicketId)
        Method to actually process the proxy request.
        Parameters:
        credential - The credential of the item that will be proxying.
        proxyGrantingTicketId - The ticketId for the PGT (which really is a TGT)
        Returns:
        the String value that needs to be passed to the CAS client.
      • canHandle

        default boolean canHandle​(org.apereo.cas.authentication.Credential credential)
        Whether this handler can support the proxy request identified by the given credentials.
        Parameters:
        credential - the credential object containing the proxy request details.
        Returns:
        true, if successful