org.adroitlogic.x.core

Class MessageContext

java.lang.Object

org.adroitlogic.x.core.MessageContext

All Implemented Interfaces:

XMessageContext

public class MessageContext
extends Object
implements XMessageContext

Implementation of XMessageContext API

Since:

17.01

Author:

Udith Gunaratna, Ruwan Linton

Constructor Summary

Constructors

Constructor and Description
MessageContext(XMessage message)

Method Summary

Modifier and Type	Method and Description
<P> void	addContextProperty(String key, P value) Add a message property - i.e.
void	addThrowable(Throwable t) Add a Throwable to the throwable stack of the message context
void	attachForRelease(AutoCloseable closeable) Attach an instance of AutoCloseable to be closed at the message context release stage
XMessageContext	cloneMessageContextWithFullMessage(ExchangePattern exchangePattern, CompletionType completionType) Creates a copyOf of this message context with the enclosed XMessage instance and its payload.
XMessageContext	cloneMessageContextWithoutMessage(ExchangePattern exchangePattern, CompletionType completionType) Creates a copyOf of this message context without the enclosed XMessage instance.
XMessageContext	cloneMessageContextWithoutPayload(ExchangePattern exchangePattern, CompletionType completionType) Creates a copyOf of this message context with the enclosed XMessage instance.
void	completeMessageFlowSuccessfully() This method should be invoked to indicate that the message flow related to this message context is completed successfully
void	completeMessageFlowWithException(Throwable throwable) This method should be invoked to indicate that the message flow related to this message context is completed with a failure
Optional<Throwable>	getAndRemoveLastThrowable() Retrieves the last Throwable associated with this message context and removes it from the stack of occurred throwables.
CompletableFuture<XMessageContext>	getAsyncResponseCompletionFuture() Returns the asynchronous response future object
UUID	getContextId()
Map<String,Object>	getContextProperties() Return current message properties as an unmodifiable map
<P> Optional<P>	getContextProperty(String key, Class<P> cls) Get the message property associated with the specified key as a typed object of type P
Optional<XScopeContext>	getCurrentScopeContext()
CompletableFuture<XMessage>	getEgressFuture()
ExchangePattern	getExchangePattern()
XFlowEventNotificationContext	getFlowEventNotificationContext() Retrieves the XFlowEventNotificationContext associated with this context
Optional<XIntegrationFlowTracer>	getIntegrationFlowTracer()
Optional<Throwable>	getLastThrowable() Retrieves the last Throwable associated with this message context.
XMessage	getMessage()
XMessageView	getMessageView(int maxPayloadSizeKbs)
XPlatform	getPlatform()
String	getReceivedConnectorId() Retrieves the ID of the XIngressConnectorElement through which this message context is received
CompletableFuture<XMessageContext>	getResponseFuture()
List<XScopeContext>	getScopeContextList()
<T> Optional<T>	getScopeVariable(String varKey, Class<T> type, boolean propagateToParent) Retrieves the scope variable with the given key
Optional<String>	getStringContextProperty(String key) Get the String message property associated with the specified key
TransactionContext	getTransactionContext()
boolean	hasContextProperty(String key) Checks whether the given property is present in the message properties map
boolean	isFailoverEnabled()
boolean	isMessageContextCompleted() Whether this message context has been completed processing
boolean	isMessageFlowCompleted() Whether the message flow (to which this message context belongs) has been completed
boolean	isResponseSubmitted()
boolean	isTimedOut() Checks whether this message context is flagged as timed-out
void	onCompletionOfAllSubBranches(BiConsumer<XMessageContext,Throwable> function)
void	onCompletionOfThisBranch(BiConsumer<XMessageContext,Throwable> function)
void	releaseResources() Releases resources used by the message context at the end of it's life
void	removeContextProperty(String key) Remove the message property associated with the specified key
void	removeCurrentScopeContext()
void	removeScopeVariable(String varKey, boolean removeFromAllScopes) Removes the scope variable with the given key
XMessage	resetEnclosedMessage() Resets the enclosed Message to a new instance of Message
void	sendResponse(int code, boolean completeFlow)
void	sendResponse(int code, XMessage responseMessage, boolean completeFlow)
void	setAsTimedOut() Flags this message context as timed-out.
void	setAsyncResponseCompletionFuture(CompletableFuture<XMessageContext> asyncResponseCompletionFuture) Sets a CompletableFuture for message context as the asynchronous response future.
void	setCurrentScopeContext(XScopeContext scopeContext)
void	setEgressFuture(CompletableFuture<XMessage> egressFuture)
void	setExchangePattern(ExchangePattern exchangePattern)
void	setFailoverEnabled(boolean failoverEnabled)
void	setFlowCompletionFuture(CompletableFuture<XMessageContext> flowCompletionFuture)
void	setFlowEventNotificationContext(XFlowEventNotificationContext flowEventNotificationContext) Sets the given XFlowEventNotificationContext to this context
void	setMessage(XMessage message)
void	setPlatform(XPlatform platform)
void	setReceivedConnectorId(String receivedConnectorId) Sets the ID of the XIngressConnectorElement through which this message context is received
void	setResponseFuture(CompletableFuture<XMessageContext> responseFuture)
<T> void	setScopeVariable(String varKey, T varValue) Adds a new variable to the current scope with the given key and value
void	setTransactionContext(TransactionContext transactionContext)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MessageContext

public MessageContext(XMessage message)

Method Detail

getContextId

public UUID getContextId()

Specified by:

getContextId in interface XMessageContext

getMessage

public XMessage getMessage()

Specified by:

getMessage in interface XMessageContext

getExchangePattern

public ExchangePattern getExchangePattern()

Specified by:

getExchangePattern in interface XMessageContext

setMessage

public void setMessage(XMessage message)

Specified by:

setMessage in interface XMessageContext

setExchangePattern

public void setExchangePattern(ExchangePattern exchangePattern)

Specified by:

setExchangePattern in interface XMessageContext

sendResponse

public void sendResponse(int code,
                         XMessage responseMessage,
                         boolean completeFlow)

Specified by:

sendResponse in interface XMessageContext

sendResponse

public void sendResponse(int code,
                         boolean completeFlow)

Specified by:

sendResponse in interface XMessageContext

setEgressFuture

public void setEgressFuture(CompletableFuture<XMessage> egressFuture)

Specified by:

setEgressFuture in interface XMessageContext

getEgressFuture

public CompletableFuture<XMessage> getEgressFuture()

Specified by:

getEgressFuture in interface XMessageContext

getPlatform

public XPlatform getPlatform()

Specified by:

getPlatform in interface XMessageContext

getIntegrationFlowTracer

public Optional<XIntegrationFlowTracer> getIntegrationFlowTracer()

Specified by:

getIntegrationFlowTracer in interface XMessageContext

getMessageView

public XMessageView getMessageView(int maxPayloadSizeKbs)

Specified by:

getMessageView in interface XMessageContext

setCurrentScopeContext

public void setCurrentScopeContext(XScopeContext scopeContext)

Specified by:

setCurrentScopeContext in interface XMessageContext

getCurrentScopeContext

public Optional<XScopeContext> getCurrentScopeContext()

Specified by:

getCurrentScopeContext in interface XMessageContext

getScopeContextList

public List<XScopeContext> getScopeContextList()

Specified by:

getScopeContextList in interface XMessageContext

removeCurrentScopeContext

public void removeCurrentScopeContext()

Specified by:

removeCurrentScopeContext in interface XMessageContext

getTransactionContext

public TransactionContext getTransactionContext()

Specified by:

getTransactionContext in interface XMessageContext

setTransactionContext

public void setTransactionContext(TransactionContext transactionContext)

Specified by:

setTransactionContext in interface XMessageContext

getResponseFuture

public CompletableFuture<XMessageContext> getResponseFuture()

setResponseFuture

public void setResponseFuture(CompletableFuture<XMessageContext> responseFuture)

Specified by:

setResponseFuture in interface XMessageContext

setFlowCompletionFuture

public void setFlowCompletionFuture(CompletableFuture<XMessageContext> flowCompletionFuture)

isResponseSubmitted

public boolean isResponseSubmitted()

Specified by:

isResponseSubmitted in interface XMessageContext

onCompletionOfThisBranch

public void onCompletionOfThisBranch(BiConsumer<XMessageContext,Throwable> function)

Specified by:

onCompletionOfThisBranch in interface XMessageContext

onCompletionOfAllSubBranches

public void onCompletionOfAllSubBranches(BiConsumer<XMessageContext,Throwable> function)

Specified by:

onCompletionOfAllSubBranches in interface XMessageContext

isFailoverEnabled

public boolean isFailoverEnabled()

Specified by:

isFailoverEnabled in interface XMessageContext

setFailoverEnabled

public void setFailoverEnabled(boolean failoverEnabled)

Specified by:

setFailoverEnabled in interface XMessageContext

setPlatform

public void setPlatform(XPlatform platform)

Specified by:

setPlatform in interface XMessageContext

cloneMessageContextWithFullMessage

public XMessageContext cloneMessageContextWithFullMessage(ExchangePattern exchangePattern,
                                                          CompletionType completionType)

Description copied from interface: XMessageContext

Creates a copyOf of this message context with the enclosed XMessage instance and its payload.

Specified by:

cloneMessageContextWithFullMessage in interface XMessageContext

Parameters:

exchangePattern - ExchangePattern to be set for the new message context. If this is null, the exchange pattern of the original context will be inherited

completionType - CompletionType to be used for this cloning

Returns:

copyOf of this message context

cloneMessageContextWithoutPayload

public XMessageContext cloneMessageContextWithoutPayload(ExchangePattern exchangePattern,
                                                         CompletionType completionType)

Description copied from interface: XMessageContext

Creates a copyOf of this message context with the enclosed XMessage instance. But the payload of that XMessage will not be cloned.

Specified by:

cloneMessageContextWithoutPayload in interface XMessageContext

Parameters:

exchangePattern - ExchangePattern to be set for the new message context. If this is null, the exchange pattern of the original context will be inherited

completionType - CompletionType to be used for this cloning

Returns:

copyOf of this message context

cloneMessageContextWithoutMessage

public XMessageContext cloneMessageContextWithoutMessage(ExchangePattern exchangePattern,
                                                         CompletionType completionType)

Description copied from interface: XMessageContext

Creates a copyOf of this message context without the enclosed XMessage instance. A call to this method may follow invoking of XMessageContext.resetEnclosedMessage() method to assign a new instance of XMessage as the context's message

Specified by:

cloneMessageContextWithoutMessage in interface XMessageContext

Parameters:

exchangePattern - ExchangePattern to be set for the new message context. If this is null, the exchange pattern of the original context will be inherited

completionType - CompletionType to be used for this cloning

Returns:

copyOf of this message context

See Also:

XMessageContext.resetEnclosedMessage()

setAsyncResponseCompletionFuture

public void setAsyncResponseCompletionFuture(CompletableFuture<XMessageContext> asyncResponseCompletionFuture)

Description copied from interface: XMessageContext

Sets a CompletableFuture for message context as the asynchronous response future. An asyncResponseCompletionFuture can be used to mark the completion of a response when the response future (which is set using XMessageContext.setResponseFuture(CompletableFuture)) is completed at the start point of the asynchronous response process.

Specified by:

setAsyncResponseCompletionFuture in interface XMessageContext

Parameters:

asyncResponseCompletionFuture - asynchronous response future

getAsyncResponseCompletionFuture

public CompletableFuture<XMessageContext> getAsyncResponseCompletionFuture()

Description copied from interface: XMessageContext

Returns the asynchronous response future object

Specified by:

getAsyncResponseCompletionFuture in interface XMessageContext

Returns:

Asynchronous response future of the context if already set, null else.

releaseResources

public void releaseResources()

Description copied from interface: XMessageContext

Releases resources used by the message context at the end of it's life

Specified by:

releaseResources in interface XMessageContext

setScopeVariable

public <T> void setScopeVariable(String varKey,
                                 T varValue)

Description copied from interface: XMessageContext

Adds a new variable to the current scope with the given key and value

Specified by:

setScopeVariable in interface XMessageContext

Type Parameters:

T - type of the variable value

Parameters:

varKey - String key of the variable

varValue - value of the variable

getScopeVariable

public <T> Optional<T> getScopeVariable(String varKey,
                                        Class<T> type,
                                        boolean propagateToParent)

Description copied from interface: XMessageContext

Retrieves the scope variable with the given key

Specified by:

getScopeVariable in interface XMessageContext

Type Parameters:

T - type of the variable

Parameters:

varKey - key of the variable

type - expected type of the variable

propagateToParent - whether to propagate the search for the parent scopes, if a variable with the given key is not found in the current scope

Returns:

Optional of type T containing the variable if a variable with the given key is found and value for that key is not null, Optional.EMPTY otherwise

removeScopeVariable

public void removeScopeVariable(String varKey,
                                boolean removeFromAllScopes)

Description copied from interface: XMessageContext

Removes the scope variable with the given key

Specified by:

removeScopeVariable in interface XMessageContext

Parameters:

varKey - key of the variable

removeFromAllScopes - whether to remove the variables with the given key from all scopes

completeMessageFlowSuccessfully

public void completeMessageFlowSuccessfully()

Description copied from interface: XMessageContext

This method should be invoked to indicate that the message flow related to this message context is completed successfully

Specified by:

completeMessageFlowSuccessfully in interface XMessageContext

completeMessageFlowWithException

public void completeMessageFlowWithException(Throwable throwable)

Description copied from interface: XMessageContext

This method should be invoked to indicate that the message flow related to this message context is completed with a failure

Specified by:

completeMessageFlowWithException in interface XMessageContext

Parameters:

throwable - Throwable related to the failure of this message flow

getFlowEventNotificationContext

public XFlowEventNotificationContext getFlowEventNotificationContext()

Description copied from interface: XMessageContext

Retrieves the XFlowEventNotificationContext associated with this context

Specified by:

getFlowEventNotificationContext in interface XMessageContext

Returns:

instance of XFlowEventNotificationContext

setFlowEventNotificationContext

public void setFlowEventNotificationContext(XFlowEventNotificationContext flowEventNotificationContext)

Description copied from interface: XMessageContext

Sets the given XFlowEventNotificationContext to this context

Specified by:

setFlowEventNotificationContext in interface XMessageContext

Parameters:

flowEventNotificationContext - XFlowEventNotificationContext instance to be set

isTimedOut

public boolean isTimedOut()

Description copied from interface: XMessageContext

Checks whether this message context is flagged as timed-out

Specified by:

isTimedOut in interface XMessageContext

Returns:

true if timed-out, false otherwise

setAsTimedOut

public void setAsTimedOut()

Description copied from interface: XMessageContext

Flags this message context as timed-out. When a message context is flagged as timed-out, the processing of that message context is aborted at the end of current processing element.

Specified by:

setAsTimedOut in interface XMessageContext

addContextProperty

public <P> void addContextProperty(String key,
                                   P value)

Description copied from interface: XMessageContext

Add a message property - i.e. any Object can be a property

Specified by:

addContextProperty in interface XMessageContext

Type Parameters:

P - the type of the property value to be added

Parameters:

key - property key

value - property value

getContextProperty

public <P> Optional<P> getContextProperty(String key,
                                          Class<P> cls)

Description copied from interface: XMessageContext

Get the message property associated with the specified key as a typed object of type P

Specified by:

getContextProperty in interface XMessageContext

Type Parameters:

P - the type of the property

Parameters:

key - the property key

cls - the class of the property type

Returns:

the optional with the typed property value

getStringContextProperty

public Optional<String> getStringContextProperty(String key)

Description copied from interface: XMessageContext

Get the String message property associated with the specified key

Specified by:

getStringContextProperty in interface XMessageContext

Parameters:

key - property key

Returns:

property value

removeContextProperty

public void removeContextProperty(String key)

Description copied from interface: XMessageContext

Remove the message property associated with the specified key

Specified by:

removeContextProperty in interface XMessageContext

Parameters:

key - property key

hasContextProperty

public boolean hasContextProperty(String key)

Description copied from interface: XMessageContext

Checks whether the given property is present in the message properties map

Specified by:

hasContextProperty in interface XMessageContext

Parameters:

key - the key to be checked for existence

Returns:

whether the message properties contains a property with the given key

getContextProperties

public Map<String,Object> getContextProperties()

Description copied from interface: XMessageContext

Return current message properties as an unmodifiable map

Specified by:

getContextProperties in interface XMessageContext

Returns:

the current message properties

setReceivedConnectorId

public void setReceivedConnectorId(String receivedConnectorId)

Description copied from interface: XMessageContext

Sets the ID of the XIngressConnectorElement through which this message context is received

Specified by:

setReceivedConnectorId in interface XMessageContext

Parameters:

receivedConnectorId - ID of the received ingress connector

getReceivedConnectorId

public String getReceivedConnectorId()

Description copied from interface: XMessageContext

Retrieves the ID of the XIngressConnectorElement through which this message context is received

Specified by:

getReceivedConnectorId in interface XMessageContext

Returns:

ID of the received ingress connector

addThrowable

public void addThrowable(Throwable t)

Description copied from interface: XMessageContext

Add a Throwable to the throwable stack of the message context

Specified by:

addThrowable in interface XMessageContext

Parameters:

t - instance of Throwable

getLastThrowable

public Optional<Throwable> getLastThrowable()

Description copied from interface: XMessageContext

Retrieves the last Throwable associated with this message context.

But it should be noted that this method will not remove the throwable from the stack of occurred throwables. To remove the throwable after the retrieval, XMessageContext.getAndRemoveLastThrowable() method should be used.

Specified by:

getLastThrowable in interface XMessageContext

Returns:

Optional containing the last occurred Throwable if exists, or Optional.EMPTY otherwise

getAndRemoveLastThrowable

public Optional<Throwable> getAndRemoveLastThrowable()

Description copied from interface: XMessageContext

Retrieves the last Throwable associated with this message context and removes it from the stack of occurred throwables.

To keep the last throwable on the stack of occurred throwables even after the retrieval, XMessageContext.getLastThrowable() method should be used.

Specified by:

getAndRemoveLastThrowable in interface XMessageContext

Returns:

Optional containing the last occurred Throwable if exists, or Optional.EMPTY otherwise

attachForRelease

public void attachForRelease(AutoCloseable closeable)

Description copied from interface: XMessageContext

Attach an instance of AutoCloseable to be closed at the message context release stage

Specified by:

attachForRelease in interface XMessageContext

Parameters:

closeable - instance of AutoCloseable to be closed

isMessageContextCompleted

public boolean isMessageContextCompleted()

Description copied from interface: XMessageContext

Whether this message context has been completed processing

Specified by:

isMessageContextCompleted in interface XMessageContext

Returns:

true if completed, false otherwise

isMessageFlowCompleted

public boolean isMessageFlowCompleted()

Description copied from interface: XMessageContext

Whether the message flow (to which this message context belongs) has been completed

Specified by:

isMessageFlowCompleted in interface XMessageContext

Returns:

true if completed, false otherwise

resetEnclosedMessage

public XMessage resetEnclosedMessage()

Description copied from interface: XMessageContext

Resets the enclosed Message to a new instance of Message

Specified by:

resetEnclosedMessage in interface XMessageContext

Returns:

the newly set message