Package org.apereo.cas.authentication.principal

Interface WebApplicationService

  • All Superinterfaces:
    Principal, java.io.Serializable, Service
    public interface WebApplicationService
extends Service
    Represents a service using CAS that comes from the web.
    Since:
    3.1

    • Field Summary

      • Fields inherited from interface org.apereo.cas.authentication.principal.Service

        LOGGER

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String getArtifactId()
      Retrieves the artifact supplied with the service.
      org.apereo.cas.validation.ValidationResponseType getFormat()
      Ticket validation response MUST be produced based on the parameter value.
      java.lang.String getOriginalUrl()
      Return the original url provided (as service or targetService request parameter).
      java.lang.String getSource()
      Indicates the source from which the service object was extracted and built.
      boolean isLoggedOutAlready()
      Return if the service is already logged out.
      void setLoggedOutAlready​(boolean loggedOutAlready)
      Set if the service is already logged out.

    • Method Detail

      • getArtifactId

        java.lang.String getArtifactId()
        Retrieves the artifact supplied with the service. May be null.
        Returns:
        the artifact if it exists, null otherwise.

      • getSource

        java.lang.String getSource()
        Indicates the source from which the service object was extracted and built. Typically maps to a request parameter or attribute that provides the request.
        Returns:
        the source if it exists, null otherwise.

      • getOriginalUrl

        java.lang.String getOriginalUrl()
        Return the original url provided (as service or targetService request parameter). Used to reconstruct the redirect url.
        Returns:
        the original url provided.

      • getFormat

        org.apereo.cas.validation.ValidationResponseType getFormat()
        Ticket validation response MUST be produced based on the parameter value. Supported values are XML and JSON. If this parameter is not set, the default XML format will be used. If the parameter value is not supported by the CAS server, an error must be produced.
        Returns:
        the requested format
        Since:
        4.2

      • isLoggedOutAlready

        boolean isLoggedOutAlready()
        Return if the service is already logged out.
        Returns:
        if the service is already logged out.

      • setLoggedOutAlready

        void setLoggedOutAlready​(boolean loggedOutAlready)
        Set if the service is already logged out.
        Parameters:
        loggedOutAlready - if the service is already logged out.