org.ow2.util.ee.deploy.api.deployer
Interface IDeployerManager

public interface IDeployerManager

Interface of Deployer Manager.

Author:

Florent BENOIT

Method Summary

void	addCallback(IDeployerManagerCallback callback) Add a new callback instance that will be invoked at each deployment/undeployment phase.
void	addCallback(IDeployerManagerReportCallback callback) Add a new callback instance that will be invoked at each deployment/undeployment phase.
void	deploy(IDeployable<?> deployable) Deploy a given deployable by finding the first deployer that accept this type of deployable.
List<IDeploymentReport>	deploy(List<IDeployable<?>> deployables) Deploy a list of multi type deployable by finding the first deployer that accept each type of deployable.
List<String>	getDeployerClasses()
boolean	isDeployed(IDeployable<?> deployable) Checks if the given deployable is deployed or not.
void	register(IDeployer deployer) Register a new Deployer on this manager instance.
void	removeCallback(IDeployerManagerCallback callback) Remove a callback instance.
void	removeCallback(IDeployerManagerReportCallback callback) Remove a callback instance.
void	undeploy(IDeployable<?> deployable) Undeploy a given deployable by finding the first deployer that accept this type of deployable.
List<IDeploymentReport>	undeploy(List<IDeployable<?>> deployables) Undeploy a list of multi type deployable by finding the first deployer that accept each type of deployable.
void	unregister(IDeployer deployer) Unregister a Deployer from this manager instance.

Method Detail

register

void register(IDeployer deployer)

Register a new Deployer on this manager instance.

Parameters:

deployer - the deployer to register

unregister

void unregister(IDeployer deployer)

Unregister a Deployer from this manager instance.

Parameters:

deployer - the given deployer to unregister.

deploy

void deploy(IDeployable<?> deployable)
            throws DeployerException,
                   UnsupportedDeployerException

Deploy a given deployable by finding the first deployer that accept this type of deployable.

Parameters:

deployable - the given deployable to deploy.

Throws:

DeployerException - if it cannot be undeployed.

UnsupportedDeployerException - if no deployer is found for the given deployable.

undeploy

void undeploy(IDeployable<?> deployable)
              throws DeployerException,
                     UnsupportedDeployerException

Undeploy a given deployable by finding the first deployer that accept this type of deployable.

Parameters:

deployable - the given deployable to undeploy.

Throws:

DeployerException - if it cannot be undeployed.

UnsupportedDeployerException - if no deployer is found for the given deployable.

isDeployed

boolean isDeployed(IDeployable<?> deployable)
                   throws DeployerException,
                          UnsupportedDeployerException

Checks if the given deployable is deployed or not.

Parameters:

deployable - test if a given deployable is already deployed.

Returns:

true if the given deployable is deployed.

Throws:

DeployerException - if the isDeployed operation fails.

UnsupportedDeployerException - if no deployer is found for the given deployable.

addCallback

void addCallback(IDeployerManagerCallback callback)

Add a new callback instance that will be invoked at each deployment/undeployment phase.

Parameters:

callback - The given callback

removeCallback

void removeCallback(IDeployerManagerCallback callback)

Remove a callback instance.

Parameters:

callback - The given callback

addCallback

void addCallback(IDeployerManagerReportCallback callback)

Add a new callback instance that will be invoked at each deployment/undeployment phase.

Parameters:

callback - The given callback

removeCallback

void removeCallback(IDeployerManagerReportCallback callback)

Remove a callback instance.

Parameters:

callback - The given callback

deploy

List<IDeploymentReport> deploy(List<IDeployable<?>> deployables)

Deploy a list of multi type deployable by finding the first deployer that accept each type of deployable.

Parameters:

deployables - the list of deployable to deploy.

Returns:

the list of IDeploymentReport

undeploy

List<IDeploymentReport> undeploy(List<IDeployable<?>> deployables)

Undeploy a list of multi type deployable by finding the first deployer that accept each type of deployable.

Parameters:

deployables - The list of deployable to undeploy.

Returns:

the list of IDeploymentReport

getDeployerClasses

List<String> getDeployerClasses()

Returns:

classnames of each IDeployer