Interface MatsOutgoingMessage

All Known Subinterfaces:
MatsOutgoingMessage.MatsEditableOutgoingMessage, MatsOutgoingMessage.MatsSentOutgoingMessage
All Known Implementing Classes:
JmsMatsMessage

public interface MatsOutgoingMessage
Represents an Outgoing Mats Message.
  • Method Details

    • getTraceId

      String getTraceId()
    • getFlowId

      String getFlowId()
    • isNonPersistent

      boolean isNonPersistent()
    • getTimeToLive

      long getTimeToLive()
    • isInteractive

      boolean isInteractive()
    • isNoAudit

      boolean isNoAudit()
    • getInitiatingAppName

      String getInitiatingAppName()
    • getInitiatingAppVersion

      String getInitiatingAppVersion()
    • getInitiatorId

      String getInitiatorId()
      Note: For messages out of an initiator, this method and getFrom() returns the same value, i.e. it is "initiated from", and "from", the same source.
      Returns:
      the value supplied to MatsInitiator.MatsInitiate.from(String) at the time of the Mats flow initiation.
    • getMatsMessageId

      String getMatsMessageId()
    • getMessageType

    • getDispatchType

    • getFrom

      String getFrom()
      Note: For messages out of an initiator, this method and getInitiatorId() returns the same value, i.e. it is "initiated from", and "from", the same source.
      Returns:
      which stage the message is from, or for initiations, the same value as getInitiatorId().
    • getTo

      String getTo()
    • isToSubscription

      boolean isToSubscription()
    • getReplyTo

      Optional<String> getReplyTo()
    • isReplyToSubscription

      Optional<Boolean> isReplyToSubscription()
    • getSameStackHeightState

      Optional<Object> getSameStackHeightState()
      Returns:
      the "same stackheight" outgoing state; If this is a Request, it is the state that will be present upon the subsequent Reply. If this is a Next, it is the state present on the nest stage. If it is a Goto, it will be the "intialState" if set - and thus same as getInitialTargetState().
    • getData

      Object getData()
      Returns:
      the outgoing data (DTO)
    • getTracePropertyKeys

      Set<String> getTracePropertyKeys()
    • getTraceProperty

      <T> T getTraceProperty(String propertyName, Class<T> type)
    • getBytesKeys

      Set<String> getBytesKeys()
    • getBytes

      byte[] getBytes(String key)
    • getStringKeys

      Set<String> getStringKeys()
    • getString

      String getString(String key)
    • getInitialTargetState

      Optional<Object> getInitialTargetState()
      Returns:
      for initiations and Goto, it is possible to send along an initial incoming target state - this returns that.