Package org.apereo.cas.configuration.model.core.sso

Class SingleSignOnServicesProperties

java.lang.Object
org.apereo.cas.configuration.model.core.sso.SingleSignOnServicesProperties
All Implemented Interfaces:
Serializable
@RequiresModule(name="cas-server-core-authentication", automated=true) public class SingleSignOnServicesProperties extends Object implements Serializable
Configuration properties class for SSO services settings.
Since:
7.0.0
See Also:

  • Constructor Details

    • SingleSignOnServicesProperties

      public SingleSignOnServicesProperties()

  • Method Details

    • isAllowMissingServiceParameter

      public boolean isAllowMissingServiceParameter()
      Flag that indicates whether to allow SSO session with a missing target service.

      By default, CAS will present a generic success page if the initial authentication request does not identify the target application. In some cases, the ability to login to CAS without logging in to a particular service may be considered a misfeature because in practice, too few users and institutions are prepared to understand, brand, and support what is at best a fringe use case of logging in to CAS for the sake of establishing an SSO session without logging in to any CAS-reliant service.

    • getRequiredServicePattern

      public String getRequiredServicePattern()
      A regular expression pattern that represents an application which must have established a session with CAS already before access to other applications can be allowed by CAS. This is the initial mandatory/required application with which the user must start before going anywhere else. Services that establish a session with CAS typically do so by receiving a service ticket from CAS.

    • setAllowMissingServiceParameter

      public SingleSignOnServicesProperties setAllowMissingServiceParameter(boolean allowMissingServiceParameter)
      Flag that indicates whether to allow SSO session with a missing target service.

      By default, CAS will present a generic success page if the initial authentication request does not identify the target application. In some cases, the ability to login to CAS without logging in to a particular service may be considered a misfeature because in practice, too few users and institutions are prepared to understand, brand, and support what is at best a fringe use case of logging in to CAS for the sake of establishing an SSO session without logging in to any CAS-reliant service.

      Returns:
      this.

    • setRequiredServicePattern

      public SingleSignOnServicesProperties setRequiredServicePattern(String requiredServicePattern)
      A regular expression pattern that represents an application which must have established a session with CAS already before access to other applications can be allowed by CAS. This is the initial mandatory/required application with which the user must start before going anywhere else. Services that establish a session with CAS typically do so by receiving a service ticket from CAS.
      Returns:
      this.