org.codehaus.cargo.container.spi.deployer

Class AbstractCopyingInstalledLocalDeployer

java.lang.Object

org.codehaus.cargo.util.log.LoggedObject

org.codehaus.cargo.container.spi.deployer.AbstractDeployer

org.codehaus.cargo.container.spi.deployer.AbstractLocalDeployer

org.codehaus.cargo.container.spi.deployer.AbstractInstalledLocalDeployer

org.codehaus.cargo.container.spi.deployer.AbstractCopyingInstalledLocalDeployer

All Implemented Interfaces:

Deployer, Loggable

public abstract class AbstractCopyingInstalledLocalDeployer
extends AbstractInstalledLocalDeployer

Local deployer that deploys deployables to a deployable directory of the given installed container. Note that this deployer supports some expanded deployables by copying the expanded deployable to the deployable directory. In other words it does not support in-place expanded deployables (e.g. expanded WARs located in a different directory).

Version:

$Id: AbstractCopyingInstalledLocalDeployer.java 3707 2013-08-08 18:45:19Z alitokmen $

Constructor Summary

Constructors

Constructor and Description
AbstractCopyingInstalledLocalDeployer(InstalledLocalContainer container)

Method Summary

Methods

Modifier and Type	Method and Description
protected boolean	canBeDeployed(Deployable newDeployable) Checks whether the given Deployable can actually be deployed and whether a deployable has a web context path that already exist in another previously deployed Deployable.
void	deploy(Deployable deployable) Deploy a Deployable to the running container and make it available for requests.
protected void	doDeploy(String deployableDir, Deployable deployable) Do the actual deployment.
abstract String	getDeployableDir() Specifies the directory Deployables should be copied to.
protected String	getDeployableName(Deployable deployable) Gets the deployable name for the given deployable.
void	setShouldDeployExpanded(DeployableType type, boolean flag) Decide whether some expanded deployables of the specified type should be deployed or not.
protected boolean	shouldDeployExpanded(DeployableType type)

Methods inherited from class org.codehaus.cargo.container.spi.deployer.AbstractInstalledLocalDeployer

getType

Methods inherited from class org.codehaus.cargo.container.spi.deployer.AbstractLocalDeployer

getContainer, getFileHandler

Methods inherited from class org.codehaus.cargo.container.spi.deployer.AbstractDeployer

deploy, deploy, redeploy, redeploy, start, start, stop, stop, undeploy, undeploy

Methods inherited from class org.codehaus.cargo.util.log.LoggedObject

getLogger, setLogger

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.codehaus.cargo.util.log.Loggable

getLogger, setLogger

Constructor Detail

AbstractCopyingInstalledLocalDeployer

public AbstractCopyingInstalledLocalDeployer(InstalledLocalContainer container)

See Also:

AbstractInstalledLocalDeployer#AbstractInstalledLocalDeployer(org.codehaus.cargo.container.InstalledLocalContainer)

Method Detail

setShouldDeployExpanded

public void setShouldDeployExpanded(DeployableType type,
                           boolean flag)

Decide whether some expanded deployables of the specified type should be deployed or not. Some classes using this deployer may not want to deploy some expanded deployables, as they may want to deploy them in-situ by modifying the container's configuration file to point to the location of the expanded deployable. This saves some copying time and make it easier for development round-trips.

Parameters:

type - the deployable type

flag - whether expanded deployment of the specified deployment type should be allowed or not

shouldDeployExpanded

protected boolean shouldDeployExpanded(DeployableType type)

Parameters:

type - the deployable type

Returns:

whether expanded deployment of the specified deployment type should be done

deploy

public void deploy(Deployable deployable)

Deploy a Deployable to the running container and make it available for requests.

Specified by:

deploy in interface Deployer

Overrides:

deploy in class AbstractDeployer

Parameters:

deployable - the Deployable to deploy

See Also:

Deployer.deploy(Deployable)

canBeDeployed

protected boolean canBeDeployed(Deployable newDeployable)

Checks whether the given Deployable can actually be deployed and whether a deployable has a web context path that already exist in another previously deployed Deployable.

Parameters:

newDeployable - deployable

Returns:

true, if the deployable can be deployed

getDeployableDir

public abstract String getDeployableDir()

Specifies the directory Deployables should be copied to.

Returns:

Deployable directory

doDeploy

protected void doDeploy(String deployableDir,
            Deployable deployable)

Do the actual deployment. This can be overriden.

Parameters:

deployableDir - Directory in which to deploy.

deployable - Deployable to deploy.

getDeployableName

protected String getDeployableName(Deployable deployable)

Gets the deployable name for the given deployable.

Parameters:

deployable - Deployable to get the name for.

Returns:

Deployable name.