CAS - SMS Messaging

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 learn more, visit this site.

<dependency>
    <groupId>org.apereo.cas</groupId>
    <artifactId>cas-server-support-sms-aws-sns</artifactId>
    <version>${cas.version}</version>
</dependency>

implementation "org.apereo.cas:cas-server-support-sms-aws-sns:${project.'cas.version'}"

dependencyManagement {
    imports {
        mavenBom "org.apereo.cas:cas-server-support-bom:${project.'cas.version'}"
    }
}

dependencies {
    implementation "org.apereo.cas:cas-server-support-sms-aws-sns"
}

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:

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

cas.sms-provider.sns.credential-access-key=

Use access-key provided by AWS to authenticate.

This setting supports the Spring Expression Language.

org.apereo.cas.configuration.model.support.sms.AmazonSnsProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

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.

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.sms-provider.sns.credential-access-key=...

This is the most common form of property configuration that is recognized by CAS, regardless of the actual property source, which might in fact be managed separately outside the CAS environment, by another system or cloud framework.

CAS properties can be specified using the YAML syntax:

cas: 
  sms-provider: 
    sns: 
      credential-access-key: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.sms-provider.sns.credential-access-key="..." -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as 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.

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_SMS_PROVIDER_SNS_CREDENTIAL_ACCESS_KEY="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.sms-provider.sns.credential-access-key="..."

The above example assumes that the CAS web application is packaged as 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.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.sms-provider.sns.credential-secret-key=...

CAS properties can be specified using the YAML syntax:

cas: 
  sms-provider: 
    sns: 
      credential-secret-key: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.sms-provider.sns.credential-secret-key="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_SMS_PROVIDER_SNS_CREDENTIAL_SECRET_KEY="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.sms-provider.sns.credential-secret-key="..."

The above example assumes that the CAS web application is packaged as 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.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.sms-provider.sns.endpoint=...

CAS properties can be specified using the YAML syntax:

cas: 
  sms-provider: 
    sns: 
      endpoint: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.sms-provider.sns.endpoint="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_SMS_PROVIDER_SNS_ENDPOINT="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.sms-provider.sns.endpoint="..."

The above example assumes that the CAS web application is packaged as 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.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.sms-provider.sns.region=...

CAS properties can be specified using the YAML syntax:

cas: 
  sms-provider: 
    sns: 
      region: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.sms-provider.sns.region="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_SMS_PROVIDER_SNS_REGION="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.sms-provider.sns.region="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

_{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. In other words, you should only include this field in your
configuration if you need to modify the default value or if you need to turn on the feature controlled by the setting.}

cas.sms-provider.sns.client-execution-timeout=10000

Client execution timeout.

This settings supports the java.time.Duration syntax ^[?].

org.apereo.cas.configuration.model.support.sms.AmazonSnsProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.sms-provider.sns.client-execution-timeout=10000

CAS properties can be specified using the YAML syntax:

cas: 
  sms-provider: 
    sns: 
      client-execution-timeout: "10000"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.sms-provider.sns.client-execution-timeout="10000" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_SMS_PROVIDER_SNS_CLIENT_EXECUTION_TIMEOUT="10000"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.sms-provider.sns.client-execution-timeout="10000"

The above example assumes that the CAS web application is packaged as 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.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.sms-provider.sns.connection-timeout=5000

CAS properties can be specified using the YAML syntax:

cas: 
  sms-provider: 
    sns: 
      connection-timeout: "5000"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.sms-provider.sns.connection-timeout="5000" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_SMS_PROVIDER_SNS_CONNECTION_TIMEOUT="5000"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.sms-provider.sns.connection-timeout="5000"

The above example assumes that the CAS web application is packaged as 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.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.sms-provider.sns.local-address=...

CAS properties can be specified using the YAML syntax:

cas: 
  sms-provider: 
    sns: 
      local-address: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.sms-provider.sns.local-address="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_SMS_PROVIDER_SNS_LOCAL_ADDRESS="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.sms-provider.sns.local-address="..."

The above example assumes that the CAS web application is packaged as 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.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.sms-provider.sns.max-connections=10

CAS properties can be specified using the YAML syntax:

cas: 
  sms-provider: 
    sns: 
      max-connections: "10"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.sms-provider.sns.max-connections="10" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_SMS_PROVIDER_SNS_MAX_CONNECTIONS="10"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.sms-provider.sns.max-connections="10"

The above example assumes that the CAS web application is packaged as 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.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.sms-provider.sns.max-price=...

CAS properties can be specified using the YAML syntax:

cas: 
  sms-provider: 
    sns: 
      max-price: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.sms-provider.sns.max-price="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_SMS_PROVIDER_SNS_MAX_PRICE="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.sms-provider.sns.max-price="..."

The above example assumes that the CAS web application is packaged as 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.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.sms-provider.sns.profile-name=...

CAS properties can be specified using the YAML syntax:

cas: 
  sms-provider: 
    sns: 
      profile-name: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.sms-provider.sns.profile-name="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_SMS_PROVIDER_SNS_PROFILE_NAME="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.sms-provider.sns.profile-name="..."

The above example assumes that the CAS web application is packaged as 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.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.sms-provider.sns.profile-path=...

CAS properties can be specified using the YAML syntax:

cas: 
  sms-provider: 
    sns: 
      profile-path: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.sms-provider.sns.profile-path="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_SMS_PROVIDER_SNS_PROFILE_PATH="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.sms-provider.sns.profile-path="..."

The above example assumes that the CAS web application is packaged as 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.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.sms-provider.sns.proxy-host=...

CAS properties can be specified using the YAML syntax:

cas: 
  sms-provider: 
    sns: 
      proxy-host: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.sms-provider.sns.proxy-host="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_SMS_PROVIDER_SNS_PROXY_HOST="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.sms-provider.sns.proxy-host="..."

The above example assumes that the CAS web application is packaged as 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.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.sms-provider.sns.proxy-password=...

CAS properties can be specified using the YAML syntax:

cas: 
  sms-provider: 
    sns: 
      proxy-password: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.sms-provider.sns.proxy-password="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_SMS_PROVIDER_SNS_PROXY_PASSWORD="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.sms-provider.sns.proxy-password="..."

The above example assumes that the CAS web application is packaged as 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.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.sms-provider.sns.proxy-username=...

CAS properties can be specified using the YAML syntax:

cas: 
  sms-provider: 
    sns: 
      proxy-username: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.sms-provider.sns.proxy-username="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_SMS_PROVIDER_SNS_PROXY_USERNAME="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.sms-provider.sns.proxy-username="..."

The above example assumes that the CAS web application is packaged as 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.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.sms-provider.sns.retry-mode=STANDARD

CAS properties can be specified using the YAML syntax:

cas: 
  sms-provider: 
    sns: 
      retry-mode: "STANDARD"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.sms-provider.sns.retry-mode="STANDARD" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_SMS_PROVIDER_SNS_RETRY_MODE="STANDARD"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.sms-provider.sns.retry-mode="STANDARD"

The above example assumes that the CAS web application is packaged as 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.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.sms-provider.sns.sender-id=...

CAS properties can be specified using the YAML syntax:

cas: 
  sms-provider: 
    sns: 
      sender-id: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.sms-provider.sns.sender-id="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_SMS_PROVIDER_SNS_SENDER_ID="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.sms-provider.sns.sender-id="..."

The above example assumes that the CAS web application is packaged as 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.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.sms-provider.sns.sms-type=Transactional

CAS properties can be specified using the YAML syntax:

cas: 
  sms-provider: 
    sns: 
      sms-type: "Transactional"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.sms-provider.sns.sms-type="Transactional" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_SMS_PROVIDER_SNS_SMS_TYPE="Transactional"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.sms-provider.sns.sms-type="Transactional"

The above example assumes that the CAS web application is packaged as 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.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.sms-provider.sns.socket-timeout=5000

CAS properties can be specified using the YAML syntax:

cas: 
  sms-provider: 
    sns: 
      socket-timeout: "5000"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.sms-provider.sns.socket-timeout="5000" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_SMS_PROVIDER_SNS_SOCKET_TIMEOUT="5000"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.sms-provider.sns.socket-timeout="5000"

The above example assumes that the CAS web application is packaged as 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.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.sms-provider.sns.use-reaper=...

CAS properties can be specified using the YAML syntax:

cas: 
  sms-provider: 
    sns: 
      use-reaper: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.sms-provider.sns.use-reaper="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_SMS_PROVIDER_SNS_USE_REAPER="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.sms-provider.sns.use-reaper="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

# Client execution timeout.
# cas.sms-provider.sns.client-execution-timeout=10000

# Connection timeout.
# cas.sms-provider.sns.connection-timeout=5000

# Local address.
# cas.sms-provider.sns.local-address=

# Maximum connections setting.
# cas.sms-provider.sns.max-connections=10

# The maximum amount in USD that you are willing to spend to send the SMS message.
# cas.sms-provider.sns.max-price=

# Profile name to use.
# cas.sms-provider.sns.profile-name=

# Profile path.
# cas.sms-provider.sns.profile-path=

# Optionally specifies the proxy host to connect through.
# cas.sms-provider.sns.proxy-host=

# Optionally specifies the proxy password to connect through.
# cas.sms-provider.sns.proxy-password=

# Optionally specifies the proxy username to connect through.
# cas.sms-provider.sns.proxy-username=

# Outline the requested retry mode.
# cas.sms-provider.sns.retry-mode=STANDARD

# A custom ID that contains up to 11 alphanumeric characters, including at least one letter and no spaces.
# cas.sms-provider.sns.sender-id=

# The type of message that you are sending.
# cas.sms-provider.sns.sms-type=Transactional

# Socket timeout.
# cas.sms-provider.sns.socket-timeout=5000

# Flag that indicates whether to use reaper.
# cas.sms-provider.sns.use-reaper=false

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.

Note

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.

WORKERS AHEAD!

Amazon SNS SMS Messaging

Configuration Metadata

Be Selective

YAGNI

Naming Convention

Validation

Indexed Settings