FileDocCategorySizeDatePackage
Deployer.javaAPI DocGlassfish v2 API9798Fri May 04 22:31:52 BST 2007org.apache.catalina

Deployer

public interface Deployer
A Deployer is a specialized Container into which web applications can be deployed and undeployed. Such a Container will create and install child Context instances for each deployed application. The unique key for each web application will be the context path to which it is attached.
author
Craig R. McClanahan
version
$Revision: 1.3 $ $Date: 2007/05/05 05:31:51 $

Fields Summary
public static final String
PRE_INSTALL_EVENT
The ContainerEvent event type sent when a new application is being installed by install(), before it has been started.
public static final String
INSTALL_EVENT
The ContainerEvent event type sent when a new application is installed by install(), after it has been started.
public static final String
REMOVE_EVENT
The ContainerEvent event type sent when an existing application is removed by remove().
Constructors Summary
Methods Summary
public ContextfindDeployedApp(java.lang.String contextPath)
Return the Context for the deployed application that is associated with the specified context path (if any); otherwise return null.

param
contextPath The context path of the requested web application

public java.lang.String[]findDeployedApps()
Return the context paths of all deployed web applications in this Container. If there are no deployed applications, a zero-length array is returned.

public java.lang.StringgetName()
Return the name of the Container with which this Deployer is associated.

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 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, 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 voidinstall(java.net.URL config, java.net.URL war)

Install a new web application, whose context configuration file (consisting of a <Context> element) and web application archive are at the specified URLs.

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

param
config A URL that points to the context configuration file to be used for configuring the new Context
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 one of the specified URLs is null
exception
IllegalStateException if the context path specified in the context configuration file 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)
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.

param
contextPath The context path of the application to be removed
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 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 voidstart(java.lang.String contextPath)
Start an existing web application, attached to the specified context path. Only starts a web application if it is not running.

param
contextPath The context path of the application to be started
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 startup

public voidstop(java.lang.String contextPath)
Stop an existing web application, attached to the specified context path. Only stops a web application if it is running.

param
contextPath The context path of the application to be stopped
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 while stopping the web application