net.officefloor.building.manager

Class OfficeBuildingManager

java.lang.Object

net.officefloor.building.manager.OfficeBuildingManager

All Implemented Interfaces:

OfficeBuildingManagerMBean

public class OfficeBuildingManager
extends Object
implements OfficeBuildingManagerMBean

OfficeBuilding Manager.

Author:

Daniel Sagenschneider

Field Summary

Fields

Modifier and Type	Field and Description
static String	OFFICE_BUILDING_ARTIFACT_ID Maven Artifact Id for this OfficeBuilding.
static String	OFFICE_BUILDING_GROUP_ID Maven Group Id for the OfficeBuilding.
static String	OFFICE_BUILDING_PROPERTY_PREFIX Prefix to property names from System.getProperties() for configuration.

Method Summary

Modifier and Type	Method and Description
void	closeOfficeFloor(String processNamespace, long waitTime) Closes the OfficeFloor.
static <I> I	getMBeanProxy(String hostName, int port, File trustStore, String trustStorePassword, String userName, String password, ObjectName mbeanName, Class<I> mbeanInterface) Obtains the MBean proxy.
String	getOfficeBuildingHostName() Obtains the name of the host running the OfficeBuilding.
String	getOfficeBuildingJmxServiceUrl() Obtains the JMXServiceURL of the OfficeBuilding being managed by this OfficeBuildingManagerMBean.
static JMXServiceURL	getOfficeBuildingJmxServiceUrl(String hostName, int port) Obtains the OfficeBuilding JMXConnectorServer JMXServiceURL.
static OfficeBuildingManagerMBean	getOfficeBuildingManager(String hostName, int port, File trustStore, String trustStorePassword, String userName, String password) Obtains the OfficeBuildingManagerMBean for the OfficeBuilding.
static ObjectName	getOfficeBuildingManagerObjectName() Obtains ObjectName for the OfficeBuildingManagerMBean.
int	getOfficeBuildingPort() Obtains the port that the OfficeBuilding is listening on.
static OfficeFloorManagerMBean	getOfficeFloorManager(String hostName, int port, String processNamespace, File trustStore, String trustStorePassword, String userName, String password) Obtains the OfficeFloorManagerMBean.
static ProcessManagerMBean	getProcessManager(String hostName, int port, String processNamespace, File trustStore, String trustStorePassword, String userName, String password) Obtains the ProcessManagerMBean by the process name for the OfficeBuilding.
static ProcessShellMBean	getProcessShell(String hostName, int port, String processNamespace, File trustStore, String trustStorePassword, String userName, String password) Obtains the ProcessShellMBean by the process name for the OfficeBuilding.
static String	getSslAlgorithm() Obtains the SSL algorithm being used.
static String	getSslProtocol() Obtains the SSL protocol being used.
Date	getStartTime() Obtains the time the OfficeBuilding was started.
static boolean	isOfficeBuildingAvailable(String hostName, int port, File trustStore, String trustStorePassword, String userName, String password) Determines if the OfficeBuilding is available for use.
boolean	isOfficeBuildingStopped() Indicates if the OfficeBuilding has been stopped.
String[]	listProcessNamespaces() Provides a listing of the Process name spaces currently running within the OfficeBuilding.
String	openOfficeFloor(OpenOfficeFloorConfiguration configuration) Opens an OfficeFloor within the OfficeBuilding.
String	openOfficeFloor(String arguments) Opens an OfficeFloor within the OfficeBuilding.
static ProcessManager	spawnOfficeBuilding(String hostName, int port, File keyStore, String keyStorePassword, String userName, String password, File workspace, boolean isIsolateProcesses, Properties environment, String[] jvmOptions, boolean isAllowClassPathEntries, ProcessConfiguration configuration) Spawns an OfficeBuilding in a new Process.
static OfficeBuildingManagerMBean	startOfficeBuilding(String hostName, int port, File keyStore, String keyStorePassword, String userName, String password, File workspace, boolean isIsolateProcesses, Properties environment, MBeanServer mbeanServer, String[] jvmOptions, boolean isAllowClassPathEntries) Starts the OfficeBuilding.
String	stopOfficeBuilding(long waitTime) Stops the OfficeBuilding.

Methods inherited from class java.lang.Object

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

Field Detail

OFFICE_BUILDING_GROUP_ID

public static final String OFFICE_BUILDING_GROUP_ID

Maven Group Id for the OfficeBuilding.

See Also:

Constant Field Values

OFFICE_BUILDING_ARTIFACT_ID

public static final String OFFICE_BUILDING_ARTIFACT_ID

Maven Artifact Id for this OfficeBuilding.

See Also:

Constant Field Values

OFFICE_BUILDING_PROPERTY_PREFIX

public static final String OFFICE_BUILDING_PROPERTY_PREFIX

Prefix to property names from System.getProperties() for configuration.

See Also:

Constant Field Values

Method Detail

getOfficeBuildingManagerObjectName

public static ObjectName getOfficeBuildingManagerObjectName()

Obtains ObjectName for the OfficeBuildingManagerMBean.

Returns:

ObjectName for the OfficeBuildingManagerMBean.

getSslProtocol

public static String getSslProtocol()

Obtains the SSL protocol being used.

Returns:

SSL protocol being used.

getSslAlgorithm

public static String getSslAlgorithm()

Obtains the SSL algorithm being used.

Returns:

SSL algorithm being used.

startOfficeBuilding

public static OfficeBuildingManagerMBean startOfficeBuilding(String hostName,
                                                             int port,
                                                             File keyStore,
                                                             String keyStorePassword,
                                                             String userName,
                                                             String password,
                                                             File workspace,
                                                             boolean isIsolateProcesses,
                                                             Properties environment,
                                                             MBeanServer mbeanServer,
                                                             String[] jvmOptions,
                                                             boolean isAllowClassPathEntries)
                                                      throws Exception

Starts the OfficeBuilding.

Parameters:

hostName - Host for the OfficeBuilding. This is necessary as the RMI JMXConnector uses this to connect to the OfficeBuilding. May be null to use the localhost's host name.

port - Port for the OfficeBuilding.

keyStore - File containing the security keys.

keyStorePassword - Password to the key store File.

userName - User name to allow connecting to the OfficeBuildingManager.

password - Password to allow connecting to the OfficeBuildingManager.

workspace - Work space for the OfficeBuilding. May be null to use default location (temp directory).

isIsolateProcesses - Flag indicating to isolate each Process. false will have artifacts shared between Process instances.

environment - Environment Properties.

mbeanServer - MBeanServer. May be null to use platform MBeanServer.

jvmOptions - JVM options for the spawned Process instances.

isAllowClassPathEntries - Flag indicating if allow class path entries via the OpenOfficeFloorConfiguration.

Returns:

OfficeBuildingManager managing the started OfficeBuilding.

Throws:

Exception - If fails to start the OfficeBuilding.

isOfficeBuildingAvailable

public static boolean isOfficeBuildingAvailable(String hostName,
                                                int port,
                                                File trustStore,
                                                String trustStorePassword,
                                                String userName,
                                                String password)

Determines if the OfficeBuilding is available for use.

Parameters:

hostName - Name of host where the OfficeBuilding should be available.

port - Port on which the OfficeBuilding should be available.

trustStore - File containing the trusted security keys.

trustStorePassword - Password to the trusted key store File.

userName - User name to connect.

password - Password to connect.

Returns:

true if the OfficeBuilding is available.

spawnOfficeBuilding

public static ProcessManager spawnOfficeBuilding(String hostName,
                                                 int port,
                                                 File keyStore,
                                                 String keyStorePassword,
                                                 String userName,
                                                 String password,
                                                 File workspace,
                                                 boolean isIsolateProcesses,
                                                 Properties environment,
                                                 String[] jvmOptions,
                                                 boolean isAllowClassPathEntries,
                                                 ProcessConfiguration configuration)
                                          throws ProcessException

Spawns an OfficeBuilding in a new Process.

Parameters:

hostName - Host for the OfficeBuilding. This is necessary as the RMI JMXConnector uses this to connect to the OfficeBuilding. May be null to use the localhost's host name.

port - Port for the OfficeBuilding.

keyStore - File containing the security keys.

keyStorePassword - Password to the key store File.

userName - User name to connect.

password - Password to connect.

workspace - Workspace for the OfficeBuilding.

isIsolateProcesses - Flag indicating to isolate the Process instances.

environment - Environment Properties. May be null.

configuration - ProcessConfiguration. May be null.

jvmOptions - JVM options for the Process instances.

isAllowClassPathEntries - Flag indicating if the OfficeBuilding will allow configured class path entries.

Returns:

ProcessManager managing the started OfficeBuilding.

Throws:

ProcessException - If fails to spawn the OfficeBuilding.

getOfficeBuildingManager

public static OfficeBuildingManagerMBean getOfficeBuildingManager(String hostName,
                                                                  int port,
                                                                  File trustStore,
                                                                  String trustStorePassword,
                                                                  String userName,
                                                                  String password)
                                                           throws Exception

Obtains the OfficeBuildingManagerMBean for the OfficeBuilding.

This a utility method to obtain the OfficeBuildingManagerMBean of an existing OfficeBuilding.

Parameters:

hostName - Name of the host where the OfficeBuilding resides. null indicates localhost.

port - Port where the OfficeBuilding resides.

trustStore - File containing the trusted security keys.

trustStorePassword - Password to the trusted key store File.

userName - User name to connect.

password - Password to connect.

Returns:

OfficeBuildingManagerMBean.

Throws:

Exception - If fails to obtain the OfficeBuildingManagerMBean.

getProcessManager

public static ProcessManagerMBean getProcessManager(String hostName,
                                                    int port,
                                                    String processNamespace,
                                                    File trustStore,
                                                    String trustStorePassword,
                                                    String userName,
                                                    String password)
                                             throws Exception

Obtains the ProcessManagerMBean by the process name for the OfficeBuilding.

This a utility method to obtain the ProcessManagerMBean of an existing Process currently running within the OfficeBuilding.

Parameters:

hostName - Name of the host where the OfficeBuilding resides. null indicates localhost.

port - Port where the OfficeBuilding resides.

processNamespace - Name of the Process to obtain its ProcessManagerMBean.

trustStore - File containing the trusted security keys.

trustStorePassword - Password to the trusted key store File.

userName - User name to connect.

password - Password to connect.

Returns:

ProcessManagerMBean.

Throws:

Exception - If fails to obtain the ProcessManagerMBean.

getProcessShell

public static ProcessShellMBean getProcessShell(String hostName,
                                                int port,
                                                String processNamespace,
                                                File trustStore,
                                                String trustStorePassword,
                                                String userName,
                                                String password)
                                         throws Exception

Obtains the ProcessShellMBean by the process name for the OfficeBuilding.

This a utility method to obtain the ProcessShellMBean of an existing Process currently being managed within the OfficeBuilding.

Parameters:

hostName - Name of the host where the OfficeBuilding resides. null indicates localhost.

port - Port where the OfficeBuilding resides.

processNamespace - Name of the Process to obtain its ProcessShellMBean.

trustStore - File containing the trusted security keys.

trustStorePassword - Password to the trusted key store File.

userName - User name to connect.

password - Password to connect.

Returns:

ProcessShellMBean.

Throws:

Exception - If fails to obtain the ProcessShellMBean.

getOfficeFloorManager

public static OfficeFloorManagerMBean getOfficeFloorManager(String hostName,
                                                            int port,
                                                            String processNamespace,
                                                            File trustStore,
                                                            String trustStorePassword,
                                                            String userName,
                                                            String password)
                                                     throws Exception

Obtains the OfficeFloorManagerMBean.

The hostName and port are of the OfficeBuilding managing the OfficeFloor Process. They are not of the specific Process containing the OfficeFloor.

Parameters:

hostName - Name of the host where the OfficeBuilding resides. null indicates localhost.

port - Port where the OfficeBuilding resides.

trustStore - File containing the trusted security keys.

trustStorePassword - Password to the trusted key store File.

userName - User name to connect.

password - Password to connect.

processNamespace - Namespace of the OfficeFloorManagerMBean.

Returns:

OfficeFloorManagerMBean.

Throws:

Exception - If fails to obtain OfficeFloorManagerMBean.

getOfficeBuildingJmxServiceUrl

public static JMXServiceURL getOfficeBuildingJmxServiceUrl(String hostName,
                                                           int port)
                                                    throws IOException

Obtains the OfficeBuilding JMXConnectorServer JMXServiceURL.

This a utility method to obtain the JMXServiceURL of an existing OfficeBuilding.

Parameters:

hostName - Name of the host where the OfficeBuilding resides. null indicates localhost.

port - Port the OfficeBuilding is residing on.

Returns:

JMXServiceURL to the OfficeBuilding JMXConnectorServer.

Throws:

IOException - If fails to obtain the JMXServiceURL.

getMBeanProxy

public static <I> I getMBeanProxy(String hostName,
                                  int port,
                                  File trustStore,
                                  String trustStorePassword,
                                  String userName,
                                  String password,
                                  ObjectName mbeanName,
                                  Class<I> mbeanInterface)
                           throws IOException

Obtains the MBean proxy.

This a utility method to obtain an MBean from an existing Office Building.

Type Parameters:

I - MBean interface type.

Parameters:

hostName - Host where the OfficeBuilding resides.

port - Port where the OfficeBuilding resides.

trustStore - File containing the trusted security keys.

trustStorePassword - Password to the trusted key store File.

userName - User name to connect.

password - Password to connect.

mbeanName - ObjectName for the MBean.

mbeanInterface - MBean interface of the MBean.

Returns:

Proxy to the MBean.

Throws:

IOException - If fails to obtain the MBean proxy.

getStartTime

public Date getStartTime()

Description copied from interface: OfficeBuildingManagerMBean

Obtains the time the OfficeBuilding was started.

The time is specific to the host the OfficeBuilding is running on.

Specified by:

getStartTime in interface OfficeBuildingManagerMBean

Returns:

Time the OfficeBuilding was started.

getOfficeBuildingJmxServiceUrl

public String getOfficeBuildingJmxServiceUrl()

Description copied from interface: OfficeBuildingManagerMBean

Obtains the JMXServiceURL of the OfficeBuilding being managed by this OfficeBuildingManagerMBean.

The returned value can be used as is for the construction of a JMXServiceURL to the OfficeBuilding.

Specified by:

getOfficeBuildingJmxServiceUrl in interface OfficeBuildingManagerMBean

Returns:

JMXServiceURL of the OfficeBuilding being managed by this OfficeBuildingManagerMBean.

getOfficeBuildingHostName

public String getOfficeBuildingHostName()

Description copied from interface: OfficeBuildingManagerMBean

Obtains the name of the host running the OfficeBuilding.

Specified by:

getOfficeBuildingHostName in interface OfficeBuildingManagerMBean

Returns:

Name of the host running the OfficeBuilding.

getOfficeBuildingPort

public int getOfficeBuildingPort()

Description copied from interface: OfficeBuildingManagerMBean

Obtains the port that the OfficeBuilding is listening on.

Specified by:

getOfficeBuildingPort in interface OfficeBuildingManagerMBean

Returns:

Port that the OfficeBuilding is listening on.

openOfficeFloor

public String openOfficeFloor(String arguments)
                       throws ProcessException

Description copied from interface: OfficeBuildingManagerMBean

Opens an OfficeFloor within the OfficeBuilding.

Allows for open type parameters for JMX invocation.

Specified by:

openOfficeFloor in interface OfficeBuildingManagerMBean

Parameters:

arguments - OfficeFloor arguments separated by white spacing.

Returns:

Process name space of the opened OfficeFloor.

Throws:

ProcessException - If fails to open the OfficeFloor.

See Also:

ProcessManagerMBean.getProcessNamespace()

openOfficeFloor

public String openOfficeFloor(OpenOfficeFloorConfiguration configuration)
                       throws ProcessException

Description copied from interface: OfficeBuildingManagerMBean

Opens an OfficeFloor within the OfficeBuilding.

The complex argument means this method will typically only be able to be programmatically invoked - not for JMX console invocation. Use the other openOfficeFloor for this type of invocation.

Specified by:

openOfficeFloor in interface OfficeBuildingManagerMBean

Parameters:

configuration - OpenOfficeFloorConfiguration.

Returns:

Process name space of the opened OfficeFloor.

Throws:

ProcessException - If fails to open the OfficeFloor.

See Also:

ProcessManagerMBean.getProcessNamespace()

listProcessNamespaces

public String[] listProcessNamespaces()
                               throws ProcessException

Description copied from interface: OfficeBuildingManagerMBean

Provides a listing of the Process name spaces currently running within the OfficeBuilding.

Specified by:

listProcessNamespaces in interface OfficeBuildingManagerMBean

Returns:

Listing of the Process name spaces currently running within the OfficeBuilding.

Throws:

ProcessException - If fails to list process namespaces.

closeOfficeFloor

public void closeOfficeFloor(String processNamespace,
                             long waitTime)
                      throws ProcessException

Description copied from interface: OfficeBuildingManagerMBean

Closes the OfficeFloor.

Specified by:

closeOfficeFloor in interface OfficeBuildingManagerMBean

Parameters:

processNamespace - Process name space for the OfficeFloor.

waitTime - Time to wait for OfficeFloor to stop before being destroyed.

Throws:

ProcessException - If fails to close the OfficeFloor.

See Also:

ProcessManagerMBean.getProcessNamespace()

stopOfficeBuilding

public String stopOfficeBuilding(long waitTime)
                          throws ProcessException

Description copied from interface: OfficeBuildingManagerMBean

Stops the OfficeBuilding.

Specified by:

stopOfficeBuilding in interface OfficeBuildingManagerMBean

Parameters:

waitTime - Time to wait for ManagedProcess instances to stop before being destroyed.

Returns:

Details of stopping the OfficeBuilding.

Throws:

ProcessException - If fails to stop the OfficeBuilding.

isOfficeBuildingStopped

public boolean isOfficeBuildingStopped()

Description copied from interface: OfficeBuildingManagerMBean

Indicates if the OfficeBuilding has been stopped.

Specified by:

isOfficeBuildingStopped in interface OfficeBuildingManagerMBean

Returns:

true should the OfficeBuilding be stopped.