ManagerServlet (Apache Tomcat 8.0.15 API Documentation)

java.lang.Object
- javax.servlet.GenericServlet
- - javax.servlet.http.HttpServlet
  - - org.apache.catalina.manager.ManagerServlet

All Implemented Interfaces:

Serializable, Servlet, ServletConfig, ContainerServlet

Direct Known Subclasses:

HTMLManagerServlet
```
public class ManagerServlet
extends HttpServlet
implements ContainerServlet
```
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:
- /deploy?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.
- /deploy?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}.
- /deploy?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.
- /resources?type=xxxx - Enumerate the available global JNDI resources, optionally limited to those of the specified type (fully qualified Java class name), if available.
- /serverinfo - Display system OS and JVM properties.
- /sessions - Deprecated. Use expire.
- /expire?path=/xxx - List session idle timeinformation about the web application attached to context path /xxx for this virtual host.
- /expire?path=/xxx&idle=mm - Expire sessions for the context path /xxx which were idle for at least mm minutes.
- /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.
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, Remy Maucherat

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected File`	`configBase` Path where context descriptors should be deployed.
`protected Context`	`context` The Context container associated with our web application.
`protected int`	`debug` The debugging detail level for this servlet.
`protected Context`	`global` The global JNDI `NamingContext` for this server, if available.
`protected Host`	`host` The associated host.
`protected MBeanServer`	`mBeanServer` MBean server.
`protected ObjectName`	`oname` The associated deployer ObjectName.
`protected static StringManager`	`sm` The string manager for this package.
`protected File`	`versioned` Path used to store revisions of webapps.
`protected Wrapper`	`wrapper` The Wrapper container associated with this servlet.

Constructor Summary

Constructors
Constructor and Description

ManagerServlet()

Constructors
Constructor and Description
`ManagerServlet()`

Method Summary

Methods
Modifier and Type	Method and Description
`protected void`	`addServiced(String name)` Invoke the addServiced method on the deployer.
`protected void`	`check(String name)` Invoke the check method on the deployer.
`static boolean`	`copy(File src, File dest)` Copy the specified file or directory to the destination.
`static boolean`	`copyInternal(File src, File dest, byte[] buf)` Copy the specified file or directory to the destination.
`protected void`	`deploy(PrintWriter writer, ContextName cn, String tag, boolean update, HttpServletRequest request, StringManager smClient)` Deploy a web application archive (included in the current request) at the specified context path.
`protected void`	`deploy(PrintWriter writer, ContextName cn, String tag, StringManager smClient)` Install an application for the specified path from the specified web application archive.
`protected void`	`deploy(PrintWriter writer, String config, ContextName cn, String war, boolean update, StringManager smClient)` Install an application for the specified path from the specified web application archive.
`void`	`destroy()` Finalize this servlet.
`void`	`doGet(HttpServletRequest request, HttpServletResponse response)` Process a GET request for the specified resource.
`void`	`doPut(HttpServletRequest request, HttpServletResponse response)` Process a PUT request for the specified resource.
`protected void`	`expireSessions(PrintWriter writer, ContextName cn, HttpServletRequest req, StringManager smClient)` Extract the expiration request parameter
`protected void`	`findleaks(boolean statusLine, PrintWriter writer, StringManager smClient)` Find potential memory leaks caused by web application reload.
`protected Map<String,Set<String>>`	`getConnectorCiphers()`
`Wrapper`	`getWrapper()` Return the Wrapper with which we are associated.
`void`	`init()` Initialize this servlet.
`protected boolean`	`isDeployed(String name)` Invoke the isDeployed method on the deployer.
`protected boolean`	`isServiced(String name)` Invoke the isServiced method on the deployer.
`protected void`	`list(PrintWriter writer, StringManager smClient)` Render a list of the currently active Contexts in our virtual host.
`protected void`	`printResources(PrintWriter writer, String prefix, Context namingContext, String type, Class<?> clazz, StringManager smClient)` List the resources of the given context.
`protected void`	`reload(PrintWriter writer, ContextName cn, StringManager smClient)` Reload the web application at the specified context path.
`protected void`	`removeServiced(String name)` Invoke the removeServiced method on the deployer.
`protected void`	`resources(PrintWriter writer, String type, StringManager smClient)` Render a list of available global JNDI resources.
`protected void`	`save(PrintWriter writer, String path, StringManager smClient)` Store server configuration.
`protected void`	`serverinfo(PrintWriter writer, StringManager smClient)` Writes System OS and JVM properties.
`protected void`	`sessions(PrintWriter writer, ContextName cn, int idle, StringManager smClient)` Session information for the web application at the specified context path.
`void`	`setWrapper(Wrapper wrapper)` Set the Wrapper with which we are associated.
`protected void`	`sslConnectorCiphers(PrintWriter writer, StringManager smClient)`
`protected void`	`start(PrintWriter writer, ContextName cn, StringManager smClient)` Start the web application at the specified context path.
`protected void`	`stop(PrintWriter writer, ContextName cn, StringManager smClient)` Stop the web application at the specified context path.
`protected void`	`threadDump(PrintWriter writer, Enumeration<Locale> requestedLocales)` Write a JVM thread dump
`protected void`	`undeploy(PrintWriter writer, ContextName cn, StringManager smClient)` Undeploy the web application at the specified context path.
`protected boolean`	`undeployDir(File dir)` Delete the specified directory, including all of its contents and subdirectories recursively.
`protected void`	`uploadWar(PrintWriter writer, HttpServletRequest request, File war, StringManager smClient)` Upload the WAR file included in this request, and store it at the specified file location.
`protected static boolean`	`validateContextName(ContextName cn, PrintWriter writer, StringManager sm)`
`protected void`	`vmInfo(PrintWriter writer, Enumeration<Locale> requestedLocales)` Write some VM info

Methods inherited from class javax.servlet.http.HttpServlet
doDelete, doHead, doOptions, doPost, doTrace, getLastModified, service, service

Methods inherited from class javax.servlet.GenericServlet
getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, log, log

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - configBase
```
protected File configBase
```
    Path where context descriptors should be deployed.
  - context
```
protected transient Context context
```
    The Context container associated with our web application.
  - debug
```
protected int debug
```
    The debugging detail level for this servlet.
  - versioned
```
protected File versioned
```
    Path used to store revisions of webapps.
  - host
```
protected transient Host host
```
    The associated host.
  - mBeanServer
```
protected transient MBeanServer mBeanServer
```
    MBean server.
  - oname
```
protected ObjectName oname
```
    The associated deployer ObjectName.
  - global
```
protected transient Context global
```
    The global JNDI NamingContext for this server, if available.
  - sm
```
protected static final StringManager sm
```
    The string manager for this package.
  - wrapper
```
protected transient Wrapper wrapper
```
    The Wrapper container associated with this servlet.
- Constructor Detail
  - ManagerServlet
```
public ManagerServlet()
```
- Method Detail
  - getWrapper
```
public Wrapper getWrapper()
```
    Return the Wrapper with which we are associated.
    
    Specified by:
    
    getWrapper in interface ContainerServlet
  - setWrapper
```
public void setWrapper(Wrapper wrapper)
```
    Set the Wrapper with which we are associated.
    
    Specified by:
    
    setWrapper in interface ContainerServlet
    
    Parameters:
    wrapper - The new wrapper
  - destroy
```
public void destroy()
```
    Finalize this servlet.
    
    Specified by:
    
    destroy in interface Servlet
    
    Overrides:
    
    destroy in class GenericServlet
  - doGet
```
public void doGet(HttpServletRequest request,
         HttpServletResponse response)
           throws IOException,
                  ServletException
```
    Process a GET request for the specified resource.
    
    Overrides:
    
    doGet in class HttpServlet
    
    Parameters:
    request - The servlet request we are processing
    response - The servlet response we are creating
    
    Throws:
    
    IOException - if an input/output error occurs
    
    ServletException - if a servlet-specified error occurs
    See Also:
    ServletResponse.setContentType(java.lang.String)
  - doPut
```
public void doPut(HttpServletRequest request,
         HttpServletResponse response)
           throws IOException,
                  ServletException
```
    Process a PUT request for the specified resource.
    
    Overrides:
    
    doPut in class HttpServlet
    
    Parameters:
    request - The servlet request we are processing
    response - The servlet response we are creating
    
    Throws:
    
    IOException - if an input/output error occurs
    
    ServletException - if a servlet-specified error occurs
  - init
```
public void init()
          throws ServletException
```
    Initialize this servlet.
    
    Overrides:
    
    init in class GenericServlet
    
    Throws:
    
    ServletException - if an exception occurs that interrupts the servlet's normal operation
  - findleaks
```
protected void findleaks(boolean statusLine,
             PrintWriter writer,
             StringManager smClient)
```
    Find potential memory leaks caused by web application reload.
  - vmInfo
```
protected void vmInfo(PrintWriter writer,
          Enumeration<Locale> requestedLocales)
```
    Write some VM info
    
    Parameters:
    writer -
  - threadDump
```
protected void threadDump(PrintWriter writer,
              Enumeration<Locale> requestedLocales)
```
    Write a JVM thread dump
    
    Parameters:
    writer -
  - sslConnectorCiphers
```
protected void sslConnectorCiphers(PrintWriter writer,
                       StringManager smClient)
```
  - save
```
protected void save(PrintWriter writer,
        String path,
        StringManager smClient)
```
    Store server configuration.
    
    Parameters:
    path - Optional context path to save
  - deploy
```
protected void deploy(PrintWriter writer,
          ContextName cn,
          String tag,
          boolean update,
          HttpServletRequest request,
          StringManager smClient)
```
    Deploy a web application archive (included in the current request) at the specified context path.
    
    Parameters:
    writer - Writer to render results to
    cn - Name of the application to be installed
    tag - Tag to be associated with the webapp
    update - Flag that indicates that any existing app should be replaced
    request - Servlet request we are processing
    smClient - i18n messages using the locale of the client
  - deploy
```
protected void deploy(PrintWriter writer,
          ContextName cn,
          String tag,
          StringManager smClient)
```
    Install an application for the specified path from the specified web application archive.
    
    Parameters:
    writer - Writer to render results to
    tag - Revision tag to deploy from
    cn - Name of the application to be installed
    smClient - i18n messages using the locale of the client
  - deploy
```
protected void deploy(PrintWriter writer,
          String config,
          ContextName cn,
          String war,
          boolean update,
          StringManager smClient)
```
    Install an application for the specified path from the specified web application archive.
    
    Parameters:
    writer - Writer to render results to
    config - URL of the context configuration file to be installed
    cn - Name of the application to be installed
    war - URL of the web application archive to be installed
    update - true to override any existing webapp on the path
    smClient - i18n messages using the locale of the client
  - list
```
protected void list(PrintWriter writer,
        StringManager smClient)
```
    Render a list of the currently active Contexts in our virtual host.
    
    Parameters:
    writer - Writer to render to
  - reload
```
protected void reload(PrintWriter writer,
          ContextName cn,
          StringManager smClient)
```
    Reload the web application at the specified context path.
    
    Parameters:
    writer - Writer to render to
    cn - Name of the application to be restarted
  - resources
```
protected void resources(PrintWriter writer,
             String type,
             StringManager smClient)
```
    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
  - printResources
```
protected void printResources(PrintWriter writer,
                  String prefix,
                  Context namingContext,
                  String type,
                  Class<?> clazz,
                  StringManager smClient)
```
    List the resources of the given context.
  - serverinfo
```
protected void serverinfo(PrintWriter writer,
              StringManager smClient)
```
    Writes System OS and JVM properties.
    
    Parameters:
    writer - Writer to render to
  - sessions
```
protected void sessions(PrintWriter writer,
            ContextName cn,
            int idle,
            StringManager smClient)
```
    Session information for the web application at the specified context path. Displays a profile of session thisAccessedTime listing number of sessions for each 10 minute interval up to 10 hours.
    
    Parameters:
    writer - Writer to render to
    cn - Name of the application to list session information for
    idle - Expire all sessions with idle time > idle for this context
  - expireSessions
```
protected void expireSessions(PrintWriter writer,
                  ContextName cn,
                  HttpServletRequest req,
                  StringManager smClient)
```
    Extract the expiration request parameter
    
    Parameters:
    cn -
    req -
  - start
```
protected void start(PrintWriter writer,
         ContextName cn,
         StringManager smClient)
```
    Start the web application at the specified context path.
    
    Parameters:
    writer - Writer to render to
    cn - Name of the application to be started
  - stop
```
protected void stop(PrintWriter writer,
        ContextName cn,
        StringManager smClient)
```
    Stop the web application at the specified context path.
    
    Parameters:
    writer - Writer to render to
    cn - Name of the application to be stopped
  - undeploy
```
protected void undeploy(PrintWriter writer,
            ContextName cn,
            StringManager smClient)
```
    Undeploy the web application at the specified context path.
    
    Parameters:
    writer - Writer to render to
    cn - Name of the application to be removed
  - isDeployed
```
protected boolean isDeployed(String name)
                      throws Exception
```
    Invoke the isDeployed method on the deployer.
    
    Throws:
    
    Exception
  - check
```
protected void check(String name)
              throws Exception
```
    Invoke the check method on the deployer.
    
    Throws:
    
    Exception
  - isServiced
```
protected boolean isServiced(String name)
                      throws Exception
```
    Invoke the isServiced method on the deployer.
    
    Throws:
    
    Exception
  - addServiced
```
protected void addServiced(String name)
                    throws Exception
```
    Invoke the addServiced method on the deployer.
    
    Throws:
    
    Exception
  - removeServiced
```
protected void removeServiced(String name)
                       throws Exception
```
    Invoke the removeServiced method on the deployer.
    
    Throws:
    
    Exception
  - undeployDir
```
protected boolean undeployDir(File dir)
```
    Delete the specified directory, including all of its contents and subdirectories recursively. The code assumes that the directory exists.
    
    Parameters:
    dir - File object representing the directory to be deleted.
  - uploadWar
```
protected void uploadWar(PrintWriter writer,
             HttpServletRequest request,
             File war,
             StringManager smClient)
                  throws IOException
```
    Upload the WAR file included in this request, and store it at the specified file location.
    
    Parameters:
    writer - Writer to render to
    request - The servlet request we are processing
    war - The file into which we should store the uploaded WAR
    smClient - The StringManager used to construct i18n messages based on the Locale of the client
    
    Throws:
    
    IOException - if an I/O error occurs during processing
  - validateContextName
```
protected static boolean validateContextName(ContextName cn,
                          PrintWriter writer,
                          StringManager sm)
```
  - copy
```
public static boolean copy(File src,
           File dest)
```
    Copy the specified file or directory to the destination.
    
    Parameters:
    src - File object representing the source
    dest - File object representing the destination
  - copyInternal
```
public static boolean copyInternal(File src,
                   File dest,
                   byte[] buf)
```
    Copy the specified file or directory to the destination.
    
    Parameters:
    src - File object representing the source
    dest - File object representing the destination
  - getConnectorCiphers
```
protected Map<String,Set<String>> getConnectorCiphers()
```

Class ManagerServlet

Field Summary

Constructor Summary

Method Summary

Methods inherited from class javax.servlet.http.HttpServlet

Methods inherited from class javax.servlet.GenericServlet

Methods inherited from class java.lang.Object

Field Detail

configBase

context

debug

versioned

host

mBeanServer

oname

global

sm

wrapper

Constructor Detail

ManagerServlet

Method Detail

getWrapper

setWrapper

destroy

doGet

doPut

init

findleaks

vmInfo

threadDump

sslConnectorCiphers

save

deploy

deploy

deploy

list

reload

resources

printResources

serverinfo

sessions

expireSessions

start

stop

undeploy

isDeployed

check

isServiced

addServiced

removeServiced

undeployDir

uploadWar

validateContextName

copy

copyInternal

getConnectorCiphers