Package com.flowable.platform.notification.api

Interface MessageDeliverer

All Known Implementing Classes:
ProcessMessageDeliverer, SimpMessageDeliverer
public interface MessageDeliverer
A message deliver that can be used to deliver a message via some channel. For example message deliverer that delivers messages over websockets, push notifications or even email.
Author:
Filip Hrisafov

  • Method Summary

    Modifier and Type Method Description
    java.lang.String getDelivererType()
    The type of the message deliverer.
    int getPriority()  
    void sendMessage​(DeliveryContext<?> deliveryContext)
    Perform sending of a message using the provided delivery context.

  • Method Details

    • sendMessage

      void sendMessage​(DeliveryContext<?> deliveryContext)
      Perform sending of a message using the provided delivery context. The message deliverer should decide on it's own whether a message should be sent. Usually message should always be send if a user is connected in real time. Notification (offline) senders should first check if no message has been delivered and only then perform a delivery (if they can).
      Parameters:
      deliveryContext - the delivery context that can be used to transfer data between multiple delivers

    • getDelivererType

      java.lang.String getDelivererType()
      The type of the message deliverer. Usually used to create a message based on the type
      Returns:
      type of the deliverer

    • getPriority

      int getPriority()