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.
Sending Email - Amazon Simple Email Service (SES)
You may instruct CAS to use Amazon SES for sending emails. Support is enabled by including the the following module:
1
2
3
4
5
<dependency>
<groupId>org.apereo.cas</groupId>
<artifactId>cas-server-support-aws-ses</artifactId>
<version>${cas.version}</version>
</dependency>
1
implementation "org.apereo.cas:cas-server-support-aws-ses:${project.'cas.version'}"
1
2
3
4
5
6
7
8
9
dependencyManagement {
imports {
mavenBom "org.apereo.cas:cas-server-support-bom:${project.'cas.version'}"
}
}
dependencies {
implementation "org.apereo.cas:cas-server-support-aws-ses"
}
1
2
3
4
5
6
7
8
9
10
dependencies {
/*
The following platform references should be included automatically and are listed here for reference only.
implementation enforcedPlatform("org.apereo.cas:cas-server-support-bom:${project.'cas.version'}")
implementation platform(org.springframework.boot.gradle.plugin.SpringBootPlugin.BOM_COORDINATES)
*/
implementation "org.apereo.cas:cas-server-support-aws-ses"
}
The following settings and properties are available from the CAS configuration catalog:
- Required
- Optional
- Signing & Encryption
- Hibernate & JDBC
- Groovy Scripting
- LDAP & Active Directory
- Authentication
- Password Encoding
- Principal Transformation
- Password Policy
- Notes
cas.email-provider.ses.credential-access-key=
Use access-key provided by AWS to authenticate. This setting supports the Spring Expression Language.
CAS Property:
|
1 |
cas.email-provider.ses.credential-access-key=... |
1
cas:
email-provider:
ses:
credential-access-key: "..."
1
java -Dcas.email-provider.ses.credential-access-key="..." -jar build/libs/cas.war
cas.war
with an embedded server container 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.
1
2
3
export CAS_EMAIL_PROVIDER_SES_CREDENTIAL_ACCESS_KEY="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.email-provider.ses.credential-access-key="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.email-provider.ses.credential-secret-key=
Use secret key provided by AWS to authenticate.
This setting supports the Spring Expression Language.
org.apereo.cas.configuration.model.support.email.AmazonSesProperties.
CAS Property: cas.email-provider.ses.credential-secret-key
![:information_source: :information_source:](https://github.githubassets.com/images/icons/emoji/unicode/2139.png)
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.
.properties
files:
1
cas.email-provider.ses.credential-secret-key=...
1
cas:
email-provider:
ses:
credential-secret-key: "..."
1
java -Dcas.email-provider.ses.credential-secret-key="..." -jar build/libs/cas.war
cas.war
with an embedded server container 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.
1
2
3
export CAS_EMAIL_PROVIDER_SES_CREDENTIAL_SECRET_KEY="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.email-provider.ses.credential-secret-key="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.email-provider.ses.endpoint=
AWS custom endpoint.
org.apereo.cas.configuration.model.support.email.AmazonSesProperties.
CAS Property: cas.email-provider.ses.endpoint
![:information_source: :information_source:](https://github.githubassets.com/images/icons/emoji/unicode/2139.png)
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.
.properties
files:
1
cas.email-provider.ses.endpoint=...
1
cas:
email-provider:
ses:
endpoint: "..."
1
java -Dcas.email-provider.ses.endpoint="..." -jar build/libs/cas.war
cas.war
with an embedded server container 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.
1
2
3
export CAS_EMAIL_PROVIDER_SES_ENDPOINT="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.email-provider.ses.endpoint="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.email-provider.ses.region=
AWS region used.
org.apereo.cas.configuration.model.support.email.AmazonSesProperties.
CAS Property: cas.email-provider.ses.region
![:information_source: :information_source:](https://github.githubassets.com/images/icons/emoji/unicode/2139.png)
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.
.properties
files:
1
cas.email-provider.ses.region=...
1
cas:
email-provider:
ses:
region: "..."
1
java -Dcas.email-provider.ses.region="..." -jar build/libs/cas.war
cas.war
with an embedded server container 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.
1
2
3
export CAS_EMAIL_PROVIDER_SES_REGION="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.email-provider.ses.region="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.email-provider.ses.client-execution-timeout=10000
Client execution timeout. This settings supports the
CAS Property:
|
1 |
cas.email-provider.ses.client-execution-timeout=10000 |
1
cas:
email-provider:
ses:
client-execution-timeout: "10000"
1
java -Dcas.email-provider.ses.client-execution-timeout="10000" -jar build/libs/cas.war
cas.war
with an embedded server container 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.
1
2
3
export CAS_EMAIL_PROVIDER_SES_CLIENT_EXECUTION_TIMEOUT="10000"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.email-provider.ses.client-execution-timeout="10000"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.email-provider.ses.configuration-set-name=
Configures configuration set name. Configuration sets let you create groups of rules that you can apply to the emails you send using Amazon SES.
org.apereo.cas.configuration.model.support.email.AmazonSesProperties.
CAS Property: cas.email-provider.ses.configuration-set-name
![:information_source: :information_source:](https://github.githubassets.com/images/icons/emoji/unicode/2139.png)
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.
.properties
files:
1
cas.email-provider.ses.configuration-set-name=...
1
cas:
email-provider:
ses:
configuration-set-name: "..."
1
java -Dcas.email-provider.ses.configuration-set-name="..." -jar build/libs/cas.war
cas.war
with an embedded server container 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.
1
2
3
export CAS_EMAIL_PROVIDER_SES_CONFIGURATION_SET_NAME="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.email-provider.ses.configuration-set-name="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.email-provider.ses.connection-timeout=5000
Connection timeout.
This settings supports the
java.time.Duration
syntax [?].
org.apereo.cas.configuration.model.support.email.AmazonSesProperties.
CAS Property: cas.email-provider.ses.connection-timeout
![:information_source: :information_source:](https://github.githubassets.com/images/icons/emoji/unicode/2139.png)
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.
.properties
files:
1
cas.email-provider.ses.connection-timeout=5000
1
cas:
email-provider:
ses:
connection-timeout: "5000"
1
java -Dcas.email-provider.ses.connection-timeout="5000" -jar build/libs/cas.war
cas.war
with an embedded server container 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.
1
2
3
export CAS_EMAIL_PROVIDER_SES_CONNECTION_TIMEOUT="5000"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.email-provider.ses.connection-timeout="5000"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.email-provider.ses.local-address=
Local address.
org.apereo.cas.configuration.model.support.email.AmazonSesProperties.
CAS Property: cas.email-provider.ses.local-address
![:information_source: :information_source:](https://github.githubassets.com/images/icons/emoji/unicode/2139.png)
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.
.properties
files:
1
cas.email-provider.ses.local-address=...
1
cas:
email-provider:
ses:
local-address: "..."
1
java -Dcas.email-provider.ses.local-address="..." -jar build/libs/cas.war
cas.war
with an embedded server container 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.
1
2
3
export CAS_EMAIL_PROVIDER_SES_LOCAL_ADDRESS="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.email-provider.ses.local-address="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.email-provider.ses.max-connections=10
Maximum connections setting.
org.apereo.cas.configuration.model.support.email.AmazonSesProperties.
CAS Property: cas.email-provider.ses.max-connections
![:information_source: :information_source:](https://github.githubassets.com/images/icons/emoji/unicode/2139.png)
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.
.properties
files:
1
cas.email-provider.ses.max-connections=10
1
cas:
email-provider:
ses:
max-connections: "10"
1
java -Dcas.email-provider.ses.max-connections="10" -jar build/libs/cas.war
cas.war
with an embedded server container 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.
1
2
3
export CAS_EMAIL_PROVIDER_SES_MAX_CONNECTIONS="10"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.email-provider.ses.max-connections="10"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.email-provider.ses.profile-name=
Profile name to use.
org.apereo.cas.configuration.model.support.email.AmazonSesProperties.
CAS Property: cas.email-provider.ses.profile-name
![:information_source: :information_source:](https://github.githubassets.com/images/icons/emoji/unicode/2139.png)
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.
.properties
files:
1
cas.email-provider.ses.profile-name=...
1
cas:
email-provider:
ses:
profile-name: "..."
1
java -Dcas.email-provider.ses.profile-name="..." -jar build/libs/cas.war
cas.war
with an embedded server container 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.
1
2
3
export CAS_EMAIL_PROVIDER_SES_PROFILE_NAME="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.email-provider.ses.profile-name="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.email-provider.ses.profile-path=
Profile path.
org.apereo.cas.configuration.model.support.email.AmazonSesProperties.
CAS Property: cas.email-provider.ses.profile-path
![:information_source: :information_source:](https://github.githubassets.com/images/icons/emoji/unicode/2139.png)
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.
.properties
files:
1
cas.email-provider.ses.profile-path=...
1
cas:
email-provider:
ses:
profile-path: "..."
1
java -Dcas.email-provider.ses.profile-path="..." -jar build/libs/cas.war
cas.war
with an embedded server container 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.
1
2
3
export CAS_EMAIL_PROVIDER_SES_PROFILE_PATH="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.email-provider.ses.profile-path="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.email-provider.ses.proxy-host=
Optionally specifies the proxy host to connect through.
org.apereo.cas.configuration.model.support.email.AmazonSesProperties.
CAS Property: cas.email-provider.ses.proxy-host
![:information_source: :information_source:](https://github.githubassets.com/images/icons/emoji/unicode/2139.png)
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.
.properties
files:
1
cas.email-provider.ses.proxy-host=...
1
cas:
email-provider:
ses:
proxy-host: "..."
1
java -Dcas.email-provider.ses.proxy-host="..." -jar build/libs/cas.war
cas.war
with an embedded server container 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.
1
2
3
export CAS_EMAIL_PROVIDER_SES_PROXY_HOST="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.email-provider.ses.proxy-host="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.email-provider.ses.proxy-password=
Optionally specifies the proxy password to connect through.
org.apereo.cas.configuration.model.support.email.AmazonSesProperties.
CAS Property: cas.email-provider.ses.proxy-password
![:information_source: :information_source:](https://github.githubassets.com/images/icons/emoji/unicode/2139.png)
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.
.properties
files:
1
cas.email-provider.ses.proxy-password=...
1
cas:
email-provider:
ses:
proxy-password: "..."
1
java -Dcas.email-provider.ses.proxy-password="..." -jar build/libs/cas.war
cas.war
with an embedded server container 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.
1
2
3
export CAS_EMAIL_PROVIDER_SES_PROXY_PASSWORD="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.email-provider.ses.proxy-password="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.email-provider.ses.proxy-username=
Optionally specifies the proxy username to connect through.
org.apereo.cas.configuration.model.support.email.AmazonSesProperties.
CAS Property: cas.email-provider.ses.proxy-username
![:information_source: :information_source:](https://github.githubassets.com/images/icons/emoji/unicode/2139.png)
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.
.properties
files:
1
cas.email-provider.ses.proxy-username=...
1
cas:
email-provider:
ses:
proxy-username: "..."
1
java -Dcas.email-provider.ses.proxy-username="..." -jar build/libs/cas.war
cas.war
with an embedded server container 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.
1
2
3
export CAS_EMAIL_PROVIDER_SES_PROXY_USERNAME="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.email-provider.ses.proxy-username="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.email-provider.ses.retry-mode=STANDARD
Outline the requested retry mode. Accepted values are STANDARD, LEGACY
.
org.apereo.cas.configuration.model.support.email.AmazonSesProperties.
CAS Property: cas.email-provider.ses.retry-mode
![:information_source: :information_source:](https://github.githubassets.com/images/icons/emoji/unicode/2139.png)
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.
.properties
files:
1
cas.email-provider.ses.retry-mode=STANDARD
1
cas:
email-provider:
ses:
retry-mode: "STANDARD"
1
java -Dcas.email-provider.ses.retry-mode="STANDARD" -jar build/libs/cas.war
cas.war
with an embedded server container 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.
1
2
3
export CAS_EMAIL_PROVIDER_SES_RETRY_MODE="STANDARD"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.email-provider.ses.retry-mode="STANDARD"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.email-provider.ses.socket-timeout=5000
Socket timeout.
This settings supports the
java.time.Duration
syntax [?].
org.apereo.cas.configuration.model.support.email.AmazonSesProperties.
CAS Property: cas.email-provider.ses.socket-timeout
![:information_source: :information_source:](https://github.githubassets.com/images/icons/emoji/unicode/2139.png)
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.
.properties
files:
1
cas.email-provider.ses.socket-timeout=5000
1
cas:
email-provider:
ses:
socket-timeout: "5000"
1
java -Dcas.email-provider.ses.socket-timeout="5000" -jar build/libs/cas.war
cas.war
with an embedded server container 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.
1
2
3
export CAS_EMAIL_PROVIDER_SES_SOCKET_TIMEOUT="5000"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.email-provider.ses.socket-timeout="5000"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.email-provider.ses.source-arn=
Configures source ARN. Used only for sending authorization. The ARN of the identity that is associated with the sending authorization policy that permits you to send for the email address specified.
org.apereo.cas.configuration.model.support.email.AmazonSesProperties.
CAS Property: cas.email-provider.ses.source-arn
![:information_source: :information_source:](https://github.githubassets.com/images/icons/emoji/unicode/2139.png)
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.
.properties
files:
1
cas.email-provider.ses.source-arn=...
1
cas:
email-provider:
ses:
source-arn: "..."
1
java -Dcas.email-provider.ses.source-arn="..." -jar build/libs/cas.war
cas.war
with an embedded server container 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.
1
2
3
export CAS_EMAIL_PROVIDER_SES_SOURCE_ARN="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.email-provider.ses.source-arn="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.email-provider.ses.use-reaper=false
Flag that indicates whether to use reaper.
org.apereo.cas.configuration.model.support.email.AmazonSesProperties.
CAS Property: cas.email-provider.ses.use-reaper
![:information_source: :information_source:](https://github.githubassets.com/images/icons/emoji/unicode/2139.png)
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.
.properties
files:
1
cas.email-provider.ses.use-reaper=...
1
cas:
email-provider:
ses:
use-reaper: "..."
1
java -Dcas.email-provider.ses.use-reaper="..." -jar build/libs/cas.war
cas.war
with an embedded server container 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.
1
2
3
export CAS_EMAIL_PROVIDER_SES_USE_REAPER="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.email-provider.ses.use-reaper="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
Configuration Metadata
The collection of configuration properties listed in this section are automatically generated from the CAS source and components that contain the actual field definitions, types, descriptions, modules, etc. This metadata may not always be 100% accurate, or could be lacking details and sufficient explanations.
Be Selective
This section is meant as a guide only. Do NOT copy/paste the entire collection of settings into your CAS configuration; rather pick only the properties that you need. Do NOT enable settings unless you are certain of their purpose and do NOT copy settings into your configuration only to keep them as reference. All these ideas lead to upgrade headaches, maintenance nightmares and premature aging.
YAGNI
Note that for nearly ALL use cases, declaring and configuring properties listed here is sufficient. You should NOT have to explicitly massage a CAS XML/Java/etc configuration file to design an authentication handler, create attribute release policies, etc. CAS at runtime will auto-configure all required changes for you. If you are unsure about the meaning of a given CAS setting, do NOT turn it on without hesitation. Review the codebase or better yet, ask questions to clarify the intended behavior.
Naming Convention
Property names can be specified in very relaxed terms. For instance cas.someProperty
, cas.some-property
, cas.some_property
are all valid names. While all
forms are accepted by CAS, there are certain components (in CAS and other frameworks used) whose activation at runtime is conditional on a property value, where
this property is required to have been specified in CAS configuration using kebab case. This is both true for properties that are owned by CAS as well as those
that might be presented to the system via an external library or framework such as Spring Boot, etc.
![:information_source: :information_source:](https://github.githubassets.com/images/icons/emoji/unicode/2139.png)
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.
Settings and properties that are controlled by the CAS platform directly always begin with the prefix cas
. All other settings are controlled and provided
to CAS via other underlying frameworks and may have their own schemas and syntax. BE CAREFUL with
the distinction. Unrecognized properties are rejected by CAS and/or frameworks upon which CAS depends. This means if you somehow misspell a property definition
or fail to adhere to the dot-notation syntax and such, your setting is entirely refused by CAS and likely the feature it controls will never be activated in the
way you intend.
Validation
Configuration properties are automatically validated on CAS startup to report issues with configuration binding, specially if defined CAS settings cannot be recognized or validated by the configuration schema. Additional validation processes are also handled via Configuration Metadata and property migrations applied automatically on startup by Spring Boot and family.
Indexed Settings
CAS settings able to accept multiple values are typically documented with an index, such as cas.some.setting[0]=value
. The index [0]
is meant to be
incremented by the adopter to allow for distinct multiple configuration blocks.