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

Class AmazonSnsProperties

java.lang.Object

org.apereo.cas.configuration.model.support.aws.BaseAmazonWebServicesProperties

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

All Implemented Interfaces:

Serializable, CasFeatureModule

@RequiresModule(name="cas-server-support-sms-aws-sns")
public class AmazonSnsProperties
extends BaseAmazonWebServicesProperties

This is AmazonSnsProperties.

Since:

5.3.0

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.apereo.cas.configuration.features.CasFeatureModule

CasFeatureModule.FeatureCatalog

Constructor Summary

Constructors

Constructor	Description
AmazonSnsProperties()

Method Summary

Modifier and Type	Method	Description
String	getMaxPrice()	The maximum amount in USD that you are willing to spend to send the SMS message.
String	getSenderId()	A custom ID that contains up to 11 alphanumeric characters, including at least one letter and no spaces.
String	getSmsType()	The type of message that you are sending.
AmazonSnsProperties	setMaxPrice(String maxPrice)	The maximum amount in USD that you are willing to spend to send the SMS message.
AmazonSnsProperties	setSenderId(String senderId)	A custom ID that contains up to 11 alphanumeric characters, including at least one letter and no spaces.
AmazonSnsProperties	setSmsType(String smsType)	The type of message that you are sending.

Methods inherited from class org.apereo.cas.configuration.model.support.aws.BaseAmazonWebServicesProperties

getClientExecutionTimeout, getConnectionTimeout, getCredentialAccessKey, getCredentialSecretKey, getEndpoint, getLocalAddress, getMaxConnections, getProfileName, getProfilePath, getProxyHost, getProxyPassword, getProxyUsername, getRegion, getRetryMode, getSocketTimeout, isUseReaper, setClientExecutionTimeout, setConnectionTimeout, setCredentialAccessKey, setCredentialSecretKey, setEndpoint, setLocalAddress, setMaxConnections, setProfileName, setProfilePath, setProxyHost, setProxyPassword, setProxyUsername, setRegion, setRetryMode, setSocketTimeout, setUseReaper

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apereo.cas.configuration.features.CasFeatureModule

isDefined, isUndefined

Constructor Details

AmazonSnsProperties

public AmazonSnsProperties()

Method Details

getSenderId

public String getSenderId()

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.

getMaxPrice

public String getMaxPrice()

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.

getSmsType

public String getSmsType()

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.

setSenderId

public AmazonSnsProperties setSenderId(String senderId)

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.

Returns:

this.

setMaxPrice

public AmazonSnsProperties setMaxPrice(String maxPrice)

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.

Returns:

this.

setSmsType

public AmazonSnsProperties setSmsType(String smsType)

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.

Returns:

this.