WORKERS AHEAD!

You are viewing the development documentation for the Apereo CAS server. The functionality presented here is not officially released yet. This is a work in progress and will be continually updated as development moves forward. You are most encouraged to test the changes presented.

To view the documentation for a specific Apereo CAS server release, please choose an appropriate version. The release schedule is available here.

Service Registry Initialization

Upon startup and configuration permitting, the registry is able to auto initialize itself from default JSON service definitions available to CAS. Populating the registry with a set of default services serves as a starting point and an example at that where one is able to immediately start integrating applications. For production purposes, it is recommended that you pick a more relevant option for storage and disable this behavior.

The default service definitions that are used by the initializer component ship with CAS by default and are put on the classpath. The initializer is able to detect all service definitions files found on the classpath (i.e. src/main/resources/services) and import them into the real service registry used. This means that if this behavior is enabled and additional files are found on the classpath at the relevant paths, CAS will take the default services as well as any and all other services found in order to import them into the service registry used. Note that the location of the JSON files while typically set to the classpath may be controlled via CAS properties; The same setting property that controls the location of the JSON service files for the JSON service registry is used by the initialization logic to locate service files.

Again, this behavior is only useful as a starting point, an example and for small and specialized deployments. It is recommended that you take explicit control over the registry and register services and applications which you have fully authorized.

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.}