Configuration Metadata

CAS ships with meta-data files that provide details of all supported configuration properties and settings. The repository of all configuration metadata is generated automatically at build and release time by processing all items annotated with @ConfigurationProperties within the codebase. This repository is then made available for additional querying and filtering to look up definitions of a given property or locate relevant settings that apply to a particular group of functionality in CAS, such as LDAP authentication.

Support is enabled by including the following dependency in the WAR overlay:

1
2
3
4
5
<dependency>
  <groupId>org.apereo.cas</groupId>
  <artifactId>cas-server-core-configuration-metadata-repository</artifactId>
  <version>${cas.version}</version>
</dependency>

Configuration metadata may also be accessed and queried using the CAS actuator endpoints. See this guide to learn more.

Administrative Endpoints

The following endpoints are provided by CAS:

Endpoint Description
configurationMetadata Exposes CAS configuration metadata that can be used to query settings. The default endpoint presents a list of all settings recognized by CAS, with the added capability to search for a specific CAS setting by its partial name as a selector. This interface ships with CAS by default and you need not do anything special to enable it.

Metadata via Commandline

The metadata repository can also be examined using the command-line as a separate utility. See this guide for more info.