Package org.apereo.cas.authentication.principal

Interface Service

All Superinterfaces:
Principal, Serializable
All Known Subinterfaces:
WebApplicationService
public interface Service extends Principal
Marker interface for Services. Services are generally either remote applications utilizing CAS or applications that principals wish to gain access to. In most cases this will be some form of web application.
Since:
3.0.0

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final org.slf4j.Logger
    LOGGER
    Logger instance.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getOriginalUrl()
    Return the original url provided (as service or targetService request parameter).
    default String
    getShortenedId()
    Gets shortened id.
    void
    setAttributes(Map<String,List<Object>> attributes)
    Sets the attributes.
    default void
    setPrincipal(String principal)
    Sets the principal.

    Methods inherited from interface org.apereo.cas.authentication.principal.Principal

    getAttributes, getId

  • Field Details

    • LOGGER

      static final org.slf4j.Logger LOGGER
      Logger instance.

  • Method Details

    • setPrincipal

      default void setPrincipal(String principal)
      Sets the principal.
      Parameters:
      principal - the new principal

    • setAttributes

      void setAttributes(Map<String,List<Object>> attributes)
      Sets the attributes.
      Parameters:
      attributes - the new attributes

    • getOriginalUrl

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

    • getShortenedId

      default String getShortenedId() throws Exception
      Gets shortened id.
      Returns:
      the shortened id
      Throws:
      Exception - the exception