| org.apache.catalina.Deployer
All known Subclasses: org.apache.catalina.core.StandardHost, org.apache.catalina.core.StandardHostDeployer,
| Deployer | | public interface Deployer (Code) | | 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.4 $ $Date: 2004/04/12 22:05:15 $ |
| Field Summary | |
| final public static String | INSTALL_EVENT
The ContainerEvent event type sent when a new application is
installed by install(), after it has been started. | | final public static String | PRE_INSTALL_EVENT
The ContainerEvent event type sent when a new application is
being installed by install(), before it has been
started. | | final public static String | REMOVE_EVENT
The ContainerEvent event type sent when an existing application is
removed by remove(). |
| Method Summary | |
| public Context | findDeployedApp(String contextPath)
Return the Context for the deployed application that is associated
with the specified context path (if any); otherwise return
null. | | public String[] | findDeployedApps()
Return the context paths of all deployed web applications in this
Container. | | public String | getName()
Return the name of the Container with which this Deployer is associated. | | public void | install(String contextPath, 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. | | public void | install(URL config, 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. | | public void | install(URL war)
Installs a new web application from the web application archive at the
specified URL, which must contain a META-INF/context.xml context
configuration file (consisting of a <Context>
element).
The web application is installed at the path specified inside the
embedded META-INF/context.xml. | | public boolean | isDeployXML()
Returns true if context.xml config files are supported. | | public void | remove(String contextPath)
Remove an existing web application, attached to the specified context
path. | | public void | remove(String contextPath, boolean undeploy)
Remove an existing web application, attached to the specified context
path. | | public void | start(String contextPath)
Start an existing web application, attached to the specified context
path. | | public void | stop(String contextPath)
Stop an existing web application, attached to the specified context
path. |
| INSTALL_EVENT | | final public static String INSTALL_EVENT(Code) | | The ContainerEvent event type sent when a new application is
installed by install(), after it has been started.
|
| PRE_INSTALL_EVENT | | final public static String PRE_INSTALL_EVENT(Code) | | The ContainerEvent event type sent when a new application is
being installed by install(), before it has been
started.
|
| REMOVE_EVENT | | final public static String REMOVE_EVENT(Code) | | The ContainerEvent event type sent when an existing application is
removed by remove().
|
| findDeployedApp | | public Context findDeployedApp(String contextPath)(Code) | | Return the Context for the deployed application that is associated
with the specified context path (if any); otherwise return
null.
Parameters:
contextPath - The context path of the requested web application |
| findDeployedApps | | public String[] findDeployedApps()(Code) | | Return the context paths of all deployed web applications in this
Container. If there are no deployed applications, a zero-length
array is returned.
|
| getName | | public String getName()(Code) | | Return the name of the Container with which this Deployer is associated.
|
| install | | public void install(String contextPath, URL war) throws IOException(Code) | | 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.
Parameters:
contextPath - The context path to which this application shouldbe installed (must be unique)
Parameters:
war - A URL of type "jar:" that points to a WAR file, or type"file:" that points to an unpacked directory structure containingthe web application to be installed
exception:
IllegalArgumentException - if the specified context pathis malformed (it must be "" or start with a slash)
exception:
IllegalStateException - if the specified context pathis already attached to an existing web application
exception:
IOException - if an input/output error was encounteredduring installation |
| install | | public void install(URL config, URL war) throws IOException(Code) | | 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.
Parameters:
config - A URL that points to the context configuration file tobe used for configuring the new Context
Parameters:
war - A URL of type "jar:" that points to a WAR file, or type"file:" that points to an unpacked directory structure containingthe web application to be installed
exception:
IllegalArgumentException - if one of the specified URLs isnull
exception:
IllegalStateException - if the context path specified in thecontext configuration file is already attached to an existing webapplication
exception:
IOException - if an input/output error was encounteredduring installation |
| install | | public void install(URL war) throws IOException(Code) | | Installs a new web application from the web application archive at the
specified URL, which must contain a META-INF/context.xml context
configuration file (consisting of a <Context>
element).
The web application is installed at the path specified inside the
embedded META-INF/context.xml. The docBase (if any) specified inside the
embedded META-INF/context.xml is overridden with the web application's
location.
If the installation succeeds, a ContainerEvent of type
INSTALL_EVENT is sent to all registered listeners,
with the newly created Context as its argument.
Parameters:
war - URL pointing to web application location (WAR-packaged orunpacked directory)
exception:
IllegalArgumentException - if war is null, or ifthe deployment host does not support any context.xmlconfiguration files
exception:
IllegalStateException - if the context path specified in thecontext configuration file is already in use by an existingweb application
exception:
IOException - if an input/output error was encounteredduring installation |
| isDeployXML | | public boolean isDeployXML()(Code) | | Returns true if context.xml config files are supported.
true of context.xml config files are supported, false otherwise |
| remove | | public void remove(String contextPath) throws IOException(Code) | | 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.
Parameters:
contextPath - The context path of the application to be removed
exception:
IllegalArgumentException - if the specified context pathis malformed (it must be "" or start with a slash)
exception:
IllegalArgumentException - if the specified context path doesnot identify a currently installed web application
exception:
IOException - if an input/output error occurs duringremoval |
| remove | | public void remove(String contextPath, boolean undeploy) throws IOException(Code) | | 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.
Parameters:
contextPath - The context path of the application to be removed
Parameters:
undeploy - boolean flag to remove web application from server
exception:
IllegalArgumentException - if the specified context pathis malformed (it must be "" or start with a slash)
exception:
IllegalArgumentException - if the specified context path doesnot identify a currently installed web application
exception:
IOException - if an input/output error occurs duringremoval |
| start | | public void start(String contextPath) throws IOException(Code) | | Start an existing web application, attached to the specified context
path. Only starts a web application if it is not running.
Parameters:
contextPath - The context path of the application to be started
exception:
IllegalArgumentException - if the specified context pathis malformed (it must be "" or start with a slash)
exception:
IllegalArgumentException - if the specified context path doesnot identify a currently installed web application
exception:
IOException - if an input/output error occurs duringstartup |
| stop | | public void stop(String contextPath) throws IOException(Code) | | Stop an existing web application, attached to the specified context
path. Only stops a web application if it is running.
Parameters:
contextPath - The context path of the application to be stopped
exception:
IllegalArgumentException - if the specified context pathis malformed (it must be "" or start with a slash)
exception:
IllegalArgumentException - if the specified context path doesnot identify a currently installed web application
exception:
IOException - if an input/output error occurs while stoppingthe web application |
|
|