net.officefloor.building.process

Class ProcessShell

java.lang.Object

net.officefloor.building.process.ProcessShell

All Implemented Interfaces:

ManagedProcessContext, ProcessShellMBean

public class ProcessShell
extends Object
implements ManagedProcessContext, ProcessShellMBean

Provides the main method of an invoked Process for a ManagedProcess.

Author:

Daniel Sagenschneider

Field Summary

Fields

Modifier and Type	Field and Description
static String	TRIGGER_STOP_PROCESS_METHOD Name of the triggerStopProcess() method to invoke via another MBean.

Constructor Summary

Constructors

Constructor and Description
ProcessShell(String processNamespace, JMXConnectorServer connectorServer, ObjectOutputStream toParentPipe) Initiate for Process.
ProcessShell(String processNamespace, MBeanServer mbeanServer) Initiate for running locally.

Method Summary

Modifier and Type	Method and Description
boolean	continueProcessing() Flags whether to continue processing.
String	getJmxConnectorServiceUrl() Obtains the JMXConnector JMXServiceURL for the Process.
String	getProcessNamespace() Obtains the name space for the ManagedProcess.
static ObjectName	getProcessShellObjectName() Obtains the ObjectName for the ProcessShellMBean.
static void	main(String[] arguments) Entrance point for running the ManagedProcess.
void	registerMBean(Object mbean, ObjectName name) Registers a MBean.
static void	run(String processNamespace, byte[] serialisedManagedProcess) Entrance point for running the ManagedProcess in current Process.
void	triggerStopProcess() Triggers gracefully stopping the Process.

Methods inherited from class java.lang.Object

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

Field Detail

TRIGGER_STOP_PROCESS_METHOD

public static final String TRIGGER_STOP_PROCESS_METHOD

Name of the triggerStopProcess() method to invoke via another MBean.

See Also:

Constant Field Values

Constructor Detail

ProcessShell

public ProcessShell(String processNamespace,
                    JMXConnectorServer connectorServer,
                    ObjectOutputStream toParentPipe)

Initiate for Process.

Parameters:

processNamespace - ManagedProcess name space.

connectorServer - JMXConnectorServer.

toParentPipe - ObjectOutputStream to send the notifications.

ProcessShell

public ProcessShell(String processNamespace,
                    MBeanServer mbeanServer)

Initiate for running locally.

Parameters:

processNamespace - ManagedProcess name space.

mbeanServer - Local MBeanServer.

Method Detail

getProcessShellObjectName

public static ObjectName getProcessShellObjectName()

Obtains the ObjectName for the ProcessShellMBean.

Returns:

ObjectName for the ProcessShellMBean.

run

public static void run(String processNamespace,
                       byte[] serialisedManagedProcess)
                throws Throwable

Entrance point for running the ManagedProcess in current Process.

Parameters:

processNamespace - ManagedProcess name space.

serialisedManagedProcess - Serialised ManagedProcess to be run.

Throws:

Throwable - If failure in running the ManagedProcess.

main

public static void main(String[] arguments)
                 throws IOException

Entrance point for running the ManagedProcess.

Parameters:

arguments - Arguments.

Throws:

IOException - If failure in running the ManagedProcess.

getJmxConnectorServiceUrl

public String getJmxConnectorServiceUrl()

Description copied from interface: ProcessShellMBean

Obtains the JMXConnector JMXServiceURL for the Process.

Specified by:

getJmxConnectorServiceUrl in interface ProcessShellMBean

Returns:

JMXConnector JMXServiceURL for the Process.

triggerStopProcess

public void triggerStopProcess()

Description copied from interface: ProcessShellMBean

Triggers gracefully stopping the Process.

Specified by:

triggerStopProcess in interface ProcessShellMBean

getProcessNamespace

public String getProcessNamespace()

Description copied from interface: ManagedProcessContext

Obtains the name space for the ManagedProcess.

Specified by:

getProcessNamespace in interface ManagedProcessContext

Returns:

Name space for the ManagedProcess.

registerMBean

public void registerMBean(Object mbean,
                          ObjectName name)
                   throws InstanceAlreadyExistsException,
                          MBeanRegistrationException,
                          NotCompliantMBeanException

Description copied from interface: ManagedProcessContext

Registers a MBean.

This is equivalent to corresponding MBeanServer method except that it also registers the MBean within the MBeanServer in the parent managing the Process.

Specified by:

registerMBean in interface ManagedProcessContext

Parameters:

mbean - MBean.

name - ObjectName of the MBean.

Throws:

InstanceAlreadyExistsException - The MBean is already under the control of the MBeanServer.

MBeanRegistrationException - Failure in registering the MBean.

NotCompliantMBeanException - This MBean is not a JMX compliant MBean.

See Also:

MBeanServer.registerMBean(Object, ObjectName)

continueProcessing

public boolean continueProcessing()

Description copied from interface: ManagedProcessContext

Flags whether to continue processing.

Specified by:

continueProcessing in interface ManagedProcessContext

Returns:

true for the ManagedProcess to continue processing. false to gracefully stop.