Package org.apache.catalina.ha
Interface ClusterDeployer
- All Superinterfaces:
- ChannelListener
- All Known Implementing Classes:
- FarmWarDeployer
A ClusterDeployer interface allows to plug in and out the different deployment implementations
- 
Method SummaryModifier and TypeMethodDescriptionvoidcall from container Background ProcessReturns the cluster the cluster deployer is associated withvoidInstall 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 name.voidRemove an existing web application, attached to the specified context name.voidsetCluster(CatalinaCluster cluster) Associates the cluster deployer with a clustervoidstart()Start the cluster deployer, the owning container will invoke thisvoidstop()Stops the cluster deployer, the owning container will invoke thisMethods inherited from interface org.apache.catalina.tribes.ChannelListeneraccept, equals, hashCode, messageReceived
- 
Method Details- 
startStart the cluster deployer, the owning container will invoke this- Throws:
- Exception- - if failure to start cluster
 
- 
stopStops the cluster deployer, the owning container will invoke this- Throws:
- LifecycleException- Error stopping cluster deployer
 
- 
installInstall 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 name.If this application is successfully installed locally, a ContainerEvent of type INSTALL_EVENTwill be sent to all registered listeners, with the newly createdContextas an argument.- Parameters:
- contextName- The context name to which this application should be installed (must be unique)
- webapp- A WAR file or unpacked directory structure containing the web application to be installed
- Throws:
- IllegalArgumentException- if the specified context name is malformed
- IllegalStateException- if the specified context name is already attached to an existing web application
- IOException- if an input/output error was encountered during installation
 
- 
removeRemove an existing web application, attached to the specified context name. If this application is successfully removed, a ContainerEvent of typeREMOVE_EVENTwill be sent to all registered listeners, with the removedContextas an argument. Deletes the web application war file and/or directory if they exist in the Host's appBase.- Parameters:
- contextName- The context name of the application to be removed
- undeploy- boolean flag to remove web application from server
- Throws:
- IllegalArgumentException- if the specified context name is malformed
- IllegalArgumentException- if the specified context name does not identify a currently installed web application
- IOException- if an input/output error occurs during removal
 
- 
backgroundProcessvoid backgroundProcess()call from container Background Process
- 
getClusterCatalinaCluster getCluster()Returns the cluster the cluster deployer is associated with- Returns:
- CatalinaCluster
 
- 
setClusterAssociates the cluster deployer with a cluster- Parameters:
- cluster- CatalinaCluster
 
 
-