Package org.apereo.cas.notifications

Class CommunicationsManager

  • public class CommunicationsManager
extends java.lang.Object
    This is CommunicationsManager.
    Since:
    5.1.0

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean email​(org.apereo.cas.authentication.principal.Principal principal, java.lang.String attribute, org.apereo.cas.configuration.model.support.email.EmailProperties emailProperties, java.lang.String body)
      Email.
      boolean email​(org.apereo.cas.configuration.model.support.email.EmailProperties emailProperties, java.lang.String to, java.lang.String body)
      Email.
      boolean isMailSenderDefined()  
      boolean isNotificationSenderDefined()  
      boolean isSmsSenderDefined()  
      boolean notify​(org.apereo.cas.authentication.principal.Principal principal, java.lang.String title, java.lang.String body)
      Notify.
      boolean sms​(java.lang.String from, java.lang.String to, java.lang.String text)
      Sms.
      boolean sms​(org.apereo.cas.authentication.principal.Principal principal, java.lang.String attribute, java.lang.String text, java.lang.String from)
      Sms.
      boolean validate()
      Validate.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • CommunicationsManager

        public CommunicationsManager()

    • Method Detail

      • isMailSenderDefined

        public boolean isMailSenderDefined()

      • isSmsSenderDefined

        public boolean isSmsSenderDefined()

      • isNotificationSenderDefined

        public boolean isNotificationSenderDefined()

      • notify

        public boolean notify​(org.apereo.cas.authentication.principal.Principal principal,
                      java.lang.String title,
                      java.lang.String body)
        Notify.
        Parameters:
        principal - the principal
        title - the title
        body - the body
        Returns:
        true/false

      • email

        public boolean email​(org.apereo.cas.authentication.principal.Principal principal,
                     java.lang.String attribute,
                     org.apereo.cas.configuration.model.support.email.EmailProperties emailProperties,
                     java.lang.String body)
        Email.
        Parameters:
        principal - the principal
        attribute - the email attribute
        emailProperties - the email properties
        body - the body
        Returns:
        true /false

      • email

        public boolean email​(org.apereo.cas.configuration.model.support.email.EmailProperties emailProperties,
                     java.lang.String to,
                     java.lang.String body)
        Email.
        Parameters:
        emailProperties - the email properties
        to - the to
        body - the body
        Returns:
        true/false

      • sms

        public boolean sms​(org.apereo.cas.authentication.principal.Principal principal,
                   java.lang.String attribute,
                   java.lang.String text,
                   java.lang.String from)
        Sms.
        Parameters:
        principal - the principal
        attribute - the attribute
        text - the text
        from - the from
        Returns:
        true/false

      • sms

        public boolean sms​(java.lang.String from,
                   java.lang.String to,
                   java.lang.String text)
        Sms.
        Parameters:
        from - the from
        to - the to
        text - the text
        Returns:
        true/false

      • validate

        public boolean validate()
        Validate.
        Returns:
        true, if email or sms providers, etc are defined for CAS.