org.ow2.util.ee.deploy.api.deployer
Interface IDeployer<T extends IDeployable<T>>

public interface IDeployer<T extends IDeployable<T>>

Interface allowing to deploy/undeploy the IDeployable objects.

Author:

Florent Benoit

Method Summary

void	deploy(IDeployable<T> deployable) Deploy a deployable.
List<IDeploymentReport>	deploy(List<IDeployable<T>> deployables) Deploy deployables.
boolean	isDeployed(IDeployable<T> deployable) Checks if the given deployable is deployed or not.
boolean	supports(IDeployable<?> deployable) Checks if the given deployable is supported by the Deployer.
boolean	supports(List<IDeployable<?>> deployables) Checks if this deployable list is supported by the Deployer.
void	undeploy(IDeployable<T> deployable) Undeploy the given deployable.
List<IDeploymentReport>	undeploy(List<IDeployable<T>> deployables) Undeploy the list of deployable.

Method Detail

deploy

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

Deploy a deployable. It can be an EJB jar, EAR, WAR, etc.

Parameters:

deployable - a given deployable

Throws:

DeployerException - if the deployment is not done.

UnsupportedDeployerException - No deployer found for deployable.

undeploy

void undeploy(IDeployable<T> deployable)
              throws DeployerException

Undeploy the given deployable. It can be an EJB jar, EAR, WAR, etc.

Parameters:

deployable - a given deployable to undeploy

Throws:

DeployerException - if the undeploy operation fails.

isDeployed

boolean isDeployed(IDeployable<T> deployable)
                   throws DeployerException

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.

supports

boolean supports(IDeployable<?> deployable)

Checks if the given deployable is supported by the Deployer.

Parameters:

deployable - the deployable to be checked

Returns:

true if it is supported, else false.

deploy

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

Deploy deployables. It can be an EJB jar, EAR, WAR, etc. List of same type deployable object

Parameters:

deployables - List of deployables to deploy

Returns:

the list of IDeploymentReport

undeploy

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

Undeploy the list of deployable. It can be an EJB jar, EAR, WAR, etc.

Parameters:

deployables - List of deployable to undeploy

Returns:

the list of IDeploymentReport

supports

boolean supports(List<IDeployable<?>> deployables)

Checks if this deployable list is supported by the Deployer.

Parameters:

deployables - the list of deployable to be checked

Returns:

true if it is supported, else false.