Package net.officefloor.compile.test.officefloor

Class CompileOfficeFloor

java.lang.Object

net.officefloor.compile.spi.officefloor.source.impl.AbstractOfficeFloorSource

net.officefloor.compile.test.officefloor.CompileOfficeFloor

All Implemented Interfaces:

OfficeFloorSource

Direct Known Subclasses:

WebCompileOfficeFloor

public class CompileOfficeFloor
extends AbstractOfficeFloorSource

Provides easier compiling of OfficeFloor for testing.

Author:

Daniel Sagenschneider

Nested Class Summary

Nested classes/interfaces inherited from class net.officefloor.compile.spi.officefloor.source.impl.AbstractOfficeFloorSource

AbstractOfficeFloorSource.SpecificationContext

Constructor Summary

Constructors

Constructor	Description
CompileOfficeFloor()	Instantiate.

Method Summary

Modifier and Type	Method	Description
OfficeFloor	compileAndOpenOfficeFloor()	Compiles and opens the Office.
OfficeFloor	compileOfficeFloor()	Compiles the OfficeFloor.
OfficeFloorCompiler	getOfficeFloorCompiler()	Obtains the OfficeFloorCompiler.
static void	invokeProcess(OfficeFloor officeFloor, java.lang.String functionName, java.lang.Object parameter)	Convenience method to invoke the ProcessState for the ManagedFunction within the default Office.
static void	invokeProcess(OfficeFloor officeFloor, java.lang.String functionName, java.lang.Object parameter, long waitTime)	Convenience method to invoke the ProcessState for the ManagedFunction within the default Office.
static void	invokeProcess(OfficeFloor officeFloor, java.lang.String officeName, java.lang.String functionName, java.lang.Object parameter, long waitTime)	Convenience method to invoke the ProcessState for the ManagedFunction.
OfficeFloorType	loadOfficeFloorType()	Loads the OfficeFloorType.
protected void	loadSpecification(AbstractOfficeFloorSource.SpecificationContext context)	Loads the OfficeFloorSourceSpecification.
void	office(CompileOfficeExtension extension)	Adds a CompileOfficeExtension.
void	officeFloor(CompileOfficeFloorExtension extension)	Adds a CompileOfficeFloorExtension.
void	section(CompileSectionExtension extension)	Adds a CompileSectionExtension.
void	sourceOfficeFloor(OfficeFloorDeployer deployer, OfficeFloorSourceContext context)	Sources the OfficeFloor by deploying it via the input OfficeFloorDeployer.
void	specifyConfigurationProperties(RequiredProperties requiredProperties, OfficeFloorSourceContext context)	Obtains from the OfficeFloorSource any additional Property instances required to source the OfficeFloor after interrogating the configuration.

Methods inherited from class net.officefloor.compile.spi.officefloor.source.impl.AbstractOfficeFloorSource

getSpecification

Methods inherited from class java.lang.Object

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

Constructor Detail

CompileOfficeFloor

public CompileOfficeFloor()

Instantiate.

Method Detail

invokeProcess

public static void invokeProcess(OfficeFloor officeFloor,
                                 java.lang.String functionName,
                                 java.lang.Object parameter)
                          throws java.lang.Throwable

Convenience method to invoke the ProcessState for the ManagedFunction within the default Office.

Parameters:

officeFloor - OfficeFloor.

functionName - Name of the ManagedFunction.

parameter - Parameter to the ManagedFunction.

Throws:

java.lang.Throwable - If fails to invoke the ProcessState.

invokeProcess

public static void invokeProcess(OfficeFloor officeFloor,
                                 java.lang.String functionName,
                                 java.lang.Object parameter,
                                 long waitTime)
                          throws java.lang.Throwable

Convenience method to invoke the ProcessState for the ManagedFunction within the default Office.

Parameters:

officeFloor - OfficeFloor.

functionName - Name of the ManagedFunction.

parameter - Parameter to the ManagedFunction.

waitTime - Time in milliseconds to wait for ProcessState to complete.

Throws:

java.lang.Throwable - If fails to invoke the ProcessState.

invokeProcess

public static void invokeProcess(OfficeFloor officeFloor,
                                 java.lang.String officeName,
                                 java.lang.String functionName,
                                 java.lang.Object parameter,
                                 long waitTime)
                          throws java.lang.Throwable

Convenience method to invoke the ProcessState for the ManagedFunction.

Parameters:

officeFloor - OfficeFloor.

officeName - Name of the Office containing the ManagedFunction.

functionName - Name of the ManagedFunction.

parameter - Parameter to the ManagedFunction.

waitTime - Time in milliseconds to wait for ProcessState to complete.

Throws:

java.lang.Throwable - If fails to invoke the ProcessState.

getOfficeFloorCompiler

public OfficeFloorCompiler getOfficeFloorCompiler()

Obtains the OfficeFloorCompiler.

Note the OfficeFloorSource is overridden on compiling to ensure the extensions are available.

Returns:

OfficeFloorCompiler.

officeFloor

public void officeFloor(CompileOfficeFloorExtension extension)

Adds a CompileOfficeFloorExtension.

Parameters:

extension - CompileOfficeFloorExtension.

office

public void office(CompileOfficeExtension extension)

Adds a CompileOfficeExtension.

Parameters:

extension - CompileOfficeExtension.

section

public void section(CompileSectionExtension extension)

Adds a CompileSectionExtension.

Parameters:

extension - CompileSectionExtension.

compileOfficeFloor

public OfficeFloor compileOfficeFloor()
                               throws java.lang.Exception

Compiles the OfficeFloor.

Returns:

OfficeFloor.

Throws:

java.lang.Exception - If fails to compile the OfficeFloor.

compileAndOpenOfficeFloor

public OfficeFloor compileAndOpenOfficeFloor()
                                      throws java.lang.Exception

Compiles and opens the Office.

Returns:

OfficeFloor.

Throws:

java.lang.Exception - If fails to compile and open the OfficeFloor.

loadOfficeFloorType

public OfficeFloorType loadOfficeFloorType()

Loads the OfficeFloorType.

Returns:

OfficeFloorType.

loadSpecification

protected void loadSpecification(AbstractOfficeFloorSource.SpecificationContext context)

Description copied from class: AbstractOfficeFloorSource

Loads the OfficeFloorSourceSpecification.

Specified by:

loadSpecification in class AbstractOfficeFloorSource

Parameters:

context - AbstractOfficeFloorSource.SpecificationContext.

specifyConfigurationProperties

public void specifyConfigurationProperties(RequiredProperties requiredProperties,
                                           OfficeFloorSourceContext context)
                                    throws java.lang.Exception

Description copied from interface: OfficeFloorSource

Obtains from the OfficeFloorSource any additional Property instances required to source the OfficeFloor after interrogating the configuration.

This method is a separate initial step from the OfficeFloorSource.sourceOfficeFloor(OfficeFloorDeployer, OfficeFloorSourceContext) method to enable specifying any required Property instances once the necessary ConfigurationItem instances have been interrogated.

Typically this allows environment specific properties to be defined externally so that deployment configuration need not be repeated per environment. In other words, one set of deployment configuration with properties providing the differences between the environments.

This also enables sensitive properties, such as passwords, to not be contained in deployment configuration but within a "secure" location.

Parameters:

requiredProperties - Populated by the OfficeFloorSource with any additional Property instances required to source the OfficeFloor.

context - OfficeFloorSourceContext populated with Property instances as per the OfficeFloorSourceSpecification.

Throws:

java.lang.Exception - If fails to initialise the OfficeFloorSource.

sourceOfficeFloor

public void sourceOfficeFloor(OfficeFloorDeployer deployer,
                              OfficeFloorSourceContext context)
                       throws java.lang.Exception

Description copied from interface: OfficeFloorSource

Sources the OfficeFloor by deploying it via the input OfficeFloorDeployer.

Parameters:

deployer - OfficeFloorDeployer to deploy the OfficeFloor.

context - OfficeFloorSourceContext populated with the Property instances as per the OfficeFloorSourceSpecification and RequiredProperties. Should there be a name clash between the two, the RequiredProperties Property will be used.

Throws:

java.lang.Exception - If fails to source the OfficeFloor.