Service Management

The CAS service management facility allows CAS server administrators to declare and configure which services (CAS clients) may make use of CAS in which ways. The core component of the service management facility is the service registry that stores one or more registered services containing metadata that drives a number of CAS behaviors.

The following settings and properties are available from the CAS configuration catalog:

_{The configuration settings listed below are tagged as Required in the CAS configuration metadata. This flag indicates that the presence of the setting may be needed to activate or affect the behavior of the CAS feature and generally should be reviewed, possibly owned and adjusted. If the setting is assigned a default value, you do not need to strictly put the setting in your copy of the configuration, but should review it nonetheless to make sure it matches your deployment expectations.}

_{The configuration settings listed below are tagged as Optional in the CAS configuration metadata. This
flag indicates that the presence of the setting
is not immediately necessary in the end-user CAS configuration, because a default value is assigned or
the activation of the feature is not conditionally controlled by the setting value. You should only include this field in your
configuration if you need to modify the default value.}

cas.service-registry.core.init-from-json=false

Flag that indicates whether to initialise active service registry implementation with a default set of service definitions included with CAS by default in JSON format. The initialization generally tends to find JSON service definitions from org.apereo.cas.configuration.model.support.services.json.JsonServiceRegistryProperties#getLocation().

org.apereo.cas.configuration.model.core.services.ServiceRegistryCoreProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

:information_source: Note

When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value. The only possible exception to this rule is when naming actuator endpoints; The name of the actuator endpoints (i.e. ssoSessions) MUST remain in camelCase mode.

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.service-registry.core.init-from-json=...

This is the most common form of property configuration that is recognized by CAS, regardless of the actual property source, which might in fact be managed separately outside the CAS environment, by another system or cloud framework.

CAS properties can be specified using the YAML syntax:

cas: 
  service-registry: 
    core: 
      init-from-json: 

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.service-registry.core.init-from-json="..." -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war and can be found in the build/libs directory. Note the placement of the system property which must be specified before the CAS web application is launched.

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_SERVICE_REGISTRY_CORE_INIT_FROM_JSON="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.service-registry.core.init-from-json="..."

The above example assumes that the CAS web application is packaged as cas.war and can be found in the build/libs directory.

cas.service-registry.core.management-type=DEFAULT

Determine how services are internally managed, queried, cached and reloaded by CAS. Accepted values are the following:

DEFAULT: Keep all services inside a concurrent map.
DOMAIN: Group registered services by their domain having been explicitly defined.

Available values are as follows:

DOMAIN: Group service definitions by their domain.
DEFAULT: Default option to keep definitions in a map as they arrive.

org.apereo.cas.configuration.model.core.services.ServiceRegistryCoreProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

:information_source: Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.service-registry.core.management-type=DEFAULT

CAS properties can be specified using the YAML syntax:

cas: 
  service-registry: 
    core: 
      management-type: 

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.service-registry.core.management-type="DEFAULT" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_SERVICE_REGISTRY_CORE_MANAGEMENT_TYPE="DEFAULT"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.service-registry.core.management-type="DEFAULT"

The above example assumes that the CAS web application is packaged as cas.war and can be found in the build/libs directory.