Package org.apereo.cas.notifications
Interface CommunicationsManager
-
- All Known Implementing Classes:
DefaultCommunicationsManager
public interface CommunicationsManagerThis isCommunicationsManager.- Since:
- 5.1.0
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.StringBEAN_NAMEBean name.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description EmailCommunicationResultemail(EmailMessageRequest emailRequest)Email.booleanisMailSenderDefined()Is mail sender defined?booleanisNotificationSenderDefined()Is notification sender defined?booleanisSmsSenderDefined()Is sms sender defined?booleannotify(org.apereo.cas.authentication.principal.Principal principal, java.lang.String title, java.lang.String body)Notify.booleansms(SmsRequest request)Sms.booleanvalidate()Validate.
-
-
-
Field Detail
-
BEAN_NAME
static final java.lang.String BEAN_NAME
Bean name.- See Also:
- Constant Field Values
-
-
Method Detail
-
isMailSenderDefined
boolean isMailSenderDefined()
Is mail sender defined?- Returns:
- the boolean
-
isSmsSenderDefined
boolean isSmsSenderDefined()
Is sms sender defined?- Returns:
- the boolean
-
isNotificationSenderDefined
boolean isNotificationSenderDefined()
Is notification sender defined?- Returns:
- the boolean
-
notify
boolean notify(org.apereo.cas.authentication.principal.Principal principal, java.lang.String title, java.lang.String body)Notify.- Parameters:
principal- the principaltitle- the titlebody- the body- Returns:
- true/false
-
email
EmailCommunicationResult email(EmailMessageRequest emailRequest)
Email.- Parameters:
emailRequest- the email request- Returns:
- the result
-
sms
boolean sms(SmsRequest request)
Sms.- Parameters:
request- the request- Returns:
- true /false
-
validate
boolean validate()
Validate.- Returns:
- true, if email or sms providers, etc are defined for CAS.
-
-