Package net.officefloor.compile.impl

Class ApplicationOfficeFloorSource

java.lang.Object

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

net.officefloor.compile.impl.ApplicationOfficeFloorSource

All Implemented Interfaces:

OfficeFloorSource

@PrivateSource
public class ApplicationOfficeFloorSource
extends AbstractOfficeFloorSource

OfficeFloorSource to create a single empty Office.

It is expected that functionality will be loaded via OfficeExtensionService instances.

Author:

Daniel Sagenschneider

Nested Class Summary

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

AbstractOfficeFloorSource.SpecificationContext

Field Summary

Fields

Modifier and Type	Field	Description
static final String	OFFICE_NAME	Name of the default Office.

Constructor Summary

Constructors

Constructor	Description
ApplicationOfficeFloorSource()

Method Summary

Modifier and Type	Method	Description
protected void	loadSpecification(AbstractOfficeFloorSource.SpecificationContext context)	Loads the OfficeFloorSourceSpecification.
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

Field Details

OFFICE_NAME

public static final String OFFICE_NAME

Name of the default Office.

See Also:

• Constant Field Values

Constructor Details

ApplicationOfficeFloorSource

public ApplicationOfficeFloorSource()

Method Details

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 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:

Exception - If fails to initialise the OfficeFloorSource.

sourceOfficeFloor

public void sourceOfficeFloor(OfficeFloorDeployer deployer,
 OfficeFloorSourceContext context)
                       throws 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:

Exception - If fails to source the OfficeFloor.