net.officefloor.autowire.impl

Class AutoWireOfficeFloorSource

java.lang.Object

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

net.officefloor.autowire.impl.AutoWireOfficeFloorSource

All Implemented Interfaces:

AutoWireApplication, OfficeFloorSource

Direct Known Subclasses:

WebApplicationAutoWireOfficeFloorSource

public class AutoWireOfficeFloorSource
extends AbstractOfficeFloorSource
implements AutoWireApplication

OfficeFloorSource implementation that auto-wires the configuration based on type.

To allow auto-wiring this implementation provides facades over the complexities of more advanced OfficeFloor configuration to allow simpler configuration. It is anticipated in the majority of cases that this will be adequate for most applications. Should however more flexibility be required then please use the OfficeFloorModelOfficeFloorSource.

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 and Description
AutoWireOfficeFloorSource() Default constructor.
AutoWireOfficeFloorSource(OfficeFloorCompiler compiler) Initiate.

Method Summary

Modifier and Type	Method and Description
AutoWireGovernance	addGovernance(String governanceName, String governanceSourceClassName) Adds Governance over the ManagedObject and object instances.
AutoWireObject	addManagedObject(String managedObjectSourceClassName, ManagedObjectSourceWirer wirer, AutoWire... autoWiring) Adds a ManagedObjectSource for dependency injection.
void	addObject(Object object, AutoWire... autoWiring) Adds a raw object for dependency injection.
AutoWireSection	addSection(String sectionName, String sectionSourceClassName, String sectionLocation) Adds an AutoWireSection.
<A extends AutoWireSection> A	addSection(String sectionName, String sectionSourceClassName, String sectionLocation, AutoWireSectionFactory<A> sectionFactory) Adds an AutoWireSection with the ability to override the AutoWireSection used.
void	addSectionTransformer(AutoWireSectionTransformer transformer) Adds a AutoWireSectionTransformer.
void	addStartupFlow(AutoWireSection section, String inputName) Adds a flow to be triggered on start-up.
AutoWireSupplier	addSupplier(String supplierSourceClassName) Adds a SupplierSource to provide ManagedObject instances for dependency injection.
AutoWireTeam	assignDefaultTeam(String teamSourceClassName) Assigns a Team responsible for unassigned Task instances.
AutoWireTeam	assignTeam(String teamSourceClassName, AutoWire... autoWiring) Assigns a Team responsible for: Task dependent on the specified object types Governance with the extension interface object type
static AutoWire	getAppropriateAutoWire(String qualifier, String type, Collection<AutoWire> availableAutoWiring) Obtains the appropriate available AutoWire.
OfficeFloorCompiler	getOfficeFloorCompiler() Obtains the OfficeFloorCompiler being used.
AutoWireSection	getSection(String sectionName) Obtains the AutoWireSection by its name.
protected void	initOfficeFloor(OfficeFloorDeployer deployer, OfficeFloorSourceContext context) Allows overriding for initialising the OfficeFloor before auto-wiring.
boolean	isLinked(AutoWireSection section, String sectionOutputName) Determines if the AutoWireSection output is configured for linking.
boolean	isObjectAvailable(AutoWire autoWire) Indicates if the AutoWireObject is already configured for the AutoWire.
void	link(AutoWireSection sourceSection, String sourceOutputName, AutoWireSection targetSection, String targetInputName) Links the source SectionOutput to a target SectionInput.
void	linkEscalation(Class<? extends Throwable> escalation, AutoWireSection section, String inputName) Links the Escalation to be handled by the OfficeSectionInput.
protected void	loadSpecification(AbstractOfficeFloorSource.SpecificationContext context) Loads the OfficeFloorSourceSpecification.
AutoWireOfficeFloor	openOfficeFloor() Opens the AutoWireOfficeFloor.
void	setProfiler(Profiler profiler) Specifies the Profiler.
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

AutoWireOfficeFloorSource

public AutoWireOfficeFloorSource(OfficeFloorCompiler compiler)

Initiate.

Parameters:

compiler - OfficeFloorCompiler.

AutoWireOfficeFloorSource

public AutoWireOfficeFloorSource()

Default constructor.

Method Detail

getAppropriateAutoWire

public static AutoWire getAppropriateAutoWire(String qualifier,
                                              String type,
                                              Collection<AutoWire> availableAutoWiring)

Obtains the appropriate available AutoWire.

Parameters:

qualifier - Qualifier. May be null.

type - Type.

availableAutoWiring - Available AutoWire instances to select from.

Returns:

Appropriate available AutoWire or null if no appropriate matching AutoWire.

initOfficeFloor

protected void initOfficeFloor(OfficeFloorDeployer deployer,
                               OfficeFloorSourceContext context)
                        throws Exception

Allows overriding for initialising the OfficeFloor before auto-wiring.

Parameters:

deployer - OfficeFloorDeployer.

context - OfficeFloorSourceContext.

Throws:

Exception - If fails to initialise.

getOfficeFloorCompiler

public OfficeFloorCompiler getOfficeFloorCompiler()

Description copied from interface: AutoWireApplication

Obtains the OfficeFloorCompiler being used.

This allows manipulation of the OfficeFloorCompiler before auto-wiring to compile and open the OfficeFloor.

Specified by:

getOfficeFloorCompiler in interface AutoWireApplication

Returns:

OfficeFloorCompiler being used.

addSection

public AutoWireSection addSection(String sectionName,
                                  String sectionSourceClassName,
                                  String sectionLocation)

Description copied from interface: AutoWireApplication

Adds an AutoWireSection.

Specified by:

addSection in interface AutoWireApplication

Parameters:

sectionName - Name of the OfficeSection.

sectionSourceClassName - Class name of the SectionSource. May be an alias.

sectionLocation - OfficeSection location.

Returns:

AutoWireSection to configure properties and link flows.

addSection

public <A extends AutoWireSection> A addSection(String sectionName,
                                                String sectionSourceClassName,
                                                String sectionLocation,
                                                AutoWireSectionFactory<A> sectionFactory)

Description copied from interface: AutoWireApplication

Adds an AutoWireSection with the ability to override the AutoWireSection used.

Specified by:

addSection in interface AutoWireApplication

Type Parameters:

A - AutoWireSection type.

Parameters:

sectionName - Name of the OfficeSection.

sectionSourceClassName - Class name of the SectionSource. May be an alias.

sectionLocation - OfficeSection location.

sectionFactory - AutoWireSectionFactory to allow overriding the AutoWireSection utilised.

Returns:

Overridden AutoWireSection to configure properties and link flows.

getSection

public AutoWireSection getSection(String sectionName)

Description copied from interface: AutoWireApplication

Obtains the AutoWireSection by its name.

This is useful to obtain an existing AutoWireSection to link to.

Specified by:

getSection in interface AutoWireApplication

Parameters:

sectionName - Name of the AutoWireSection.

Returns:

AutoWireSection or null if not AutoWireSection by the name.

addSectionTransformer

public void addSectionTransformer(AutoWireSectionTransformer transformer)

Description copied from interface: AutoWireApplication

Adds a AutoWireSectionTransformer.

Specified by:

addSectionTransformer in interface AutoWireApplication

Parameters:

transformer - AutoWireSectionTransformer.

link

public void link(AutoWireSection sourceSection,
                 String sourceOutputName,
                 AutoWireSection targetSection,
                 String targetInputName)

Description copied from interface: AutoWireApplication

Links the source SectionOutput to a target SectionInput.

Specified by:

link in interface AutoWireApplication

Parameters:

sourceSection - Source section.

sourceOutputName - Name of the source SectionOutput.

targetSection - Target section.

targetInputName - Name of the target SectionInput.

isLinked

public boolean isLinked(AutoWireSection section,
                        String sectionOutputName)

Description copied from interface: AutoWireApplication

Determines if the AutoWireSection output is configured for linking.

This aids configuration by allowing to know if SectionOutput flows have been configured (linked).

Specified by:

isLinked in interface AutoWireApplication

Parameters:

section - AutoWireSection.

sectionOutputName - SectionOutput name.

Returns:

true if configured for linking, otherwise false.

linkEscalation

public void linkEscalation(Class<? extends Throwable> escalation,
                           AutoWireSection section,
                           String inputName)

Description copied from interface: AutoWireApplication

Links the Escalation to be handled by the OfficeSectionInput.

Specified by:

linkEscalation in interface AutoWireApplication

Parameters:

escalation - Escalation.

section - AutoWireSection.

inputName - Name of the AutoWireSection input.

addStartupFlow

public void addStartupFlow(AutoWireSection section,
                           String inputName)

Description copied from interface: AutoWireApplication

Adds a flow to be triggered on start-up.

Specified by:

addStartupFlow in interface AutoWireApplication

Parameters:

section - AutoWireSection.

inputName - Name of the AutoWireSection input to trigger on start-up.

addObject

public void addObject(Object object,
                      AutoWire... autoWiring)

Description copied from interface: AutoWireApplication

Adds a raw object for dependency injection.

Specified by:

addObject in interface AutoWireApplication

Parameters:

object - Object implementing the type to be dependency injected.

autoWiring - AutoWire matches that the object is to provide dependency injection. Should no AutoWire instances be provided the type is defaulted from the object without a qualifier.

addManagedObject

public AutoWireObject addManagedObject(String managedObjectSourceClassName,
                                       ManagedObjectSourceWirer wirer,
                                       AutoWire... autoWiring)

Description copied from interface: AutoWireApplication

Adds a ManagedObjectSource for dependency injection.

Specified by:

addManagedObject in interface AutoWireApplication

Parameters:

managedObjectSourceClassName - Class name of the ManagedObjectSource. May be an alias.

wirer - ManagedObjectSourceWirer to assist in configuring the ManagedObjectSource. May be null if no assistance is required.

autoWiring - AutoWire matches that the ManagedObjectSource is to provide dependency injection. At least one AutoWire must be provided.

Returns:

AutoWireObject for the ManagedObjectSource.

addSupplier

public AutoWireSupplier addSupplier(String supplierSourceClassName)

Description copied from interface: AutoWireApplication

Adds a SupplierSource to provide ManagedObject instances for dependency injection.

Specified by:

addSupplier in interface AutoWireApplication

Parameters:

supplierSourceClassName - Class name of the SupplierSource. May be an alias.

Returns:

AutoWireSupplier.

isObjectAvailable

public boolean isObjectAvailable(AutoWire autoWire)

Description copied from interface: AutoWireApplication

Indicates if the AutoWireObject is already configured for the AutoWire.

Specified by:

isObjectAvailable in interface AutoWireApplication

Parameters:

autoWire - AutoWire to determine if available (configured).

Returns:

true if an AutoWireObject has been configured for the AutoWire.

addGovernance

public AutoWireGovernance addGovernance(String governanceName,
                                        String governanceSourceClassName)

Description copied from interface: AutoWireApplication

Adds Governance over the ManagedObject and object instances.

Specified by:

addGovernance in interface AutoWireApplication

Parameters:

governanceName - Name of the Governance.

governanceSourceClassName - Class name of the GovernanceSource. May be an alias.

Returns:

AutoWireGovernance.

assignTeam

public AutoWireTeam assignTeam(String teamSourceClassName,
                               AutoWire... autoWiring)

Description copied from interface: AutoWireApplication

Assigns a Team responsible for:

1. Task dependent on the specified object types
2. Governance with the extension interface object type

Specified by:

assignTeam in interface AutoWireApplication

Parameters:

teamSourceClassName - Class name of the TeamSource. May be an alias.

autoWiring - AutoWire instances to identify dependent Task object types and Governance extension interfaces the Team is responsible for. Must have at least one AutoWire provided.

Returns:

AutoWireTeam.

assignDefaultTeam

public AutoWireTeam assignDefaultTeam(String teamSourceClassName)

Description copied from interface: AutoWireApplication

Assigns a Team responsible for unassigned Task instances.

Specified by:

assignDefaultTeam in interface AutoWireApplication

Parameters:

teamSourceClassName - Class name of the TeamSource. May be an alias.

Returns:

AutoWireTeam.

setProfiler

public void setProfiler(Profiler profiler)

Description copied from interface: AutoWireApplication

Specifies the Profiler.

Specified by:

setProfiler in interface AutoWireApplication

Parameters:

profiler - Profiler.

openOfficeFloor

public AutoWireOfficeFloor openOfficeFloor()
                                    throws Exception

Description copied from interface: AutoWireApplication

Opens the AutoWireOfficeFloor.

Specified by:

openOfficeFloor in interface AutoWireApplication

Returns:

AutoWireOfficeFloor.

Throws:

Exception - If fails to open the AutoWireOfficeFloor.

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.

Specified by:

specifyConfigurationProperties in interface OfficeFloorSource

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.

Specified by:

sourceOfficeFloor in interface OfficeFloorSource

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.