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

Class SmsProperties

java.lang.Object

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

All Implemented Interfaces:

Serializable, CasFeatureModule

@RequiresModule(name="cas-server-core-util",
                automated=true)
public class SmsProperties
extends Object
implements CasFeatureModule, Serializable

This is SmsProperties.

Since:

5.1.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
SmsProperties()

Method Summary

Modifier and Type	Method	Description
String	getAttributeName()	Principal attribute name that indicates the destination phone number for this SMS message.
String	getFrom()	The from address for the message.
String	getText()	The body of the SMS message.
SmsProperties	setAttributeName(String attributeName)	Principal attribute name that indicates the destination phone number for this SMS message.
SmsProperties	setFrom(String from)	The from address for the message.
SmsProperties	setText(String text)	The body of the SMS message.

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

SmsProperties

public SmsProperties()

Method Details

getText

public String getText()

The body of the SMS message.

getFrom

public String getFrom()

The from address for the message.

getAttributeName

public String getAttributeName()

Principal attribute name that indicates the destination phone number for this SMS message. The attribute must already be resolved and available to the CAS principal.

setText

public SmsProperties setText(String text)

The body of the SMS message.

Returns:

this.

setFrom

public SmsProperties setFrom(String from)

The from address for the message.

Returns:

this.

setAttributeName

public SmsProperties setAttributeName(String attributeName)

Principal attribute name that indicates the destination phone number for this SMS message. The attribute must already be resolved and available to the CAS principal.

Returns:

this.