io.mats3.api.intercept

Interface MatsOutgoingMessage

All Known Subinterfaces:

MatsOutgoingMessage.MatsEditableOutgoingMessage, MatsOutgoingMessage.MatsSentOutgoingMessage

All Known Implementing Classes:

JmsMatsMessage

public interface MatsOutgoingMessage

Represents an Outgoing Mats Message.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	MatsOutgoingMessage.DispatchType
static interface	MatsOutgoingMessage.MatsEditableOutgoingMessage
static interface	MatsOutgoingMessage.MatsSentOutgoingMessage
static class	MatsOutgoingMessage.MessageType

Method Summary

Modifier and Type	Method and Description
byte[]	getBytes(java.lang.String key)
java.util.Set<java.lang.String>	getBytesKeys()
java.lang.Object	getData()
MatsOutgoingMessage.DispatchType	getDispatchType()
java.lang.String	getFlowId()
java.lang.String	getFrom() Note: For messages out of an initiator, this method and getInitiatorId() returns the same value, i.e.
java.util.Optional<java.lang.Object>	getInitialTargetState()
java.lang.String	getInitiatingAppName()
java.lang.String	getInitiatingAppVersion()
java.lang.String	getInitiatorId() Note: For messages out of an initiator, this method and getFrom() returns the same value, i.e.
java.lang.String	getMatsMessageId()
MatsOutgoingMessage.MessageType	getMessageType()
java.util.Optional<java.lang.String>	getReplyTo()
java.util.Optional<java.lang.Object>	getSameStackHeightState()
java.lang.String	getString(java.lang.String key)
java.util.Set<java.lang.String>	getStringKeys()
long	getTimeToLive()
java.lang.String	getTo()
java.lang.String	getTraceId()
<T> T	getTraceProperty(java.lang.String propertyName, java.lang.Class<T> type)
java.util.Set<java.lang.String>	getTracePropertyKeys()
boolean	isInteractive()
boolean	isNoAudit()
boolean	isNonPersistent()
java.util.Optional<java.lang.Boolean>	isReplyToSubscription()
boolean	isToSubscription()

Method Detail

getTraceId

java.lang.String getTraceId()

getFlowId

java.lang.String getFlowId()

isNonPersistent

boolean isNonPersistent()

getTimeToLive

long getTimeToLive()

isInteractive

boolean isInteractive()

isNoAudit

boolean isNoAudit()

getInitiatingAppName

java.lang.String getInitiatingAppName()

getInitiatingAppVersion

java.lang.String getInitiatingAppVersion()

getInitiatorId

java.lang.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

java.lang.String getMatsMessageId()

getMessageType

MatsOutgoingMessage.MessageType getMessageType()

getDispatchType

MatsOutgoingMessage.DispatchType getDispatchType()

getFrom

java.lang.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

java.lang.String getTo()

isToSubscription

boolean isToSubscription()

getReplyTo

java.util.Optional<java.lang.String> getReplyTo()

isReplyToSubscription

java.util.Optional<java.lang.Boolean> isReplyToSubscription()

getSameStackHeightState

java.util.Optional<java.lang.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

java.lang.Object getData()

Returns:

the outgoing data (DTO)

getTracePropertyKeys

java.util.Set<java.lang.String> getTracePropertyKeys()

getTraceProperty

<T> T getTraceProperty(java.lang.String propertyName,
                       java.lang.Class<T> type)

getBytesKeys

java.util.Set<java.lang.String> getBytesKeys()

getBytes

byte[] getBytes(java.lang.String key)

getStringKeys

java.util.Set<java.lang.String> getStringKeys()

getString

java.lang.String getString(java.lang.String key)

getInitialTargetState

java.util.Optional<java.lang.Object> getInitialTargetState()

Returns:

for initiations and Goto, it is possible to send along an initial incoming target state - this returns that.