Package org.apereo.cas.notifications

Class DefaultCommunicationsManager

java.lang.Object

org.apereo.cas.notifications.DefaultCommunicationsManager

All Implemented Interfaces:

CommunicationsManager

public class DefaultCommunicationsManager
extends java.lang.Object
implements CommunicationsManager

This is DefaultCommunicationsManager.

Since:

5.1.0

Field Summary

Fields inherited from interface org.apereo.cas.notifications.CommunicationsManager

BEAN_NAME

Constructor Summary

Constructors

Constructor	Description
DefaultCommunicationsManager()

Method Summary

Modifier and Type	Method	Description
protected java.lang.String	determineEmailSubject(EmailMessageRequest emailRequest)
EmailCommunicationResult	email(EmailMessageRequest emailRequest)	Email.
boolean	isMailSenderDefined()	Is mail sender defined?
boolean	isNotificationSenderDefined()	Is notification sender defined?
boolean	isSmsSenderDefined()	Is sms sender defined?
boolean	notify(org.apereo.cas.authentication.principal.Principal principal, java.lang.String title, java.lang.String body)	Notify.
boolean	sms(SmsRequest smsRequest)	Sms.
boolean	validate()	Validate.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultCommunicationsManager

public DefaultCommunicationsManager()

Method Detail

isMailSenderDefined

public boolean isMailSenderDefined()

Description copied from interface: CommunicationsManager

Is mail sender defined?

Specified by:

isMailSenderDefined in interface CommunicationsManager

Returns:

the boolean

isSmsSenderDefined

public boolean isSmsSenderDefined()

Description copied from interface: CommunicationsManager

Is sms sender defined?

Specified by:

isSmsSenderDefined in interface CommunicationsManager

Returns:

the boolean

isNotificationSenderDefined

public boolean isNotificationSenderDefined()

Description copied from interface: CommunicationsManager

Is notification sender defined?

Specified by:

isNotificationSenderDefined in interface CommunicationsManager

Returns:

the boolean

notify

public boolean notify(org.apereo.cas.authentication.principal.Principal principal,
                      java.lang.String title,
                      java.lang.String body)

Description copied from interface: CommunicationsManager

Notify.

Specified by:

notify in interface CommunicationsManager

Parameters:

principal - the principal

title - the title

body - the body

Returns:

true/false

email

public EmailCommunicationResult email(EmailMessageRequest emailRequest)

Description copied from interface: CommunicationsManager

Email.

Specified by:

email in interface CommunicationsManager

Parameters:

emailRequest - the email request

Returns:

the result

determineEmailSubject

protected java.lang.String determineEmailSubject(EmailMessageRequest emailRequest)

sms

public boolean sms(SmsRequest smsRequest)

Description copied from interface: CommunicationsManager

Sms.

Specified by:

sms in interface CommunicationsManager

Parameters:

smsRequest - the request

Returns:

true /false

validate

public boolean validate()

Description copied from interface: CommunicationsManager

Validate.

Specified by:

validate in interface CommunicationsManager

Returns:

true, if email or sms providers, etc are defined for CAS.