| javax.servlet.http.HttpServlet
 org.apache.catalina.servlets.ManagerServlet
All known Subclasses: org.apache.catalina.servlets.HTMLManagerServlet,
| ManagerServlet | | public class ManagerServlet extends HttpServlet implements ContainerServlet(Code) | | Servlet that enables remote management of the web applications installed
within the same virtual host as this web application is. Normally, this
functionality will be protected by a security constraint in the web
application deployment descriptor. However, this requirement can be
relaxed during testing.
This servlet examines the value returned by getPathInfo()
and related query parameters to determine what action is being requested.
The following actions and parameters (starting after the servlet path)
are supported:
- /install?config={config-url} - Install and start a new
web application, based on the contents of the context configuration
file found at the specified URL. The
docBase attribute
of the context configuration file is used to locate the actual
WAR or directory containing the application.
- /install?config={config-url}&war={war-url}/ - Install and start
a new web application, based on the contents of the context
configuration file found at
{config-url}, overriding the
docBase attribute with the contents of the web
application archive found at {war-url}.
- /install?path=/xxx&war={war-url} - Install and start a new
web application attached to context path
/xxx, based
on the contents of the web application archive found at the
specified URL.
- /list - List the context paths of all currently installed web
applications for this virtual host. Each context will be listed with
the following format
path:status:sessions.
Where path is the context path. Status is either running or stopped.
Sessions is the number of active Sessions.
- /reload?path=/xxx - Reload the Java classes and resources for
the application at the specified path, but do not reread the web.xml
configuration files.
- /remove?path=/xxx - Shutdown and remove the web application
attached to context path
/xxx for this virtual host.
- /resources?type=xxxx - Enumerate the available global JNDI
resources, optionally limited to those of the specified type
(fully qualified Java class name), if available.
- /roles - Enumerate the available security role names and
descriptions from the user database connected to the
users
resource reference.
- /sessions?path=/xxx - List session information about the web
application attached to context path
/xxx for this
virtual host.
- /start?path=/xxx - Start the web application attached to
context path
/xxx for this virtual host.
- /stop?path=/xxx - Stop the web application attached to
context path
/xxx for this virtual host.
- /undeploy?path=/xxx - Shutdown and remove the web application
attached to context path
/xxx for this virtual host,
and remove the underlying WAR file or document base directory.
(NOTE - This is only allowed if the WAR file or document
base is stored in the appBase directory of this host,
typically as a result of being placed there via the /deploy
command.
Use path=/ for the ROOT context.
The syntax of the URL for a web application archive must conform to one
of the following patterns to be successfully deployed:
- file:/absolute/path/to/a/directory - You can specify the absolute
path of a directory that contains the unpacked version of a web
application. This directory will be attached to the context path you
specify without any changes.
- jar:file:/absolute/path/to/a/warfile.war!/ - You can specify a
URL to a local web application archive file. The syntax must conform to
the rules specified by the
JarURLConnection class for a
reference to an entire JAR file.
- jar:http://hostname:port/path/to/a/warfile.war!/ - You can specify
a URL to a remote (HTTP-accessible) web application archive file. The
syntax must conform to the rules specified by the
JarURLConnection class for a reference to an entire
JAR file.
NOTE - Attempting to reload or remove the application containing
this servlet itself will not succeed. Therefore, this servlet should
generally be deployed as a separate web application within the virtual host
to be managed.
NOTE - For security reasons, this application will not operate
when accessed via the invoker servlet. You must explicitly map this servlet
with a servlet mapping, and you will always want to protect it with
appropriate security constraints as well.
The following servlet initialization parameters are recognized:
- debug - The debugging detail level that controls the amount
of information that is logged by this servlet. Default is zero.
author:
Craig R. McClanahan
version:
$Revision: 1.24 $ $Date: 2002/05/31 21:08:03 $ |
| Field Summary | |
| protected Context | context
The Context container associated with our web application. | | protected int | debug
The debugging detail level for this servlet. | | protected File | deployed
File object representing the directory into which the deploy() command
will store the WAR and context configuration files that have been
uploaded. | | protected Deployer | deployer
The Deployer container that contains our own web application's Context,
along with the associated Contexts for web applications that we
are managing. | | protected javax.naming.Context | global
The global JNDI NamingContext for this server,
if available. | | protected static StringManager | sm
The string manager for this package. | | protected Wrapper | wrapper
The Wrapper container associated with this servlet. |
| Method Summary | |
| protected synchronized void | deploy(PrintWriter writer, String path, HttpServletRequest request)
Deploy a web application archive (included in the current request)
at the specified context path. | | public void | destroy()
Finalize this servlet. | | public void | doGet(HttpServletRequest request, HttpServletResponse response)
Process a GET request for the specified resource. | | public void | doPut(HttpServletRequest request, HttpServletResponse response)
Process a PUT request for the specified resource. | | protected void | extractXml(File war, File xml)
Extract the context configuration file from the specified WAR,
if it is present. | | public Wrapper | getWrapper()
Return the Wrapper with which we are associated. | | public void | init()
Initialize this servlet. | | protected void | install(PrintWriter writer, String config, String path, String war)
Install an application for the specified path from the specified
web application archive. | | protected void | list(PrintWriter writer)
Render a list of the currently active Contexts in our virtual host. | | protected void | printResources(PrintWriter writer, String prefix, javax.naming.Context namingContext, String type, Class clazz)
List the resources of the given context. | | protected void | reload(PrintWriter writer, String path)
Reload the web application at the specified context path. | | protected void | remove(PrintWriter writer, String path)
Remove the web application at the specified context path. | | protected void | resources(PrintWriter writer, String type)
Render a list of available global JNDI resources. | | protected void | roles(PrintWriter writer)
Render a list of security role names (and corresponding descriptions)
from the org.apache.catalina.UserDatabase resource that is
connected to the users resource reference. | | protected void | sessions(PrintWriter writer, String path)
Session information for the web application at the specified context path. | | public void | setWrapper(Wrapper wrapper)
Set the Wrapper with which we are associated. | | protected void | start(PrintWriter writer, String path)
Start the web application at the specified context path. | | protected void | stop(PrintWriter writer, String path)
Stop the web application at the specified context path. | | protected void | undeploy(PrintWriter writer, String path)
Undeploy the web application at the specified context path. | | protected void | undeployDir(File dir)
Delete the specified directory, including all of its contents and
subdirectories recursively. | | protected void | uploadWar(HttpServletRequest request, File war)
Upload the WAR file included in this request, and store it at the
specified file location. |
| context | | protected Context context(Code) | | The Context container associated with our web application.
|
| debug | | protected int debug(Code) | | The debugging detail level for this servlet.
|
| deployed | | protected File deployed(Code) | | File object representing the directory into which the deploy() command
will store the WAR and context configuration files that have been
uploaded.
|
| deployer | | protected Deployer deployer(Code) | | The Deployer container that contains our own web application's Context,
along with the associated Contexts for web applications that we
are managing.
|
| wrapper | | protected Wrapper wrapper(Code) | | The Wrapper container associated with this servlet.
|
| deploy | | protected synchronized void deploy(PrintWriter writer, String path, HttpServletRequest request)(Code) | | Deploy a web application archive (included in the current request)
at the specified context path.
Parameters:
writer - Writer to render results to
Parameters:
path - Context path of the application to be installed
Parameters:
request - Servlet request we are processing |
| destroy | | public void destroy()(Code) | | Finalize this servlet.
|
| extractXml | | protected void extractXml(File war, File xml) throws IOException(Code) | | Extract the context configuration file from the specified WAR,
if it is present. If it is not present, ensure that the corresponding
file does not exist.
Parameters:
war - File object representing the WAR
Parameters:
xml - File object representing where to store the extractedcontext configuration file (if it exists)
exception:
IOException - if an i/o error occurs |
| getWrapper | | public Wrapper getWrapper()(Code) | | Return the Wrapper with which we are associated.
|
| install | | protected void install(PrintWriter writer, String config, String path, String war)(Code) | | Install an application for the specified path from the specified
web application archive.
Parameters:
writer - Writer to render results to
Parameters:
config - URL of the context configuration file to be installed
Parameters:
path - Context path of the application to be installed
Parameters:
war - URL of the web application archive to be installed |
| list | | protected void list(PrintWriter writer)(Code) | | Render a list of the currently active Contexts in our virtual host.
Parameters:
writer - Writer to render to |
| reload | | protected void reload(PrintWriter writer, String path)(Code) | | Reload the web application at the specified context path.
Parameters:
writer - Writer to render to
Parameters:
path - Context path of the application to be restarted |
| remove | | protected void remove(PrintWriter writer, String path)(Code) | | Remove the web application at the specified context path.
Parameters:
writer - Writer to render to
Parameters:
path - Context path of the application to be removed |
| resources | | protected void resources(PrintWriter writer, String type)(Code) | | Render a list of available global JNDI resources.
Parameters:
type - Fully qualified class name of the resource type of interest,or null to list resources of all types |
| roles | | protected void roles(PrintWriter writer)(Code) | | Render a list of security role names (and corresponding descriptions)
from the org.apache.catalina.UserDatabase resource that is
connected to the users resource reference. Typically, this
will be the global user database, but can be adjusted if you have
different user databases for different virtual hosts.
Parameters:
writer - Writer to render to |
| sessions | | protected void sessions(PrintWriter writer, String path)(Code) | | Session information for the web application at the specified context path.
Displays a profile of session MaxInactiveInterval timeouts listing number
of sessions for each 10 minute timeout interval up to 10 hours.
Parameters:
writer - Writer to render to
Parameters:
path - Context path of the application to list session information for |
| setWrapper | | public void setWrapper(Wrapper wrapper)(Code) | | Set the Wrapper with which we are associated.
Parameters:
wrapper - The new wrapper |
| start | | protected void start(PrintWriter writer, String path)(Code) | | Start the web application at the specified context path.
Parameters:
writer - Writer to render to
Parameters:
path - Context path of the application to be started |
| stop | | protected void stop(PrintWriter writer, String path)(Code) | | Stop the web application at the specified context path.
Parameters:
writer - Writer to render to
Parameters:
path - Context path of the application to be stopped |
| undeploy | | protected void undeploy(PrintWriter writer, String path)(Code) | | Undeploy the web application at the specified context path.
Parameters:
writer - Writer to render to
Parameters:
path - Context path of the application to be removed |
| undeployDir | | protected void undeployDir(File dir)(Code) | | Delete the specified directory, including all of its contents and
subdirectories recursively.
Parameters:
dir - File object representing the directory to be deleted |
| uploadWar | | protected void uploadWar(HttpServletRequest request, File war) throws IOException(Code) | | Upload the WAR file included in this request, and store it at the
specified file location.
Parameters:
request - The servlet request we are processing
Parameters:
file - The file into which we should store the uploaded WAR
exception:
IOException - if an I/O error occurs during processing |
| Methods inherited from javax.servlet.http.HttpServlet | protected void doDelete(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException(Code)(Java Doc)
protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException(Code)(Java Doc)
protected void doHead(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException(Code)(Java Doc)
protected void doOptions(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException(Code)(Java Doc)
protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException(Code)(Java Doc)
protected void doPut(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException(Code)(Java Doc)
protected void doTrace(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException(Code)(Java Doc)
protected long getLastModified(HttpServletRequest req)(Code)(Java Doc)
protected void service(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException(Code)(Java Doc)
public void service(ServletRequest req, ServletResponse res) throws ServletException, IOException(Code)(Java Doc)
|
|
|