org.adroitlogic.x.core

Class InMemoryIntegrationFlowTracer

java.lang.Object

org.adroitlogic.x.core.InMemoryIntegrationFlowTracer

All Implemented Interfaces:

XIntegrationFlowTracer

public class InMemoryIntegrationFlowTracer
extends Object
implements XIntegrationFlowTracer

An in-memory integration flow tracer that is being used by the UltraStudio to show tracing information under the development environment

Since:

17.01

Author:

Udith Gunaratna

Constructor Summary

Constructors

Constructor and Description
InMemoryIntegrationFlowTracer()

Method Summary

Modifier and Type	Method and Description
void	clearAllMessageTraces() Clears the existing traces of all the XIntegrationFlow instances
void	clearMessageTrace(String projectId, String projectVersion, String flowId) Clears the existing trace of the XIntegrationFlow instance with the given id
void	disableMessageTracing() Disables tracing of messages
void	enableMessageTracing() Enables tracing of messages
int	getMaxPayloadSizeKbs() Retrieves the current set value for the maximum size of the payload to be traced.
Optional<XMessageView>	getMessageView(String projectId, String projectVersion, String flowId, String sourceId, String outPortName, String targetId) Retrieves the traced view of the message context that was transferred from the given outport (of given source element) to the given target element
Optional<XMessageView>	getReceivedMessage(String projectId, String projectVersion, String flowId, String elementID) Retrieves the traced view of the received message context of the given element
List<IntegrationFlowTraceNode>	getTracedFlow(String projectId, String projectVersion, String flowId) Retrieves the last trace of the Integration Flow with the given Id
boolean	isTracingEnabled() Checks whether the message tracing is enabled
void	setMaxPayloadSizeKbs(int maxPayloadSizeKbs) Sets the the maximum size of the payload to be traced.
void	setTracingEnabled(boolean tracingEnabled) Sets whether to enable tracing or not
void	traceMessage(String projectId, String projectVersion, String flowId, String sourceId, String outPortDisplayName, String targetId, XMessageContext messageContext) Traces a message context that was transferred from the given outport (of given source element) to the given target element
void	traceReceivedMessage(String projectId, String projectVersion, String flowId, String elementId, XMessageContext messageContext) Traces a received message context for the given element that belongs to the Integration Flow with the given ID

Methods inherited from class java.lang.Object

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

Constructor Detail

InMemoryIntegrationFlowTracer

public InMemoryIntegrationFlowTracer()

Method Detail

clearAllMessageTraces

public void clearAllMessageTraces()

Description copied from interface: XIntegrationFlowTracer

Clears the existing traces of all the XIntegrationFlow instances

Specified by:

clearAllMessageTraces in interface XIntegrationFlowTracer

clearMessageTrace

public void clearMessageTrace(String projectId,
                              String projectVersion,
                              String flowId)

Description copied from interface: XIntegrationFlowTracer

Clears the existing trace of the XIntegrationFlow instance with the given id

Specified by:

clearMessageTrace in interface XIntegrationFlowTracer

Parameters:

projectId - ID of the project to which the integration flow belongs to

projectVersion - version of the project to which the integration flow belongs to

flowId - ID of the XIntegrationFlow to be cleared

traceReceivedMessage

public void traceReceivedMessage(String projectId,
                                 String projectVersion,
                                 String flowId,
                                 String elementId,
                                 XMessageContext messageContext)

Description copied from interface: XIntegrationFlowTracer

Traces a received message context for the given element that belongs to the Integration Flow with the given ID

Specified by:

traceReceivedMessage in interface XIntegrationFlowTracer

Parameters:

projectId - ID of the project to which the integration flow belongs to

projectVersion - version of the project to which the integration flow belongs to

flowId - ID of the XIntegrationFlow

elementId - ID of the element (this will be the Spring bean name of the element)

messageContext - XMessageContext instance to be traced

traceMessage

public void traceMessage(String projectId,
                         String projectVersion,
                         String flowId,
                         String sourceId,
                         String outPortDisplayName,
                         String targetId,
                         XMessageContext messageContext)

Description copied from interface: XIntegrationFlowTracer

Traces a message context that was transferred from the given outport (of given source element) to the given target element

Specified by:

traceMessage in interface XIntegrationFlowTracer

Parameters:

projectId - ID of the project to which the integration flow belongs to

projectVersion - version of the project to which the integration flow belongs to

flowId - ID of the XIntegrationFlow

sourceId - ID of the source element

outPortDisplayName - display name of the outport from which the message is emitted

targetId - ID of the target element

messageContext - XMessageContext instance to be traced

enableMessageTracing

public void enableMessageTracing()

Description copied from interface: XIntegrationFlowTracer

Enables tracing of messages

Specified by:

enableMessageTracing in interface XIntegrationFlowTracer

disableMessageTracing

public void disableMessageTracing()

Description copied from interface: XIntegrationFlowTracer

Disables tracing of messages

Specified by:

disableMessageTracing in interface XIntegrationFlowTracer

isTracingEnabled

public boolean isTracingEnabled()

Description copied from interface: XIntegrationFlowTracer

Checks whether the message tracing is enabled

Specified by:

isTracingEnabled in interface XIntegrationFlowTracer

Returns:

true if enabled, false if disabled

setTracingEnabled

public void setTracingEnabled(boolean tracingEnabled)

Description copied from interface: XIntegrationFlowTracer

Sets whether to enable tracing or not

Specified by:

setTracingEnabled in interface XIntegrationFlowTracer

Parameters:

tracingEnabled - if true, tracing will be enabled

getTracedFlow

public List<IntegrationFlowTraceNode> getTracedFlow(String projectId,
                                                    String projectVersion,
                                                    String flowId)

Description copied from interface: XIntegrationFlowTracer

Retrieves the last trace of the Integration Flow with the given Id

Specified by:

getTracedFlow in interface XIntegrationFlowTracer

Parameters:

projectId - ID of the project to which the integration flow belongs to

projectVersion - version of the project to which the integration flow belongs to

flowId - ID of the XIntegrationFlow

Returns:

List of IntegrationFlowTraceNode with each entry representing a trace between two elements, will return an empty list if there is no trace exists for this flow

getMessageView

public Optional<XMessageView> getMessageView(String projectId,
                                             String projectVersion,
                                             String flowId,
                                             String sourceId,
                                             String outPortName,
                                             String targetId)

Description copied from interface: XIntegrationFlowTracer

Retrieves the traced view of the message context that was transferred from the given outport (of given source element) to the given target element

Specified by:

getMessageView in interface XIntegrationFlowTracer

Parameters:

projectId - ID of the project to which the integration flow belongs to

projectVersion - version of the project to which the integration flow belongs to

flowId - ID of the XIntegrationFlow

sourceId - ID of the source element

outPortName - display name of the outport from which the message is emitted

targetId - ID of the target element

Returns:

Optional of type XMessageView containing the traced message view if exists, else Optional.empty()

getReceivedMessage

public Optional<XMessageView> getReceivedMessage(String projectId,
                                                 String projectVersion,
                                                 String flowId,
                                                 String elementID)

Description copied from interface: XIntegrationFlowTracer

Retrieves the traced view of the received message context of the given element

Specified by:

getReceivedMessage in interface XIntegrationFlowTracer

Parameters:

projectId - ID of the project to which the integration flow belongs to

projectVersion - version of the project to which the integration flow belongs to

flowId - ID of the XIntegrationFlow

elementID - ID of the element

Returns:

Optional of type XMessageView containing the traced message view if exists, else Optional.empty()

getMaxPayloadSizeKbs

public int getMaxPayloadSizeKbs()

Description copied from interface: XIntegrationFlowTracer

Retrieves the current set value for the maximum size of the payload to be traced. Payloads larger than this value will be truncated and traced.

Specified by:

getMaxPayloadSizeKbs in interface XIntegrationFlowTracer

Returns:

current value for the maximum size of the payload to be traced in kilo bytes

setMaxPayloadSizeKbs

public void setMaxPayloadSizeKbs(int maxPayloadSizeKbs)

Description copied from interface: XIntegrationFlowTracer

Sets the the maximum size of the payload to be traced. Payloads larger than this value will be truncated and traced. The default value for this will be 100Kb.

Specified by:

setMaxPayloadSizeKbs in interface XIntegrationFlowTracer

Parameters:

maxPayloadSizeKbs - the maximum size of the payload to be traced in kilo bytes