net.officefloor.compile.spi.officefloor
Interface OfficeFloorDeployer

All Known Subinterfaces:

OfficeFloorNode

All Known Implementing Classes:

OfficeFloorNodeImpl

public interface OfficeFloorDeployer

Deploys the OfficeFloor.

Author:

Daniel Sagenschneider

Method Summary

DeployedOffice	addDeployedOffice(String officeName, OfficeSource officeSource, String officeLocation) Adds a DeployedOffice to the OfficeFloor.
DeployedOffice	addDeployedOffice(String officeName, String officeSourceClassName, String officeLocation) Adds a DeployedOffice to the OfficeFloor.
OfficeFloorInputManagedObject	addInputManagedObject(String inputManagedObjectName) Adds an OfficeFloorInputManagedObject.
void	addIssue(String issueDescription, OfficeFloorIssues.AssetType assetType, String assetName) Allows the OfficeFloorSource to add an issue in attempting to deploy the OfficeFloor.
void	addIssue(String issueDescription, Throwable cause, OfficeFloorIssues.AssetType assetType, String assetName) Allows the OfficeFloorSource to add an issue along with its cause in attempting to deploy the OfficeFloor.
OfficeFloorManagedObjectSource	addManagedObjectSource(String managedObjectSourceName, ManagedObjectSource<?,?> managedObjectSource) Adds an OfficeFloorManagedObjectSource.
OfficeFloorManagedObjectSource	addManagedObjectSource(String managedObjectSourceName, String managedObjectSourceClassName) Adds an OfficeFloorManagedObjectSource.
OfficeFloorSupplier	addSupplier(String supplierName, String supplierSourceClassName) Adds an OfficeFloorSupplier.
OfficeFloorTeam	addTeam(String teamName, String teamSourceClassName) Adds a Team.
void	link(ManagedObjectDependency dependency, OfficeFloorInputManagedObject inputManagedObject) Links the ManagedObjectDependency to be the OfficeFloorInputManagedObject.
void	link(ManagedObjectDependency dependency, OfficeFloorManagedObject managedObject) Links the ManagedObjectDependency to be the OfficeFloorManagedObject.
void	link(ManagedObjectFlow flow, DeployedOfficeInput input) Links the ManagedObjectFlow to be undertaken by the DeployedOfficeInput.
void	link(ManagedObjectTeam team, OfficeFloorTeam officeFloorTeam) Links the ManagedObjectTeam to be the OfficeFloorTeam.
void	link(ManagingOffice managingOffice, DeployedOffice office) Links the ManagingOffice to be managed by the DeployedOffice.
void	link(OfficeFloorManagedObjectSource managedObjectSource, OfficeFloorInputManagedObject inputManagedObject) Links the OfficeFloorInputManagedObject to be input by the OfficeFloorManagedObjectSource.
void	link(OfficeObject officeObject, OfficeFloorInputManagedObject inputManagedObject) Links the OfficeObject to be the OfficeFloorInputManagedObject.
void	link(OfficeObject officeObject, OfficeFloorManagedObject managedObject) Links the OfficeObject to be the OfficeFloorManagedObject .
void	link(OfficeTeam team, OfficeFloorTeam officeFloorTeam) Links the OfficeTeam to be the OfficeFloorTeam.

Method Detail

addTeam

OfficeFloorTeam addTeam(String teamName,
                        String teamSourceClassName)

Adds a Team.

Parameters:

teamName - Name of the Team.

teamSourceClassName - Fully qualified class name of the TeamSource.

Returns:

Added OfficeFloorTeam.

addManagedObjectSource

OfficeFloorManagedObjectSource addManagedObjectSource(String managedObjectSourceName,
                                                      String managedObjectSourceClassName)

Adds an OfficeFloorManagedObjectSource.

Parameters:

managedObjectSourceName - Name of the OfficeFloorManagedObjectSource.

managedObjectSourceClassName - Fully qualified class name of the ManagedObjectSource.

Returns:

Added OfficeFloorManagedObjectSource.

addManagedObjectSource

OfficeFloorManagedObjectSource addManagedObjectSource(String managedObjectSourceName,
                                                      ManagedObjectSource<?,?> managedObjectSource)

Adds an OfficeFloorManagedObjectSource.

Parameters:

managedObjectSourceName - Name of the OfficeFloorManagedObjectSource.

managedObjectSource - ManagedObjectSource instance to use.

Returns:

Added OfficeFloorManagedObjectSource.

addInputManagedObject

OfficeFloorInputManagedObject addInputManagedObject(String inputManagedObjectName)

Adds an OfficeFloorInputManagedObject.

Parameters:

inputManagedObjectName - Name of the OfficeFloorInputManagedObject.

Returns:

Added OfficeFloorInputManagedObject.

addSupplier

OfficeFloorSupplier addSupplier(String supplierName,
                                String supplierSourceClassName)

Adds an OfficeFloorSupplier.

Please note there is no AutoWire functionality and this is only provided to allow OfficeFloorSource implementations to take advantage of a SupplierSource.

Parameters:

supplierName - Name of the OfficeFloorSupplier.

supplierSourceClassName - Fully qualified class name of the SupplierSource.

Returns:

OfficeFloorSupplier.

See Also:

AutoWireApplication

addDeployedOffice

DeployedOffice addDeployedOffice(String officeName,
                                 String officeSourceClassName,
                                 String officeLocation)

Adds a DeployedOffice to the OfficeFloor.

Parameters:

officeName - Name of the Office.

officeSourceClassName - Fully qualified class name of the OfficeSource.

officeLocation - Location of the Office.

Returns:

DeployedOffice.

addDeployedOffice

DeployedOffice addDeployedOffice(String officeName,
                                 OfficeSource officeSource,
                                 String officeLocation)

Adds a DeployedOffice to the OfficeFloor.

Parameters:

officeName - Name of the Office.

officeSource - OfficeSource instance.

officeLocation - Location of the Office.

Returns:

DeployedOffice.

link

void link(ManagedObjectTeam team,
          OfficeFloorTeam officeFloorTeam)

Links the ManagedObjectTeam to be the OfficeFloorTeam.

Parameters:

team - ManagedObjectTeam.

officeFloorTeam - OfficeFloorTeam.

link

void link(OfficeFloorManagedObjectSource managedObjectSource,
          OfficeFloorInputManagedObject inputManagedObject)

Links the OfficeFloorInputManagedObject to be input by the OfficeFloorManagedObjectSource.

Parameters:

managedObjectSource - OfficeFloorManagedObjectSource.

inputManagedObject - OfficeFloorInputManagedObject.

link

void link(ManagedObjectDependency dependency,
          OfficeFloorManagedObject managedObject)

Links the ManagedObjectDependency to be the OfficeFloorManagedObject.

Parameters:

dependency - ManagedObjectDependency.

managedObject - OfficeFloorManagedObject.

link

void link(ManagedObjectDependency dependency,
          OfficeFloorInputManagedObject inputManagedObject)

Links the ManagedObjectDependency to be the OfficeFloorInputManagedObject.

Parameters:

dependency - ManagedObjectDependency.

inputManagedObject - OfficeFloorInputManagedObject.

link

void link(ManagedObjectFlow flow,
          DeployedOfficeInput input)

Links the ManagedObjectFlow to be undertaken by the DeployedOfficeInput.

Parameters:

flow - ManagedObjectFlow.

input - DeployedOfficeInput.

link

void link(ManagingOffice managingOffice,
          DeployedOffice office)

Links the ManagingOffice to be managed by the DeployedOffice.

Parameters:

managingOffice - ManagingOffice.

office - DeployedOffice.

link

void link(OfficeTeam team,
          OfficeFloorTeam officeFloorTeam)

Links the OfficeTeam to be the OfficeFloorTeam.

Parameters:

team - OfficeTeam.

officeFloorTeam - OfficeFloorTeam.

link

void link(OfficeObject officeObject,
          OfficeFloorManagedObject managedObject)

Links the OfficeObject to be the OfficeFloorManagedObject .

Parameters:

officeObject - OfficeObject.

managedObject - OfficeFloorManagedObject.

link

void link(OfficeObject officeObject,
          OfficeFloorInputManagedObject inputManagedObject)

Links the OfficeObject to be the OfficeFloorInputManagedObject.

Parameters:

officeObject - OfficeObject.

inputManagedObject - OfficeFloorInputManagedObject.

addIssue

void addIssue(String issueDescription,
              OfficeFloorIssues.AssetType assetType,
              String assetName)

Allows the OfficeFloorSource to add an issue in attempting to deploy the OfficeFloor.

This is available to report invalid configuration but continue to deploy the rest of the OfficeFloor.

Parameters:

issueDescription - Description of the issue.

assetType - OfficeFloorIssues.AssetType. May be null if OfficeFloor in general.

assetName - Name of the Asset. May be null if OfficeFloor in general.

addIssue

void addIssue(String issueDescription,
              Throwable cause,
              OfficeFloorIssues.AssetType assetType,
              String assetName)

Allows the OfficeFloorSource to add an issue along with its cause in attempting to deploy the OfficeFloor.

This is available to report invalid configuration but continue to deploy the rest of the OfficeFloor.

Parameters:

issueDescription - Description of the issue.

cause - Cause of the issue.

assetType - OfficeFloorIssues.AssetType. May be null if OfficeFloor in general.

assetName - Name of the Asset. May be null if OfficeFloor in general.