Package com.flowable.engage.message.api.temporary

Interface TemporaryMessageProcessor

public interface TemporaryMessageProcessor
A processor of a TemporaryMessage which is invoked during the async handling of the messages.
Author:
Filip Hrisafov

  • Field Summary

    Fields 
    Modifier and Type Field Description
    static java.lang.String STATUS_PASSED
    Status indicating that the processing has passed.

  • Method Summary

    Modifier and Type Method Description
    TemporaryMessageProcessResult process​(TemporaryMessage temporaryMessage)
    Process the temporary message.

  • Field Details

  • Method Details

    • process

      TemporaryMessageProcessResult process​(TemporaryMessage temporaryMessage)
      Process the temporary message. The processor should return a processing result that indicates whether the processing has been validated and the reason of the validation.

      There can be multiple registered processor that process a TemporaryMessage. If one processor returns a status that is not valid then the processing stops and the result is handed to the TemporaryMessageHandler.

      Once all TemporaryMessageProcessor(s) have run then the last processing result would be returned to the TemporaryMessageHandler.

      Parameters:
      temporaryMessage - that temporary message that needs to be processed
      Returns:
      the process result of the processor