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

Class ServiceRegistryCoreProperties

java.lang.Object
org.apereo.cas.configuration.model.core.services.ServiceRegistryCoreProperties
All Implemented Interfaces:
Serializable
@RequiresModule(name="cas-server-core-services", automated=true) public class ServiceRegistryCoreProperties extends Object implements Serializable
This is ServiceRegistryCoreProperties.
Since:
6.4.0
See Also:

  • Constructor Details

    • ServiceRegistryCoreProperties

      public ServiceRegistryCoreProperties()

  • Method Details

    • isInitFromJson

      public boolean isInitFromJson()
      Flag that indicates whether to initialise active service registry implementation with a set of service definitions included with CAS by default in JSON format. The initialization generally tends to find JSON service definitions from SpringResourceProperties.getLocation().

      In cases where the location points to an embedded directory or resource inside a JAR/ZIP file, such as those that might have been packaged with the CAS application as part of the build and assembly process, embedded services are first exported out into a temporary directory and then read as file-system resources. In such scenarios, you may want to turn off the watcher via JsonServiceRegistryProperties.isWatcherEnabled().

      If the default location offered by CAS, "services", is used, CAS would attempt to locate JSON service files by forming the following pattern for each active spring application profile: 

      classpath*:/"services"/profile-id/*.json

      You may also control whether default services should be included and initialized via isInitDefaultServices().

    • isInitDefaultServices

      public boolean isInitDefaultServices()
      Flag that indicates whether service definitions that ship with CAS by default should be included in the initialization process and imported into CAS service registry. Default service files that ship with CAS are found on the classpath inside the "services" directory.

    • getManagementType

      public ServiceRegistryCoreProperties.ServiceManagementTypes getManagementType()
      Determine how services are internally managed, queried, cached and reloaded by CAS.

    • setInitFromJson

      public ServiceRegistryCoreProperties setInitFromJson(boolean initFromJson)
      Flag that indicates whether to initialise active service registry implementation with a set of service definitions included with CAS by default in JSON format. The initialization generally tends to find JSON service definitions from SpringResourceProperties.getLocation().

      In cases where the location points to an embedded directory or resource inside a JAR/ZIP file, such as those that might have been packaged with the CAS application as part of the build and assembly process, embedded services are first exported out into a temporary directory and then read as file-system resources. In such scenarios, you may want to turn off the watcher via JsonServiceRegistryProperties.isWatcherEnabled().

      If the default location offered by CAS, "services", is used, CAS would attempt to locate JSON service files by forming the following pattern for each active spring application profile: 

      classpath*:/"services"/profile-id/*.json

      You may also control whether default services should be included and initialized via isInitDefaultServices().

      Returns:
      this.

    • setInitDefaultServices

      public ServiceRegistryCoreProperties setInitDefaultServices(boolean initDefaultServices)
      Flag that indicates whether service definitions that ship with CAS by default should be included in the initialization process and imported into CAS service registry. Default service files that ship with CAS are found on the classpath inside the "services" directory.
      Returns:
      this.

    • setManagementType

      public ServiceRegistryCoreProperties setManagementType(ServiceRegistryCoreProperties.ServiceManagementTypes managementType)
      Determine how services are internally managed, queried, cached and reloaded by CAS.
      Returns:
      this.