net.officefloor.building.manager

Class OpenOfficeFloorConfiguration

java.lang.Object

net.officefloor.building.manager.OpenOfficeFloorConfiguration

All Implemented Interfaces:

Serializable

public final class OpenOfficeFloorConfiguration
extends Object
implements Serializable

Configuration for opening an OfficeFloor by the OfficeBuildingManagerMBean.

Author:

Daniel Sagenschneider

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
OpenOfficeFloorConfiguration(String officeFloorLocation) Initiate.

Method Summary

Modifier and Type	Method and Description
void	addClassPathEntry(String classPathEntry) Adds a configured class path entry.
void	addJvmOption(String jvmOption) Adds a JVM option for the Process.
void	addOfficeFloorProperty(String name, String value) Adds an OfficeFloor property.
void	addUploadArtifact(UploadArtifact uploadArtifact) Adds an UploadArtifact.
String[]	getClassPathEntries() Obtains configured class path entries.
String[]	getJvmOptions() Obtains the JVM options.
String	getOfficeFloorLocation() Obtains the OfficeFloor location.
Properties	getOfficeFloorProperties() Obtains the OfficeFloor properties.
String	getOfficeFloorSourceClassName() Obtains the OfficeFloorSource class name.
String	getOfficeName() Obtains the name of the Office containing the Work to be run.
String	getParameter() Obtains the parameter for the Task to be run.
String	getProcessName() Obtains the name of the Process.
String	getTaskName() Obtains the name of the Task to be run.
UploadArtifact[]	getUploadArtifacts() Obtains the listing of UploadArtifact instances.
String	getWorkName() Obtains the name of the Work to be run.
void	setOfficeFloorLocation(String officeFloorLocation) Specifies the OfficeFloor location.
void	setOfficeFloorSourceClassName(String officeFloorSourceClassName) Specifies the OfficeFloorSource class name.
void	setOpenTask(String officeName, String workName, String taskName, String parameter) Specifies the Task to trigger on opening the OfficeFloor.
void	setProcessName(String processName) Specifies the name of the Process.

Methods inherited from class java.lang.Object

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

Constructor Detail

OpenOfficeFloorConfiguration

public OpenOfficeFloorConfiguration(String officeFloorLocation)

Initiate.

Parameters:

officeFloorLocation - Location of the OfficeFloor.

Method Detail

getProcessName

public String getProcessName()

Obtains the name of the Process.

Returns:

Name of the Process.

setProcessName

public void setProcessName(String processName)

Specifies the name of the Process.

Parameters:

processName - Name of the Process.

addUploadArtifact

public void addUploadArtifact(UploadArtifact uploadArtifact)

Adds an UploadArtifact.

Parameters:

uploadArtifact - UploadArtifact.

getUploadArtifacts

public UploadArtifact[] getUploadArtifacts()

Obtains the listing of UploadArtifact instances.

Returns:

Listing of UploadArtifact instances.

addClassPathEntry

public void addClassPathEntry(String classPathEntry)

Adds a configured class path entry.

Please be aware that the OfficeBuildingManager may disallow opening OfficeFloor instances with configured class path entries.

This should never be used in Production. It is made available for the maven plug-ins to be able to run OfficeFloor instances from project configuration.

Parameters:

classPathEntry - Class path entry.

getClassPathEntries

public String[] getClassPathEntries()

Obtains configured class path entries.

Returns:

Class path entries.

addJvmOption

public void addJvmOption(String jvmOption)

Adds a JVM option for the Process.

Parameters:

jvmOption - JVM option for the Process.

getJvmOptions

public String[] getJvmOptions()

Obtains the JVM options.

Returns:

JVM options.

setOfficeFloorSourceClassName

public void setOfficeFloorSourceClassName(String officeFloorSourceClassName)

Specifies the OfficeFloorSource class name.

Parameters:

officeFloorSourceClassName - OfficeFloorSource class name.

getOfficeFloorSourceClassName

public String getOfficeFloorSourceClassName()

Obtains the OfficeFloorSource class name.

Returns:

OfficeFloorSource class name.

setOfficeFloorLocation

public void setOfficeFloorLocation(String officeFloorLocation)

Specifies the OfficeFloor location.

Parameters:

officeFloorLocation - OfficeFloor location.

getOfficeFloorLocation

public String getOfficeFloorLocation()

Obtains the OfficeFloor location.

Returns:

OfficeFloor location.

addOfficeFloorProperty

public void addOfficeFloorProperty(String name,
                                   String value)

Adds an OfficeFloor property.

Parameters:

name - Name.

value - Value.

getOfficeFloorProperties

public Properties getOfficeFloorProperties()

Obtains the OfficeFloor properties.

Returns:

OfficeFloor properties.

setOpenTask

public void setOpenTask(String officeName,
                        String workName,
                        String taskName,
                        String parameter)

Specifies the Task to trigger on opening the OfficeFloor.

Parameters:

officeName - Name of the Office containing the Work.

workName - Name of Work.

taskName - Name of Task.

parameter - Parameter to the Task.

getOfficeName

public String getOfficeName()

Obtains the name of the Office containing the Work to be run.

Returns:

Name of the Office containing the Work to be run.

getWorkName

public String getWorkName()

Obtains the name of the Work to be run.

Returns:

Name of the Work to be run.

getTaskName

public String getTaskName()

Obtains the name of the Task to be run.

Returns:

Name of the Task to be run.

getParameter

public String getParameter()

Obtains the parameter for the Task to be run.

Returns:

Parameter for the Task to be run.