Package org.apache.catalina.manager
Class ManagerServlet
java.lang.Object
jakarta.servlet.GenericServlet
jakarta.servlet.http.HttpServlet
org.apache.catalina.manager.ManagerServlet
- All Implemented Interfaces:
- Servlet,- ServletConfig,- Serializable,- ContainerServlet
- Direct Known Subclasses:
- HTMLManagerServlet
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 docBaseattribute 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 thedocBaseattribute 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
 /xxxfor this virtual host.
- /expire?path=/xxx&idle=mm - Expire sessions for the context path /xxxwhich 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 /xxxfor this virtual host.
- /stop?path=/xxx - Stop the web application attached to context path /xxxfor this virtual host.
- /threaddump - Write a JVM thread dump.
- /undeploy?path=/xxx - Shutdown and remove the web application attached to context path /xxxfor 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 theappBasedirectory of this host, typically as a result of being placed there via the/deploycommand.
- /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
 /xxxto an appropriately named context.xml file in thexmlBasefor 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.
- Author:
- Craig R. McClanahan, Remy Maucherat
- See Also:
- 
Field SummaryFieldsModifier and TypeFieldDescriptionprotected FilePath where context descriptors should be deployed.protected ContextThe Context container associated with our web application.protected intThe debugging detail level for this servlet.protected ContextThe global JNDINamingContextfor this server, if available.protected HostThe associated host.protected MBeanServerMBean server.protected ObjectNameThe associated deployer ObjectName.protected static final StringManagerThe string manager for this package.protected FilePath used to store revisions of webapps.protected WrapperThe Wrapper container associated with this servlet.Fields inherited from class jakarta.servlet.http.HttpServletLEGACY_DO_HEAD
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionprotected voidInvoke the check method on the deployer.protected voiddeploy(PrintWriter writer, String config, 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 voiddeploy(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.protected voiddeploy(PrintWriter writer, ContextName cn, String tag, StringManager smClient) Install an application for the specified path from the specified web application archive.voiddestroy()Finalize this servlet.voiddoGet(HttpServletRequest request, HttpServletResponse response) Process a GET request for the specified resource.voiddoPut(HttpServletRequest request, HttpServletResponse response) Process a PUT request for the specified resource.protected voidexpireSessions(PrintWriter writer, ContextName cn, HttpServletRequest req, StringManager smClient) Extract the expiration request parameterprotected voidfindleaks(boolean statusLine, PrintWriter writer, StringManager smClient) Find potential memory leaks caused by web application reload.getConnectorCerts(StringManager smClient) getConnectorCiphers(StringManager smClient) getConnectorTrustedCerts(StringManager smClient) Return the Wrapper with which we are associated.voidinit()Initialize this servlet.protected booleanisDeployed(String name) Invoke the isDeployed method on the deployer.protected voidlist(PrintWriter writer, StringManager smClient) Render a list of the currently active Contexts in our virtual host.protected voidprintResources(PrintWriter writer, String prefix, Context namingContext, String type, StringManager smClient) List the resources of the given context.protected voidreload(PrintWriter writer, ContextName cn, StringManager smClient) Reload the web application at the specified context path.protected voidremoveServiced(String name) Invoke the removeServiced method on the deployer.protected voidresources(PrintWriter writer, String type, StringManager smClient) Render a list of available global JNDI resources.protected voidsave(PrintWriter writer, String path, StringManager smClient) Store server configuration.protected voidserverinfo(PrintWriter writer, StringManager smClient) Writes System OS and JVM properties.protected voidsessions(PrintWriter writer, ContextName cn, int idle, StringManager smClient) Session information for the web application at the specified context path.voidsetWrapper(Wrapper wrapper) Set the Wrapper with which we are associated.protected voidsslConnectorCiphers(PrintWriter writer, StringManager smClient) protected voidsslReload(PrintWriter writer, String tlsHostName, StringManager smClient) protected voidstart(PrintWriter writer, ContextName cn, StringManager smClient) Start the web application at the specified context path.protected voidstop(PrintWriter writer, ContextName cn, StringManager smClient) Stop the web application at the specified context path.protected voidthreadDump(PrintWriter writer, StringManager smClient, Enumeration<Locale> requestedLocales) Write a JVM thread dump.protected booleantryAddServiced(String name) Attempt to mark a context as being servicedprotected voidundeploy(PrintWriter writer, ContextName cn, StringManager smClient) Undeploy the web application at the specified context path.protected voiduploadWar(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 booleanvalidateContextName(ContextName cn, PrintWriter writer, StringManager smClient) protected voidvmInfo(PrintWriter writer, StringManager smClient, Enumeration<Locale> requestedLocales) Write some VM info.Methods inherited from class jakarta.servlet.http.HttpServletdoDelete, doHead, doOptions, doPost, doTrace, getLastModified, init, service, serviceMethods inherited from class jakarta.servlet.GenericServletgetInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, log, log
- 
Field Details- 
configBasePath where context descriptors should be deployed.
- 
contextThe Context container associated with our web application.
- 
debugprotected int debugThe debugging detail level for this servlet.
- 
versionedPath used to store revisions of webapps.
- 
hostThe associated host.
- 
mBeanServerMBean server.
- 
onameThe associated deployer ObjectName.
- 
globalThe global JNDINamingContextfor this server, if available.
- 
smThe string manager for this package.
- 
wrapperThe Wrapper container associated with this servlet.
 
- 
- 
Constructor Details- 
ManagerServletpublic ManagerServlet()
 
- 
- 
Method Details- 
getWrapperReturn the Wrapper with which we are associated.- Specified by:
- getWrapperin interface- ContainerServlet
- Returns:
- The Wrapper with which this Servlet is associated.
 
- 
setWrapperSet the Wrapper with which we are associated.- Specified by:
- setWrapperin interface- ContainerServlet
- Parameters:
- wrapper- The new wrapper
 
- 
destroypublic void destroy()Finalize this servlet.- Specified by:
- destroyin interface- Servlet
- Overrides:
- destroyin class- GenericServlet
 
- 
doGetpublic void doGet(HttpServletRequest request, HttpServletResponse response) throws IOException, ServletException Process a GET request for the specified resource.- Overrides:
- doGetin 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:
 
- 
doPutpublic void doPut(HttpServletRequest request, HttpServletResponse response) throws IOException, ServletException Process a PUT request for the specified resource.- Overrides:
- doPutin 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
 
- 
initInitialize this servlet.- Overrides:
- initin class- GenericServlet
- Throws:
- ServletException- if an exception occurs that interrupts the servlet's normal operation
 
- 
findleaksFind potential memory leaks caused by web application reload.- Parameters:
- statusLine- Print a status line
- writer- The output writer
- smClient- StringManager for the client's locale
 
- 
sslReload
- 
vmInfoprotected void vmInfo(PrintWriter writer, StringManager smClient, Enumeration<Locale> requestedLocales) Write some VM info.- Parameters:
- writer- The output writer
- smClient- StringManager for the client's locale
- requestedLocales- the client's locales
 
- 
threadDumpprotected void threadDump(PrintWriter writer, StringManager smClient, Enumeration<Locale> requestedLocales) Write a JVM thread dump.- Parameters:
- writer- The output writer
- smClient- StringManager for the client's locale
- requestedLocales- the client's locales
 
- 
sslConnectorCiphers
- 
saveStore server configuration.- Parameters:
- writer- Destination for any user message(s) during this operation
- path- Optional context path to save
- smClient- i18n support for current client's locale
 
- 
deployprotected void deploy(PrintWriter writer, String config, 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
- config- URL of the context configuration file to be installed
- 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
 
- 
deployInstall 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
 
- 
deployprotected 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
 
- 
listRender a list of the currently active Contexts in our virtual host.- Parameters:
- writer- Writer to render to
- smClient- i18n support for current client's locale
 
- 
reloadReload the web application at the specified context path.- Parameters:
- writer- Writer to render to
- cn- Name of the application to be restarted
- smClient- i18n support for current client's locale
 
- 
resourcesRender a list of available global JNDI resources.- Parameters:
- writer- Writer to render to
- type- Fully qualified class name of the resource type of interest, or- nullto list resources of all types
- smClient- i18n support for current client's locale
 
- 
printResourcesprotected void printResources(PrintWriter writer, String prefix, Context namingContext, String type, StringManager smClient) List the resources of the given context.- Parameters:
- writer- Writer to render to
- prefix- Path for recursion
- namingContext- The naming context for lookups
- type- Fully qualified class name of the resource type of interest, or- nullto list resources of all types
- smClient- i18n support for current client's locale
 
- 
serverinfoWrites System OS and JVM properties.- Parameters:
- writer- Writer to render to
- smClient- i18n support for current client's locale
 
- 
sessionsSession 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
- smClient- i18n support for current client's locale
 
- 
expireSessionsprotected void expireSessions(PrintWriter writer, ContextName cn, HttpServletRequest req, StringManager smClient) Extract the expiration request parameter- Parameters:
- writer- Writer to render to
- cn- Name of the application to list session information for
- req- The Servlet request
- smClient- i18n support for current client's locale
 
- 
startStart the web application at the specified context path.- Parameters:
- writer- Writer to render to
- cn- Name of the application to be started
- smClient- i18n support for current client's locale
 
- 
stopStop the web application at the specified context path.- Parameters:
- writer- Writer to render to
- cn- Name of the application to be stopped
- smClient- i18n support for current client's locale
 
- 
undeployUndeploy the web application at the specified context path.- Parameters:
- writer- Writer to render to
- cn- Name of the application to be removed
- smClient- i18n support for current client's locale
 
- 
isDeployedInvoke the isDeployed method on the deployer.- Parameters:
- name- The webapp name
- Returns:
- trueif a webapp with that name is deployed
- Throws:
- Exception- Propagate JMX invocation error
 
- 
checkInvoke the check method on the deployer.- Parameters:
- name- The webapp name
- Throws:
- Exception- Propagate JMX invocation error
 
- 
tryAddServicedAttempt to mark a context as being serviced- Parameters:
- name- The context name
- Returns:
- trueif the application was marked as being serviced and- falseif the application was already marked as being serviced
- Throws:
- Exception- Error invoking the deployer
 
- 
removeServicedInvoke the removeServiced method on the deployer.- Parameters:
- name- The webapp name
- Throws:
- Exception- Propagate JMX invocation error
 
- 
uploadWarprotected 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
 
- 
validateContextNameprotected static boolean validateContextName(ContextName cn, PrintWriter writer, StringManager smClient) 
- 
getConnectorCiphers
- 
getConnectorCerts
- 
getConnectorTrustedCerts
 
-