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	clearAllMessageTraces() Clears all the message paths currently traced in the memory
void	clearMessageTrace(String projectId, String projectVersion, String flowId) Clears a message path of the given integration flow currently traced in the memory
void	disableMessageTracing() Disables integration flow message tracing functionality
void	enableMessageTracing() Enables integration flow message tracing functionality
void	gracefulShutdown(long waitTimeMillis) Shutdown the XServer gracefully within the specified grace period.
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	shutdownXServer() Shutdown the XServer destroying its transports, projects, integration flow and finally exit the JVM
void	startMaintenance() Starts the maintenance mode of XServer
void	startXServer() Starts the XServer and its transports, projects and integration flows.
void	stopMaintenance() Resume normal operations from maintenance mode
void	stopXServer() Stops the XServer and its transports, projects and integration flows.

Method Detail

stopXServer

void stopXServer()

Stops the XServer and its transports, projects and integration flows. But this will neither destroy the associated spring beans nor exit the JVM. For a complete shutdown, use shutdownXServer() method.

startXServer

void startXServer()

Starts the XServer and its transports, projects and integration flows. If necessary this will first initialize those entities before start

startMaintenance

void startMaintenance()

Starts the maintenance mode of XServer

stopMaintenance

void stopMaintenance()

Resume normal operations from maintenance mode

shutdownXServer

void shutdownXServer()

Shutdown the XServer destroying its transports, projects, integration flow and finally exit the JVM

gracefulShutdown

void gracefulShutdown(long waitTimeMillis)

Shutdown the XServer gracefully within the specified grace period. If the server failed to reach the idle state within the grace period, hard shutdown will be executed at that point.

Parameters:

waitTimeMillis - the maximum time period (in milliseconds ) that the shutdown action will wait for the server to become idle after entering the maintenance mode

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

clearAllMessageTraces

void clearAllMessageTraces()

Clears all the message paths currently traced in the memory

clearMessageTrace

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

Clears a message path of the given integration flow currently traced in the memory

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

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