org.codehaus.cargo.container.deployer
Interface Deployer

All Superinterfaces:
Loggable
All Known Implementing Classes:
AbstractCopyingInstalledLocalDeployer, AbstractDeployer, AbstractEmbeddedLocalDeployer, AbstractInstalledLocalDeployer, AbstractLocalDeployer, AbstractRemoteDeployer, AbstractSwitchableLocalDeployer

public interface Deployer
extends Loggable

API to manage all deployment aspects of Deployable: deploy, undeploy, start, stop and restart.

Version:
$Id: Deployer.java 1705 2008-09-02 13:14:55Z adriana $

Method Summary
 void deploy(Deployable deployable)
          Deploy a Deployable to the running container and make it available for requests.
 void deploy(Deployable deployable, DeployableMonitor monitor)
          Deploy a Deployable to the running container and make it available for requests.
 DeployerType getType()
           
 void redeploy(Deployable deployable)
          Redeploy a Deployable already deployed to the running container.
 void start(Deployable deployable)
          Starts a Deployable that is already deployed in the running container but that is not servicing requests.
 void stop(Deployable deployable)
          Stop a Deployable that is already deployed in the running container in order to prevent it from servicing requests.
 void undeploy(Deployable deployable)
          Undeploy a Deployable from the running container.
 void undeploy(Deployable deployable, DeployableMonitor monitor)
          Undeploy a Deployable to the running container.
 
Methods inherited from interface org.codehaus.cargo.util.log.Loggable
getLogger, setLogger
 

Method Detail

deploy

void deploy(Deployable deployable)
Deploy a Deployable to the running container and make it available for requests.

Parameters:
deployable - the Deployable to deploy

deploy

void deploy(Deployable deployable,
            DeployableMonitor monitor)
Deploy a Deployable to the running container and make it available for requests. Waits for the Deployable to be fully deployed before returning.

Parameters:
deployable - the Deployable to deploy
monitor - the monitor that checks for deployment status

undeploy

void undeploy(Deployable deployable)
Undeploy a Deployable from the running container. The service becomes unavailable for requests.

Parameters:
deployable - the Deployable to undeploy

undeploy

void undeploy(Deployable deployable,
              DeployableMonitor monitor)
Undeploy a Deployable to the running container. Waits for the Deployable to be fully undeployed before returning.

Parameters:
deployable - the Deployable to deploy
monitor - the monitor that checks for deployment status

redeploy

void redeploy(Deployable deployable)

Redeploy a Deployable already deployed to the running container. The service becomes available for requests.

Note that this method will be unsupported by the Deployers based on the AbstractCopyingInstalledLocalDeployer.

Parameters:
deployable - the Deployable to redeploy
See Also:
deploy(Deployable), undeploy(Deployable)

start

void start(Deployable deployable)
Starts a Deployable that is already deployed in the running container but that is not servicing requests.

Parameters:
deployable - the Deployable to start

stop

void stop(Deployable deployable)
Stop a Deployable that is already deployed in the running container in order to prevent it from servicing requests.

Parameters:
deployable - the Deployable to stop

getType

DeployerType getType()
Returns:
the deployer's type (local, remote, etc)


Copyright © 2004-2011 Codehaus. All Rights Reserved.