Package org.apache.catalina.manager
Class HTMLManagerServlet
java.lang.Object
jakarta.servlet.GenericServlet
jakarta.servlet.http.HttpServlet
org.apache.catalina.manager.ManagerServlet
org.apache.catalina.manager.HTMLManagerServlet
- All Implemented Interfaces:
- Servlet,- ServletConfig,- Serializable,- ContainerServlet
Servlet that enables remote management of the web applications deployed 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.
 
 The difference between the ManagerServlet and this Servlet is that this Servlet prints out an HTML
 interface which makes it easier to administrate.
 
 However if you use a software that parses the output of ManagerServlet you won't be able to upgrade to
 this Servlet since the output are not in the same format ar from ManagerServlet
- Author:
- Bip Thelin, Malcolm Edgar, Glenn L. Nielsen
- See Also:
- 
Field SummaryFields inherited from class org.apache.catalina.manager.ManagerServletconfigBase, context, debug, global, host, mBeanServer, oname, sm, versioned, wrapperFields inherited from class jakarta.servlet.http.HttpServletLEGACY_DO_HEAD
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionprotected StringdeployInternal(String config, ContextName cn, String war, StringManager smClient) Deploy an application for the specified path from the specified web application archive.protected voiddisplaySessionDetailPage(HttpServletRequest req, HttpServletResponse resp, ContextName cn, String sessionId, StringManager smClient) Display session details.protected voiddisplaySessionsListPage(ContextName cn, HttpServletRequest req, HttpServletResponse resp, StringManager smClient) List session.voiddoGet(HttpServletRequest request, HttpServletResponse response) Process a GET request for the specified resource.voiddoPost(HttpServletRequest request, HttpServletResponse response) Process a POST request for the specified resource.protected voiddoSessions(ContextName cn, HttpServletRequest req, HttpServletResponse resp, StringManager smClient) Handle session operations.protected StringexpireSessions(ContextName cn, HttpServletRequest req, StringManager smClient) Extract the expiration request parameterprotected Stringfindleaks(StringManager smClient) Find potential memory leaks caused by web application reload.protected Comparator<Session>getComparator(String sortBy) Returns information about the servlet, such as author, version, and copyright.protected SessiongetSessionForNameAndId(ContextName cn, String id, StringManager smClient) getSessionsForName(ContextName cn, StringManager smClient) voidinit()Initialize this servlet.protected intinvalidateSessions(ContextName cn, String[] sessionIds, StringManager smClient) Invalidate specified sessions.protected voidlist(HttpServletRequest request, HttpServletResponse response, String message, StringManager smClient) Render an HTML list of the currently active Contexts in our virtual host, and memory and server status information.protected Stringreload(ContextName cn, StringManager smClient) Reload the web application at the specified context path.protected booleanremoveSessionAttribute(ContextName cn, String sessionId, String attributeName, StringManager smClient) Removes an attribute from an HttpSessionprotected Stringsessions(ContextName cn, int idle, StringManager smClient) Display session information and invoke list.protected voidsslConnectorCerts(HttpServletRequest request, HttpServletResponse response, StringManager smClient) protected voidsslConnectorCiphers(HttpServletRequest request, HttpServletResponse response, StringManager smClient) protected voidsslConnectorTrustedCerts(HttpServletRequest request, HttpServletResponse response, StringManager smClient) protected StringsslReload(String tlsHostName, StringManager smClient) protected Stringstart(ContextName cn, StringManager smClient) Start the web application at the specified context path.protected Stringstop(ContextName cn, StringManager smClient) Stop the web application at the specified context path.protected Stringundeploy(ContextName cn, StringManager smClient) Undeploy the web application at the specified context path.protected Stringupload(HttpServletRequest request, StringManager smClient) Methods inherited from class org.apache.catalina.manager.ManagerServletcheck, deploy, deploy, deploy, destroy, doPut, expireSessions, findleaks, getConnectorCerts, getConnectorCiphers, getConnectorTrustedCerts, getWrapper, isDeployed, list, printResources, reload, removeServiced, resources, save, serverinfo, sessions, setWrapper, sslConnectorCiphers, sslReload, start, stop, threadDump, tryAddServiced, undeploy, uploadWar, validateContextName, vmInfoMethods inherited from class jakarta.servlet.http.HttpServletdoDelete, doHead, doOptions, doTrace, getLastModified, init, service, serviceMethods inherited from class jakarta.servlet.GenericServletgetInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletName, log, log
- 
Constructor Details- 
HTMLManagerServletpublic HTMLManagerServlet()
 
- 
- 
Method Details- 
doGetpublic void doGet(HttpServletRequest request, HttpServletResponse response) throws IOException, ServletException Process a GET request for the specified resource.- Overrides:
- doGetin class- ManagerServlet
- 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:
 
- 
doPostpublic void doPost(HttpServletRequest request, HttpServletResponse response) throws IOException, ServletException Process a POST request for the specified resource.- Overrides:
- doPostin 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:
 
- 
upload
- 
deployInternalDeploy an application for the specified path from the specified web application archive.- Parameters:
- config- URL of the context configuration file to be deployed
- cn- Name of the application to be deployed
- war- URL of the web application archive to be deployed
- smClient- internationalized strings
- Returns:
- message String
 
- 
listprotected void list(HttpServletRequest request, HttpServletResponse response, String message, StringManager smClient) throws IOException Render an HTML list of the currently active Contexts in our virtual host, and memory and server status information.- Parameters:
- request- The request
- response- The response
- message- a message to display
- smClient- internationalized strings
- Throws:
- IOException- an IO error occurred
 
- 
reloadReload the web application at the specified context path.- Parameters:
- cn- Name of the application to be restarted
- smClient- StringManager for the client's locale
- Returns:
- message String
- See Also:
 
- 
undeployUndeploy the web application at the specified context path.- Parameters:
- cn- Name of the application to be undeployed
- smClient- StringManager for the client's locale
- Returns:
- message String
- See Also:
 
- 
sessionsDisplay session information and invoke list.- Parameters:
- cn- Name of the application to list session information
- idle- Expire all sessions with idle time ≥ idle for this context
- smClient- StringManager for the client's locale
- Returns:
- message String
- See Also:
 
- 
startStart the web application at the specified context path.- Parameters:
- cn- Name of the application to be started
- smClient- StringManager for the client's locale
- Returns:
- message String
- See Also:
 
- 
stopStop the web application at the specified context path.- Parameters:
- cn- Name of the application to be stopped
- smClient- StringManager for the client's locale
- Returns:
- message String
- See Also:
 
- 
findleaksFind potential memory leaks caused by web application reload.- Parameters:
- smClient- StringManager for the client's locale
- Returns:
- message String
- See Also:
 
- 
sslReload
- 
sslConnectorCiphersprotected void sslConnectorCiphers(HttpServletRequest request, HttpServletResponse response, StringManager smClient) throws ServletException, IOException - Throws:
- ServletException
- IOException
 
- 
sslConnectorCertsprotected void sslConnectorCerts(HttpServletRequest request, HttpServletResponse response, StringManager smClient) throws ServletException, IOException - Throws:
- ServletException
- IOException
 
- 
sslConnectorTrustedCertsprotected void sslConnectorTrustedCerts(HttpServletRequest request, HttpServletResponse response, StringManager smClient) throws ServletException, IOException - Throws:
- ServletException
- IOException
 
- 
getServletInfoDescription copied from class:jakarta.servlet.GenericServletReturns information about the servlet, such as author, version, and copyright. By default, this method returns an empty string. Override this method to have it return a meaningful value. SeeServlet.getServletInfo().- Specified by:
- getServletInfoin interface- Servlet
- Overrides:
- getServletInfoin class- GenericServlet
- Returns:
- String information about this servlet, by default an empty string
- See Also:
 
- 
initDescription copied from class:ManagerServletInitialize this servlet.- Overrides:
- initin class- ManagerServlet
- Throws:
- ServletException- if an exception occurs that interrupts the servlet's normal operation
- See Also:
 
- 
expireSessionsExtract the expiration request parameter- Parameters:
- cn- Name of the application from which to expire sessions
- req- The Servlet request
- smClient- StringManager for the client's locale
- Returns:
- message string
 
- 
doSessionsprotected void doSessions(ContextName cn, HttpServletRequest req, HttpServletResponse resp, StringManager smClient) throws ServletException, IOException Handle session operations.- Parameters:
- cn- Name of the application for the sessions operation
- req- The Servlet request
- resp- The Servlet response
- smClient- StringManager for the client's locale
- Throws:
- ServletException- Propagated Servlet error
- IOException- An IO error occurred
 
- 
getSessionsForName
- 
getSessionForNameAndId
- 
displaySessionsListPageprotected void displaySessionsListPage(ContextName cn, HttpServletRequest req, HttpServletResponse resp, StringManager smClient) throws ServletException, IOException List session.- Parameters:
- cn- Name of the application for which the sessions will be listed
- req- The Servlet request
- resp- The Servlet response
- smClient- StringManager for the client's locale
- Throws:
- ServletException- Propagated Servlet error
- IOException- An IO error occurred
 
- 
displaySessionDetailPageprotected void displaySessionDetailPage(HttpServletRequest req, HttpServletResponse resp, ContextName cn, String sessionId, StringManager smClient) throws ServletException, IOException Display session details.- Parameters:
- req- The Servlet request
- resp- The Servlet response
- cn- Name of the application for which the sessions will be listed
- sessionId- the session id
- smClient- StringManager for the client's locale
- Throws:
- ServletException- Propagated Servlet error
- IOException- An IO error occurred
 
- 
invalidateSessionsInvalidate specified sessions.- Parameters:
- cn- Name of the application for which sessions are to be invalidated
- sessionIds- the session ids of the sessions
- smClient- StringManager for the client's locale
- Returns:
- number of invalidated sessions
 
- 
removeSessionAttributeprotected boolean removeSessionAttribute(ContextName cn, String sessionId, String attributeName, StringManager smClient) Removes an attribute from an HttpSession- Parameters:
- cn- Name of the application hosting the session from which the attribute is to be removed
- sessionId- the session id
- attributeName- the attribute name
- smClient- StringManager for the client's locale
- Returns:
- true if there was an attribute removed, false otherwise
 
- 
getComparator
 
-