Interface NotificationSender

  • All Superinterfaces:
    org.springframework.core.Ordered
    All Known Implementing Classes:
    DefaultNotificationSender
    Functional Interface:
    This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

    @FunctionalInterface
    public interface NotificationSender
    extends org.springframework.core.Ordered
    Since:
    6.3.0
    • Field Summary

      • Fields inherited from interface org.springframework.core.Ordered

        HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE
    • Method Detail

      • getOrder

        default int getOrder()
        Specified by:
        getOrder in interface org.springframework.core.Ordered
      • canSend

        default boolean canSend()
        Whether it can send a notification.
        Returns:
        whether it can send an notification
      • notify

        boolean notify​(org.apereo.cas.authentication.principal.Principal principal,
                       java.util.Map<java.lang.String,​java.lang.String> messageData)
        Notify.
        Parameters:
        principal - the principal
        messageData - the message data
        Returns:
        true/false
      • noOp

        static NotificationSender noOp()
        No op notification sender.
        Returns:
        the notification sender