FileDocCategorySizeDatePackage
ClusterDeployer.javaAPI DocApache Tomcat 6.0.144897Fri Jul 20 04:20:34 BST 2007org.apache.catalina.ha

ClusterDeployer

public interface ClusterDeployer implements org.apache.catalina.tribes.ChannelListener
A ClusterDeployer interface allows to plug in and out the different deployment implementations
author
Filip Hanik
version
$Revision: 467222 $, $Date: 2006-10-24 05:17:11 +0200 (mar., 24 oct. 2006) $

Fields Summary
public String
info
Descriptive information about this component implementation.
Constructors Summary
Methods Summary
public voidbackgroundProcess()
call from container Background Process

public CatalinaClustergetCluster()
Returns the cluster the cluster deployer is associated with

return
CatalinaCluster

public voidinstall(java.lang.String contextPath, java.net.URL war)
Install a new web application, whose web application archive is at the specified URL, into this container and all the other members of the cluster with the specified context path. A context path of "" (the empty string) should be used for the root application for this container. Otherwise, the context path must start with a slash.

If this application is successfully installed locally, a ContainerEvent of type INSTALL_EVENT will be sent to all registered listeners, with the newly created Context as an argument.

param
contextPath The context path to which this application should be installed (must be unique)
param
war A URL of type "jar:" that points to a WAR file, or type "file:" that points to an unpacked directory structure containing the web application to be installed
exception
IllegalArgumentException if the specified context path is malformed (it must be "" or start with a slash)
exception
IllegalStateException if the specified context path is already attached to an existing web application
exception
IOException if an input/output error was encountered during installation

public voidremove(java.lang.String contextPath, boolean undeploy)
Remove an existing web application, attached to the specified context path. If this application is successfully removed, a ContainerEvent of type REMOVE_EVENT will be sent to all registered listeners, with the removed Context as an argument. Deletes the web application war file and/or directory if they exist in the Host's appBase.

param
contextPath The context path of the application to be removed
param
undeploy boolean flag to remove web application from server
exception
IllegalArgumentException if the specified context path is malformed (it must be "" or start with a slash)
exception
IllegalArgumentException if the specified context path does not identify a currently installed web application
exception
IOException if an input/output error occurs during removal

public voidsetCluster(CatalinaCluster cluster)
Associates the cluster deployer with a cluster

param
cluster CatalinaCluster

public voidstart()
Start the cluster deployer, the owning container will invoke this

throws
Exception - if failure to start cluster

public voidstop()
Stops the cluster deployer, the owning container will invoke this

throws
LifecycleException