net.officefloor.building.process

Class ProcessManager

java.lang.Object

net.officefloor.building.process.ProcessManager

All Implemented Interfaces:

ProcessManagerMBean

public class ProcessManager
extends Object
implements ProcessManagerMBean

Manages a Process.

Author:

Daniel Sagenschneider

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_PROCESS_NAME Default ManagedProcess name.

Method Summary

Modifier and Type	Method and Description
void	destroyProcess() Forcibly destroys the Process.
ObjectName	getLocalObjectName(ObjectName objectName) Obtains the local ObjectName for the remote MBean in the Process being managed by this ProcessManager.
static ObjectName	getLocalObjectName(String processNamespace, ObjectName remoteObjectName) Obtains the local ObjectName for the remote MBean in the Process being managed within the MBean name space.
String	getProcessHostName() Obtains the host name that the Process is running on.
static ObjectName	getProcessManagerObjectName() Obtains the ObjectName for the ProcessManagerMBean.
String	getProcessName() Obtains the name given to the Process.
String	getProcessNamespace() Obtains the unique name space for Process.
int	getProcessPort() Obtains the port to access the Registry containing the MBeanServer for this Process.
boolean	isProcessComplete() Indicates if the ManagedProcess is complete.
static void	runProcess(ManagedProcess managedProcess, ProcessConfiguration configuration) Runs the ManagedProcess locally within calling Thread (and subsequently current Process).
static ProcessManager	startProcess(ManagedProcess managedProcess, ProcessConfiguration configuration) Starts the Process for the ManagedProcess returning the managing ProcessManager.
void	triggerStopProcess() Triggers for a graceful shutdown of the Process.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_PROCESS_NAME

public static final String DEFAULT_PROCESS_NAME

Default ManagedProcess name.

See Also:

Constant Field Values

Method Detail

getProcessManagerObjectName

public static ObjectName getProcessManagerObjectName()

Obtains the ObjectName for the ProcessManagerMBean.

Returns:

ObjectName for the ProcessManagerMBean.

runProcess

public static void runProcess(ManagedProcess managedProcess,
                              ProcessConfiguration configuration)
                       throws ProcessException

Runs the ManagedProcess locally within calling Thread (and subsequently current Process).

Parameters:

managedProcess - ManagedProcess.

configuration - Optional ProcessConfiguration. May be null to use defaults. Please note that most of the attributes such as JVM options are ignored as the current Process can not be altered.

Throws:

ProcessException - if fails to run the ManagedProcess.

startProcess

public static ProcessManager startProcess(ManagedProcess managedProcess,
                                          ProcessConfiguration configuration)
                                   throws ProcessException

Starts the Process for the ManagedProcess returning the managing ProcessManager.

Parameters:

managedProcess - ManagedProcess.

configuration - Optional ProcessConfiguration. May be null to use defaults.

Returns:

ProcessManager.

Throws:

ProcessException - If fails to start the Process.

getLocalObjectName

public static ObjectName getLocalObjectName(String processNamespace,
                                            ObjectName remoteObjectName)
                                     throws MalformedObjectNameException

Obtains the local ObjectName for the remote MBean in the Process being managed within the MBean name space.

Parameters:

processNamespace - Name space of the Process.

remoteObjectName - ObjectName of the remote MBean.

Returns:

Local ObjectName for the remote MBean in the Process being managed.

Throws:

MalformedObjectNameException - If resulting local name is malformed.

getLocalObjectName

public ObjectName getLocalObjectName(ObjectName objectName)
                              throws MalformedObjectNameException

Obtains the local ObjectName for the remote MBean in the Process being managed by this ProcessManager.

Parameters:

objectName - ObjectName of the remote MBean.

Returns:

Local ObjectName for the remote MBean in the Process being managed.

Throws:

MalformedObjectNameException - If resulting local name is malformed.

getProcessName

public String getProcessName()

Description copied from interface: ProcessManagerMBean

Obtains the name given to the Process.

The name may not be unique as more than one Process may be started with the same name.

See ProcessManagerMBean.getProcessNamespace() for a unique name.

Specified by:

getProcessName in interface ProcessManagerMBean

Returns:

Name given to the Process.

See Also:

ProcessManagerMBean.getProcessNamespace()

getProcessNamespace

public String getProcessNamespace()

Description copied from interface: ProcessManagerMBean

Obtains the unique name space for Process.

This is the unique name that identifies the Process running within the OfficeBuilding. The name is derived from the ProcessManagerMBean.getProcessName() however to maintain uniqueness the process name may be adjusted (typically by providing a unique suffix).

Specified by:

getProcessNamespace in interface ProcessManagerMBean

Returns:

Unique name space for the Process.

getProcessHostName

public String getProcessHostName()

Description copied from interface: ProcessManagerMBean

Obtains the host name that the Process is running on.

Specified by:

getProcessHostName in interface ProcessManagerMBean

Returns:

Host name that the Process is running on.

getProcessPort

public int getProcessPort()

Description copied from interface: ProcessManagerMBean

Obtains the port to access the Registry containing the MBeanServer for this Process.

Specified by:

getProcessPort in interface ProcessManagerMBean

Returns:

Port to access the Registry containing the MBeanServer for this Process.

triggerStopProcess

public void triggerStopProcess()
                        throws ProcessException

Description copied from interface: ProcessManagerMBean

Triggers for a graceful shutdown of the Process.

This is a non-blocking call to allow a timeout on graceful shutdown.

Specified by:

triggerStopProcess in interface ProcessManagerMBean

Throws:

ProcessException - If fails to stop the Process.

destroyProcess

public void destroyProcess()

Description copied from interface: ProcessManagerMBean

Forcibly destroys the Process.

Specified by:

destroyProcess in interface ProcessManagerMBean

isProcessComplete

public boolean isProcessComplete()

Description copied from interface: ProcessManagerMBean

Indicates if the ManagedProcess is complete.

Specified by:

isProcessComplete in interface ProcessManagerMBean

Returns:

true if the ManagedProcess is complete.