org.adroitlogic.x.management.jmx

Interface XServerManagementMXBean

All Known Implementing Classes:

ServerManagement

public interface XServerManagementMXBean

Java MXBean for server management related operations

Since:

17.01

Author:

Udith Gunaratna

Method Summary

Modifier and Type	Method and Description
void	disableMessageTracing() Disables integration flow message tracing functionality
void	enableMessageTracing() Enables integration flow message tracing functionality
boolean	isMessageTracingEnabled() Checks whether the integration flow message tracing functionality is enabled *
List<IntegrationFlowTraceNode>	retrieveMessagePath(String projectId, String projectVersion, String flowId) Retrieves the last traced message path
XMessageView	retrieveMessageView(String projectId, String projectVersion, String flowId, String sourceId, String outPortDisplayName, String targetId) Retrieves traced message view between two integration flow elements
XMessageView	retrieveReceivedMessage(String projectId, String projectVersion, String flowId, String elementId) Retrieves traced received message view of a flow element
void	startXServer() Starts the XServer initializing projects, deployment units and integration flows
void	stopXServer() Stops the XServer destroying projects, deployment units and integration flows

Method Detail

stopXServer

void stopXServer()

Stops the XServer destroying projects, deployment units and integration flows

startXServer

void startXServer()

Starts the XServer initializing projects, deployment units and integration flows

enableMessageTracing

void enableMessageTracing()

Enables integration flow message tracing functionality

disableMessageTracing

void disableMessageTracing()

Disables integration flow message tracing functionality

isMessageTracingEnabled

boolean isMessageTracingEnabled()

Checks whether the integration flow message tracing functionality is enabled *

Returns:

true if enabled, false otherwise

retrieveMessagePath

List<IntegrationFlowTraceNode> retrieveMessagePath(String projectId,
                                                   String projectVersion,
                                                   String flowId)

Retrieves the last traced message path

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 instance

Returns:

List of IntegrationFlowTraceNode

retrieveMessageView

XMessageView retrieveMessageView(String projectId,
                                 String projectVersion,
                                 String flowId,
                                 String sourceId,
                                 String outPortDisplayName,
                                 String targetId)

Retrieves traced message view between two integration flow elements

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 instance

sourceId - bean ID of the source element

outPortDisplayName - display name of the source outport

targetId - bean ID of the target element

Returns:

XMessageView

retrieveReceivedMessage

XMessageView retrieveReceivedMessage(String projectId,
                                     String projectVersion,
                                     String flowId,
                                     String elementId)

Retrieves traced received message view of a flow element

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 instance

elementId - bean ID of the element

Returns:

XMessageView