Package net.officefloor.compile.spi.officefloor.source

Interface OfficeFloorSource

All Known Implementing Classes:

AbstractOfficeFloorSource, ApplicationOfficeFloorSource, CompileOfficeFloor, OfficeFloorModelOfficeFloorSource, WebCompileOfficeFloor

public interface OfficeFloorSource

Sources the OfficeFloor.

Author:

Daniel Sagenschneider

Method Summary

Modifier and Type	Method	Description
OfficeFloorSourceSpecification	getSpecification()	Obtains the OfficeFloorSourceSpecification for this OfficeFloorSource.
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.

Method Detail

getSpecification

OfficeFloorSourceSpecification getSpecification()

Obtains the OfficeFloorSourceSpecification for this OfficeFloorSource.

This enables the OfficeFloorSourceContext to be populated with the necessary details as per this OfficeFloorSourceSpecification in deploying the OfficeFloor.

Returns:

OfficeFloorSourceSpecification.

specifyConfigurationProperties

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

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

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

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.