Deployer (Catalina Internal API Documentation)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.
Field Summary | |
static java.lang.String |
INSTALL_EVENT
The ContainerEvent event type sent when a new application is installed by install() . |
static java.lang.String |
REMOVE_EVENT
The ContainerEvent event type sent when an existing application is removed by remove() . |
Fields inherited from interface org.apache.catalina.Container |
ADD_CHILD_EVENT, ADD_MAPPER_EVENT, ADD_VALVE_EVENT, REMOVE_CHILD_EVENT, REMOVE_MAPPER_EVENT, REMOVE_VALVE_EVENT |
Method Summary | |
Context |
findDeployedApp(java.lang.String contextPath)
Return the Context for the deployed application that is associated with the specified context path (if any); otherwise return null . |
java.lang.String[] |
findDeployedApps()
Return the context paths of all deployed web applications in this Container. |
void |
install(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. |
void |
remove(java.lang.String contextPath)
Remove an existing web application, attached to the specified context path. |
void |
start(java.lang.String contextPath)
Start an existing web application, attached to the specified context path. |
void |
stop(java.lang.String contextPath)
Stop an existing web application, attached to the specified context path. |
Methods inherited from interface org.apache.catalina.Container |
addChild, addContainerListener, addMapper, addPropertyChangeListener, findChild, findChildren, findMapper, findMappers, getCluster, getInfo, getLoader, getLogger, getManager, getName, getParent, getParentClassLoader, getRealm, getResources, invoke, map, removeChild, removeContainerListener, removeMapper, removePropertyChangeListener, setCluster, setLoader, setLogger, setManager, setName, setParent, setParentClassLoader, setRealm, setResources |
Field Detail |
public static final java.lang.String INSTALL_EVENT
install()
.
public static final java.lang.String REMOVE_EVENT
remove()
.
Method Detail |
public void install(java.lang.String contextPath, java.net.URL war) throws java.io.IOException
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.
contextPath
- The context path to which this application should
be installed (must be unique)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
java.lang.IllegalArgumentException
- if the specified context path
is malformed (it must be "" or start with a slash)
java.lang.IllegalArgumentException
- if the specified context path
is already attached to an existing web application
java.io.IOException
- if an input/output error was encountered
during installationpublic Context findDeployedApp(java.lang.String contextPath)
null
.
contextPath
- The context path of the requested web applicationpublic java.lang.String[] findDeployedApps()
public void remove(java.lang.String contextPath) throws java.io.IOException
REMOVE_EVENT
will be sent to all
registered listeners, with the removed Context
as
an argument.
contextPath
- The context path of the application to be removed
java.lang.IllegalArgumentException
- if the specified context path
is malformed (it must be "" or start with a slash)
java.lang.IllegalArgumentException
- if the specified context path does
not identify a currently installed web application
java.io.IOException
- if an input/output error occurs during
removalpublic void start(java.lang.String contextPath) throws java.io.IOException
contextPath
- The context path of the application to be started
java.lang.IllegalArgumentException
- if the specified context path
is malformed (it must be "" or start with a slash)
java.lang.IllegalArgumentException
- if the specified context path does
not identify a currently installed web application
java.io.IOException
- if an input/output error occurs during
startuppublic void stop(java.lang.String contextPath) throws java.io.IOException
contextPath
- The context path of the application to be stopped
java.lang.IllegalArgumentException
- if the specified context path
is malformed (it must be "" or start with a slash)
java.lang.IllegalArgumentException
- if the specified context path does
not identify a currently installed web application
java.io.IOException
- if an input/output error occurs while stopping
the web application
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |