Tomcat 10.1.19 · org.apache.catalina.manager.ManagerServlet

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 time information 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.
/sslConnectorCiphers - Display diagnostic info on SSL/TLS ciphers that are currently configured for each connector.
/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.
/threaddump - Write a JVM thread dump.
/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.
/vminfo - Write some VM info.
/save - Save the current server configuration to server.xml
/save?path=/xxx - Save the context configuration for the web application deployed with path /xxx to an appropriately named context.xml file in the xmlBase for the associated Host.

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.

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.

Field Summary

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

Inherited from jakarta.servlet.http.HttpServlet:: LEGACY_DO_HEAD

Constructor Summary

Access	Constructor and Description
public	ManagerServlet()

Method Summary

Modifier and Type	Method and Description
protected void	check(String The webapp name name) Invoke the check method on the deployer.
protected void	deploy(PrintWriter Writer to render results to writer, String URL of the context configuration file to be installed config, ContextName Name of the application to be installed cn, String Tag to be associated with the webapp tag, boolean Flag that indicates that any existing app should be replaced update, HttpServletRequest Servlet request we are processing request, StringManager i18n messages using the locale of the client smClient) Deploy a web application archive (included in the current request) at the specified context path.
protected void	deploy(PrintWriter Writer to render results to writer, ContextName Name of the application to be installed cn, String Revision tag to deploy from tag, StringManager i18n messages using the locale of the client smClient) Install an application for the specified path from the specified web application archive.
protected void	deploy(PrintWriter Writer to render results to writer, String URL of the context configuration file to be installed config, ContextName Name of the application to be installed cn, String URL of the web application archive to be installed war, boolean true to override any existing webapp on the path update, StringManager i18n messages using the locale of the client smClient) Install an application for the specified path from the specified web application archive.
public void	destroy() Overrides jakarta.servlet.GenericServlet.destroy. Implements jakarta.servlet.Servlet.destroy. Finalize this servlet.
public void	doGet(HttpServletRequest The servlet request we are processing request, HttpServletResponse The servlet response we are creating response) Overrides jakarta.servlet.http.HttpServlet.doGet. Process a GET request for the specified resource.
public void	doPut(HttpServletRequest The servlet request we are processing request, HttpServletResponse The servlet response we are creating response) Overrides jakarta.servlet.http.HttpServlet.doPut. Process a PUT request for the specified resource.
protected void	expireSessions(PrintWriter Writer to render to writer, ContextName Name of the application to list session information for cn, HttpServletRequest The Servlet request req, StringManager i18n support for current client's locale smClient) Extract the expiration request parameter
protected void	findleaks(boolean Print a status line statusLine, PrintWriter The output writer writer, StringManager StringManager for the client's locale smClient) Find potential memory leaks caused by web application reload.
protected Map<String, List<String>>	getConnectorCerts(StringManager smClient)
protected Map<String, List<String>>	getConnectorCiphers(StringManager smClient)
private Connector[]	getConnectors()
protected Map<String, List<String>>	getConnectorTrustedCerts(StringManager smClient)
public Wrapper	getWrapper() Implements org.apache.catalina.ContainerServlet.getWrapper. Return the Wrapper with which we are associated.
public void	init() Overrides jakarta.servlet.GenericServlet.init. Initialize this servlet.
protected boolean	Returns: `true` if a webapp with that name is deployed isDeployed(String The webapp name name) Invoke the isDeployed method on the deployer.
protected void	list(PrintWriter Writer to render to writer, StringManager i18n support for current client's locale smClient) Render a list of the currently active Contexts in our virtual host.
protected void	printResources(PrintWriter Writer to render to writer, String Path for recursion prefix, Context The naming context for lookups namingContext, String Fully qualified class name of the resource type of interest, or `null` to list resources of all types type, StringManager i18n support for current client's locale smClient) List the resources of the given context.
protected void	reload(PrintWriter Writer to render to writer, ContextName Name of the application to be restarted cn, StringManager i18n support for current client's locale smClient) Reload the web application at the specified context path.
protected void	removeServiced(String The webapp name name) Invoke the removeServiced method on the deployer.
protected void	resources(PrintWriter Writer to render to writer, String Fully qualified class name of the resource type of interest, or `null` to list resources of all types type, StringManager i18n support for current client's locale smClient) Render a list of available global JNDI resources.
protected synchronized void	save(PrintWriter Destination for any user message(s) during this operation writer, String Optional context path to save path, StringManager i18n support for current client's locale smClient) Store server configuration.
protected void	serverinfo(PrintWriter Writer to render to writer, StringManager i18n support for current client's locale smClient) Writes System OS and JVM properties.
protected void	sessions(PrintWriter Writer to render to writer, ContextName Name of the application to list session information for cn, int Expire all sessions with idle time > idle for this context idle, StringManager i18n support for current client's locale smClient) Session information for the web application at the specified context path.
public void	setWrapper(Wrapper The new wrapper wrapper) Implements org.apache.catalina.ContainerServlet.setWrapper. Set the Wrapper with which we are associated.
private void	sslConnectorCerts(PrintWriter writer, StringManager smClient)
protected void	sslConnectorCiphers(PrintWriter writer, StringManager smClient)
private void	sslConnectorTrustedCerts(PrintWriter writer, StringManager smClient)
protected void	sslReload(PrintWriter writer, String tlsHostName, StringManager smClient)
protected void	start(PrintWriter Writer to render to writer, ContextName Name of the application to be started cn, StringManager i18n support for current client's locale smClient) Start the web application at the specified context path.
protected void	stop(PrintWriter Writer to render to writer, ContextName Name of the application to be stopped cn, StringManager i18n support for current client's locale smClient) Stop the web application at the specified context path.
protected void	threadDump(PrintWriter The output writer writer, StringManager StringManager for the client's locale smClient, Enumeration<Locale> the client's locales requestedLocales) Write a JVM thread dump.
protected boolean	Returns: `true` if the application was marked as being serviced and `false` if the application was already marked as being serviced tryAddServiced(String The context name name) Attempt to mark a context as being serviced
protected void	undeploy(PrintWriter Writer to render to writer, ContextName Name of the application to be removed cn, StringManager i18n support for current client's locale smClient) Undeploy the web application at the specified context path.
protected void	uploadWar(PrintWriter Writer to render to writer, HttpServletRequest The servlet request we are processing request, File The file into which we should store the uploaded WAR war, StringManager The StringManager used to construct i18n messages based on the Locale of the client 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 smClient)
protected void	vmInfo(PrintWriter The output writer writer, StringManager StringManager for the client's locale smClient, Enumeration<Locale> the client's locales requestedLocales) Write some VM info.
private void	writeDeployResult(PrintWriter writer, StringManager smClient, String name, String displayPath)

Inherited from jakarta.servlet.http.HttpServlet:: doDelete doHead doOptions doPost doTrace getLastModified init service service

Field Detail

configBase	back to summary
protected File configBase Path where context descriptors should be deployed.

context	back to summary
protected transient Context context The Context container associated with our web application.

debug	back to summary
protected int debug The debugging detail level for this servlet.

global	back to summary
protected transient Context global The global JNDI `NamingContext` for this server, if available.

host	back to summary
protected transient Host host The associated host.

mBeanServer	back to summary
protected transient MBeanServer mBeanServer MBean server.

oname	back to summary
protected ObjectName oname The associated deployer ObjectName.

serialVersionUID	back to summary
private static final long serialVersionUID Hides jakarta.servlet.http.HttpServlet.serialVersionUID.

sm	back to summary
protected static final StringManager sm The string manager for this package.

versioned	back to summary
protected File versioned Path used to store revisions of webapps.

wrapper	back to summary
protected transient Wrapper wrapper The Wrapper container associated with this servlet.

wrapper

public Class ManagerServlet

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail