Interface OfficeFloorSource
-
- All Known Implementing Classes:
AbstractOfficeFloorSource
,ApplicationOfficeFloorSource
,CompileOfficeFloor
,OfficeFloorModelOfficeFloorSource
,WebCompileOfficeFloor
public interface OfficeFloorSource
Sources theOfficeFloor
.- Author:
- Daniel Sagenschneider
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description OfficeFloorSourceSpecification
getSpecification()
Obtains theOfficeFloorSourceSpecification
for thisOfficeFloorSource
.void
sourceOfficeFloor(OfficeFloorDeployer deployer, OfficeFloorSourceContext context)
Sources theOfficeFloor
by deploying it via the inputOfficeFloorDeployer
.void
specifyConfigurationProperties(RequiredProperties requiredProperties, OfficeFloorSourceContext context)
Obtains from theOfficeFloorSource
any additionalProperty
instances required to source theOfficeFloor
after interrogating the configuration.
-
-
-
Method Detail
-
getSpecification
OfficeFloorSourceSpecification getSpecification()
Obtains the
OfficeFloorSourceSpecification
for thisOfficeFloorSource
.This enables the
OfficeFloorSourceContext
to be populated with the necessary details as per thisOfficeFloorSourceSpecification
in deploying theOfficeFloor
.- Returns:
OfficeFloorSourceSpecification
.
-
specifyConfigurationProperties
void specifyConfigurationProperties(RequiredProperties requiredProperties, OfficeFloorSourceContext context) throws java.lang.Exception
Obtains from the
OfficeFloorSource
any additionalProperty
instances required to source theOfficeFloor
after interrogating the configuration.This method is a separate initial step from the
sourceOfficeFloor(OfficeFloorDeployer, OfficeFloorSourceContext)
method to enable specifying any requiredProperty
instances once the necessaryConfigurationItem
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 theOfficeFloorSource
with any additionalProperty
instances required to source theOfficeFloor
.context
-OfficeFloorSourceContext
populated withProperty
instances as per theOfficeFloorSourceSpecification
.- Throws:
java.lang.Exception
- If fails to initialise theOfficeFloorSource
.
-
sourceOfficeFloor
void sourceOfficeFloor(OfficeFloorDeployer deployer, OfficeFloorSourceContext context) throws java.lang.Exception
Sources theOfficeFloor
by deploying it via the inputOfficeFloorDeployer
.- Parameters:
deployer
-OfficeFloorDeployer
to deploy theOfficeFloor
.context
-OfficeFloorSourceContext
populated with theProperty
instances as per theOfficeFloorSourceSpecification
andRequiredProperties
. Should there be a name clash between the two, theRequiredProperties
Property
will be used.- Throws:
java.lang.Exception
- If fails to source theOfficeFloor
.
-
-