org.adroitlogic.x.management.jmx

Class ServerManagement

java.lang.Object

org.adroitlogic.x.management.jmx.ServerManagement

All Implemented Interfaces:

XServerManagementMXBean

public class ServerManagement
extends Object
implements XServerManagementMXBean

Implementation of server management related operations

Since:

17.01

Author:

Udith Gunaratna

Constructor Summary

Constructors

Constructor and Description
ServerManagement(ServerConfig serverConfig)

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

ServerManagement

public ServerManagement(ServerConfig serverConfig)

Method Detail

stopXServer

public 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 XServerManagementMXBean.shutdownXServer() method.

Specified by:

stopXServer in interface XServerManagementMXBean

startXServer

public void startXServer()

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

Specified by:

startXServer in interface XServerManagementMXBean

shutdownXServer

public void shutdownXServer()

Description copied from interface: XServerManagementMXBean

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

Specified by:

shutdownXServer in interface XServerManagementMXBean

startMaintenance

public void startMaintenance()

Description copied from interface: XServerManagementMXBean

Starts the maintenance mode of XServer

Specified by:

startMaintenance in interface XServerManagementMXBean

stopMaintenance

public void stopMaintenance()

Description copied from interface: XServerManagementMXBean

Resume normal operations from maintenance mode

Specified by:

stopMaintenance in interface XServerManagementMXBean

gracefulShutdown

public void gracefulShutdown(long waitTimeMillis)

Description copied from interface: XServerManagementMXBean

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.

Specified by:

gracefulShutdown in interface XServerManagementMXBean

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

public void enableMessageTracing()

Enables integration flow message tracing functionality

Specified by:

enableMessageTracing in interface XServerManagementMXBean

disableMessageTracing

public void disableMessageTracing()

Disables integration flow message tracing functionality

Specified by:

disableMessageTracing in interface XServerManagementMXBean

isMessageTracingEnabled

public boolean isMessageTracingEnabled()

Checks whether the integration flow message tracing functionality is enabled *

Specified by:

isMessageTracingEnabled in interface XServerManagementMXBean

Returns:

true if enabled, false otherwise

clearAllMessageTraces

public void clearAllMessageTraces()

Clears all the message paths currently traced in the memory

Specified by:

clearAllMessageTraces in interface XServerManagementMXBean

clearMessageTrace

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

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

Specified by:

clearMessageTrace in interface XServerManagementMXBean

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

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

Retrieves the last traced message path

Specified by:

retrieveMessagePath in interface XServerManagementMXBean

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

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

Retrieves traced message view between two integration flow elements

Specified by:

retrieveMessageView in interface XServerManagementMXBean

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

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

Retrieves traced received message view of a flow element

Specified by:

retrieveReceivedMessage in interface XServerManagementMXBean

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