Amazon SNS SMS Messaging
To learn more, visit this site.
1
2
3
4
5
<dependency>
<groupId>org.apereo.cas</groupId>
<artifactId>cas-server-support-sms-aws-sns</artifactId>
<version>${cas.version}</version>
</dependency>
1
implementation "org.apereo.cas:cas-server-support-sms-aws-sns:${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-sms-aws-sns"
}
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-sms-aws-sns"
}
The following settings and properties are available from the CAS configuration catalog:
- Required
- Optional
- Signing & Encryption
- Hibernate & JDBC
- Email Servers
- Groovy Scripting
- LDAP & Active Directory
- Authentication
- Password Encoding
- Principal Transformation
- Password Policy
- Notes
cas.sms-provider.sns.credential-access-key=
Use access-key provided by AWS to authenticate. This setting supports the Spring Expression Language.
CAS Property:
|
1 |
cas.sms-provider.sns.credential-access-key=... |
1
cas:
sms-provider:
sns:
credential-access-key: "..."
1
java -Dcas.sms-provider.sns.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_SMS_PROVIDER_SNS_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.sms-provider.sns.credential-access-key="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.sms-provider.sns.credential-secret-key=
Use secret key provided by AWS to authenticate.
This setting supports the Spring Expression Language.
org.apereo.cas.configuration.model.support.sms.AmazonSnsProperties.
CAS Property: cas.sms-provider.sns.credential-secret-key
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.sms-provider.sns.credential-secret-key=...
1
cas:
sms-provider:
sns:
credential-secret-key: "..."
1
java -Dcas.sms-provider.sns.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_SMS_PROVIDER_SNS_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.sms-provider.sns.credential-secret-key="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.sms-provider.sns.endpoint=
AWS custom endpoint.
org.apereo.cas.configuration.model.support.sms.AmazonSnsProperties.
CAS Property: cas.sms-provider.sns.endpoint
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.sms-provider.sns.endpoint=...
1
cas:
sms-provider:
sns:
endpoint: "..."
1
java -Dcas.sms-provider.sns.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_SMS_PROVIDER_SNS_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.sms-provider.sns.endpoint="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.sms-provider.sns.region=
AWS region used.
org.apereo.cas.configuration.model.support.sms.AmazonSnsProperties.
CAS Property: cas.sms-provider.sns.region
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.sms-provider.sns.region=...
1
cas:
sms-provider:
sns:
region: "..."
1
java -Dcas.sms-provider.sns.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_SMS_PROVIDER_SNS_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.sms-provider.sns.region="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.sms-provider.sns.client-execution-timeout=10000
Client execution timeout. This settings supports the
CAS Property:
|
1 |
cas.sms-provider.sns.client-execution-timeout=10000 |
1
cas:
sms-provider:
sns:
client-execution-timeout: "10000"
1
java -Dcas.sms-provider.sns.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_SMS_PROVIDER_SNS_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.sms-provider.sns.client-execution-timeout="10000"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.sms-provider.sns.connection-timeout=5000
Connection timeout.
This settings supports the
java.time.Duration
syntax [?].
org.apereo.cas.configuration.model.support.sms.AmazonSnsProperties.
CAS Property: cas.sms-provider.sns.connection-timeout
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.sms-provider.sns.connection-timeout=5000
1
cas:
sms-provider:
sns:
connection-timeout: "5000"
1
java -Dcas.sms-provider.sns.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_SMS_PROVIDER_SNS_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.sms-provider.sns.connection-timeout="5000"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.sms-provider.sns.local-address=
Local address.
org.apereo.cas.configuration.model.support.sms.AmazonSnsProperties.
CAS Property: cas.sms-provider.sns.local-address
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.sms-provider.sns.local-address=...
1
cas:
sms-provider:
sns:
local-address: "..."
1
java -Dcas.sms-provider.sns.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_SMS_PROVIDER_SNS_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.sms-provider.sns.local-address="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.sms-provider.sns.max-connections=10
Maximum connections setting.
org.apereo.cas.configuration.model.support.sms.AmazonSnsProperties.
CAS Property: cas.sms-provider.sns.max-connections
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.sms-provider.sns.max-connections=10
1
cas:
sms-provider:
sns:
max-connections: "10"
1
java -Dcas.sms-provider.sns.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_SMS_PROVIDER_SNS_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.sms-provider.sns.max-connections="10"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.sms-provider.sns.max-price=
The maximum amount in USD that you are willing to spend to send the SMS message.
Amazon SNS will not send the message if it determines that doing so would incur a cost that exceeds the maximum price. This attribute has no effect if your month-to-date SMS costs have already exceeded the limit set for the MonthlySpendLimit attribute, which you set by using the SetSMSAttributes request. If you are sending the message to an Amazon SNS topic, the maximum price applies to each message delivery to each phone number that is subscribed to the topic. org.apereo.cas.configuration.model.support.sms.AmazonSnsProperties.
CAS Property: cas.sms-provider.sns.max-price
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.sms-provider.sns.max-price=...
1
cas:
sms-provider:
sns:
max-price: "..."
1
java -Dcas.sms-provider.sns.max-price="..." -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_SMS_PROVIDER_SNS_MAX_PRICE="..."
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.sms-provider.sns.max-price="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.sms-provider.sns.profile-name=
Profile name to use.
org.apereo.cas.configuration.model.support.sms.AmazonSnsProperties.
CAS Property: cas.sms-provider.sns.profile-name
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.sms-provider.sns.profile-name=...
1
cas:
sms-provider:
sns:
profile-name: "..."
1
java -Dcas.sms-provider.sns.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_SMS_PROVIDER_SNS_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.sms-provider.sns.profile-name="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.sms-provider.sns.profile-path=
Profile path.
org.apereo.cas.configuration.model.support.sms.AmazonSnsProperties.
CAS Property: cas.sms-provider.sns.profile-path
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.sms-provider.sns.profile-path=...
1
cas:
sms-provider:
sns:
profile-path: "..."
1
java -Dcas.sms-provider.sns.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_SMS_PROVIDER_SNS_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.sms-provider.sns.profile-path="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.sms-provider.sns.proxy-host=
Optionally specifies the proxy host to connect through.
org.apereo.cas.configuration.model.support.sms.AmazonSnsProperties.
CAS Property: cas.sms-provider.sns.proxy-host
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.sms-provider.sns.proxy-host=...
1
cas:
sms-provider:
sns:
proxy-host: "..."
1
java -Dcas.sms-provider.sns.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_SMS_PROVIDER_SNS_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.sms-provider.sns.proxy-host="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.sms-provider.sns.proxy-password=
Optionally specifies the proxy password to connect through.
org.apereo.cas.configuration.model.support.sms.AmazonSnsProperties.
CAS Property: cas.sms-provider.sns.proxy-password
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.sms-provider.sns.proxy-password=...
1
cas:
sms-provider:
sns:
proxy-password: "..."
1
java -Dcas.sms-provider.sns.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_SMS_PROVIDER_SNS_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.sms-provider.sns.proxy-password="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.sms-provider.sns.proxy-username=
Optionally specifies the proxy username to connect through.
org.apereo.cas.configuration.model.support.sms.AmazonSnsProperties.
CAS Property: cas.sms-provider.sns.proxy-username
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.sms-provider.sns.proxy-username=...
1
cas:
sms-provider:
sns:
proxy-username: "..."
1
java -Dcas.sms-provider.sns.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_SMS_PROVIDER_SNS_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.sms-provider.sns.proxy-username="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.sms-provider.sns.retry-mode=STANDARD
Outline the requested retry mode. Accepted values are STANDARD, LEGACY
.
org.apereo.cas.configuration.model.support.sms.AmazonSnsProperties.
CAS Property: cas.sms-provider.sns.retry-mode
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.sms-provider.sns.retry-mode=STANDARD
1
cas:
sms-provider:
sns:
retry-mode: "STANDARD"
1
java -Dcas.sms-provider.sns.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_SMS_PROVIDER_SNS_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.sms-provider.sns.retry-mode="STANDARD"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.sms-provider.sns.sender-id=
A custom ID that contains up to 11 alphanumeric characters, including at least one letter and no spaces.
The sender ID is displayed as the message sender on the receiving device. For example, you can use your business brand to make the message source easier to recognize. Support for sender IDs varies by country and/or region. For example, messages delivered to U.S. phone numbers will not display the sender ID. If you do not specify a sender ID, the message will display a long code as the sender ID in supported countries and regions. For countries or regions that require an alphabetic sender ID, the message displays NOTICE as the sender ID. org.apereo.cas.configuration.model.support.sms.AmazonSnsProperties.
CAS Property: cas.sms-provider.sns.sender-id
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.sms-provider.sns.sender-id=...
1
cas:
sms-provider:
sns:
sender-id: "..."
1
java -Dcas.sms-provider.sns.sender-id="..." -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_SMS_PROVIDER_SNS_SENDER_ID="..."
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.sms-provider.sns.sender-id="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.sms-provider.sns.sms-type=Transactional
The type of message that you are sending.
- Promotional - Noncritical messages, such as marketing messages. Amazon SNS optimizes the message delivery to incur the lowest cost.
- Transactional – Critical messages that support customer transactions, such as one-time passcodes for multi-factor authentication. Amazon SNS optimizes the message delivery to achieve the highest reliability.
org.apereo.cas.configuration.model.support.sms.AmazonSnsProperties.
CAS Property: cas.sms-provider.sns.sms-type
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.sms-provider.sns.sms-type=Transactional
1
cas:
sms-provider:
sns:
sms-type: "Transactional"
1
java -Dcas.sms-provider.sns.sms-type="Transactional" -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_SMS_PROVIDER_SNS_SMS_TYPE="Transactional"
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.sms-provider.sns.sms-type="Transactional"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.sms-provider.sns.socket-timeout=5000
Socket timeout.
This settings supports the
java.time.Duration
syntax [?].
org.apereo.cas.configuration.model.support.sms.AmazonSnsProperties.
CAS Property: cas.sms-provider.sns.socket-timeout
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.sms-provider.sns.socket-timeout=5000
1
cas:
sms-provider:
sns:
socket-timeout: "5000"
1
java -Dcas.sms-provider.sns.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_SMS_PROVIDER_SNS_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.sms-provider.sns.socket-timeout="5000"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.sms-provider.sns.use-reaper=false
Flag that indicates whether to use reaper.
org.apereo.cas.configuration.model.support.sms.AmazonSnsProperties.
CAS Property: cas.sms-provider.sns.use-reaper
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.sms-provider.sns.use-reaper=...
1
cas:
sms-provider:
sns:
use-reaper: "..."
1
java -Dcas.sms-provider.sns.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_SMS_PROVIDER_SNS_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.sms-provider.sns.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.
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.