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
public final class HTMLManagerServlet extends ManagerServlet
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
ManagerServletand 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
ManagerServletyou won't be able to upgrade to this Servlet since the output are not in the same format ar fromManagerServlet- Author:
- Bip Thelin, Malcolm Edgar, Glenn L. Nielsen
- See Also:
ManagerServlet, Serialized Form
-
-
Field Summary
-
Fields inherited from class org.apache.catalina.manager.ManagerServlet
configBase, context, debug, global, host, mBeanServer, oname, sm, versioned, wrapper
-
Fields inherited from class jakarta.servlet.http.HttpServlet
LEGACY_DO_HEAD
-
-
Constructor Summary
Constructors Constructor Description HTMLManagerServlet()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected 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)StringgetServletInfo()Returns information about the servlet, such as author, version, and copyright.protected SessiongetSessionForNameAndId(ContextName cn, String id, StringManager smClient)protected List<Session>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.ManagerServlet
check, 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, vmInfo
-
Methods inherited from class jakarta.servlet.http.HttpServlet
doDelete, doHead, doOptions, doTrace, getLastModified, init, service, service
-
Methods inherited from class jakarta.servlet.GenericServlet
getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletName, log, log
-
-
-
-
Method Detail
-
doGet
public void doGet(HttpServletRequest request, HttpServletResponse response) throws IOException, ServletException
Process a GET request for the specified resource.- Overrides:
doGetin classManagerServlet- Parameters:
request- The servlet request we are processingresponse- The servlet response we are creating- Throws:
IOException- if an input/output error occursServletException- if a servlet-specified error occurs- See Also:
ServletResponse.setContentType(java.lang.String)
-
doPost
public void doPost(HttpServletRequest request, HttpServletResponse response) throws IOException, ServletException
Process a POST request for the specified resource.- Overrides:
doPostin classHttpServlet- Parameters:
request- The servlet request we are processingresponse- The servlet response we are creating- Throws:
IOException- if an input/output error occursServletException- if a servlet-specified error occurs- See Also:
ServletOutputStream,ServletResponse.setContentType(java.lang.String)
-
upload
protected String upload(HttpServletRequest request, StringManager smClient)
-
deployInternal
protected String deployInternal(String config, ContextName cn, String war, StringManager smClient)
Deploy an application for the specified path from the specified web application archive.- Parameters:
config- URL of the context configuration file to be deployedcn- Name of the application to be deployedwar- URL of the web application archive to be deployedsmClient- internationalized strings- Returns:
- message String
-
list
protected 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 requestresponse- The responsemessage- a message to displaysmClient- internationalized strings- Throws:
IOException- an IO error occurred
-
reload
protected String reload(ContextName cn, StringManager smClient)
Reload the web application at the specified context path.- Parameters:
cn- Name of the application to be restartedsmClient- StringManager for the client's locale- Returns:
- message String
- See Also:
ManagerServlet.reload(PrintWriter, ContextName, StringManager)
-
undeploy
protected String undeploy(ContextName cn, StringManager smClient)
Undeploy the web application at the specified context path.- Parameters:
cn- Name of the application to be undeployedsmClient- StringManager for the client's locale- Returns:
- message String
- See Also:
ManagerServlet.undeploy(PrintWriter, ContextName, StringManager)
-
sessions
protected String sessions(ContextName cn, int idle, StringManager smClient)
Display session information and invoke list.- Parameters:
cn- Name of the application to list session informationidle- Expire all sessions with idle time ≥ idle for this contextsmClient- StringManager for the client's locale- Returns:
- message String
- See Also:
ManagerServlet.sessions(PrintWriter, ContextName, int, StringManager)
-
start
protected String start(ContextName cn, StringManager smClient)
Start the web application at the specified context path.- Parameters:
cn- Name of the application to be startedsmClient- StringManager for the client's locale- Returns:
- message String
- See Also:
ManagerServlet.start(PrintWriter, ContextName, StringManager)
-
stop
protected String stop(ContextName cn, StringManager smClient)
Stop the web application at the specified context path.- Parameters:
cn- Name of the application to be stoppedsmClient- StringManager for the client's locale- Returns:
- message String
- See Also:
ManagerServlet.stop(PrintWriter, ContextName, StringManager)
-
findleaks
protected String findleaks(StringManager smClient)
Find potential memory leaks caused by web application reload.- Parameters:
smClient- StringManager for the client's locale- Returns:
- message String
- See Also:
ManagerServlet.findleaks(boolean, PrintWriter, StringManager)
-
sslReload
protected String sslReload(String tlsHostName, StringManager smClient)
-
sslConnectorCiphers
protected void sslConnectorCiphers(HttpServletRequest request, HttpServletResponse response, StringManager smClient) throws ServletException, IOException
- Throws:
ServletExceptionIOException
-
sslConnectorCerts
protected void sslConnectorCerts(HttpServletRequest request, HttpServletResponse response, StringManager smClient) throws ServletException, IOException
- Throws:
ServletExceptionIOException
-
sslConnectorTrustedCerts
protected void sslConnectorTrustedCerts(HttpServletRequest request, HttpServletResponse response, StringManager smClient) throws ServletException, IOException
- Throws:
ServletExceptionIOException
-
getServletInfo
public String getServletInfo()
Description 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 interfaceServlet- Overrides:
getServletInfoin classGenericServlet- Returns:
- String information about this servlet, by default an empty string
- See Also:
Servlet.getServletInfo()
-
init
public void init() throws ServletExceptionDescription copied from class:ManagerServletInitialize this servlet.- Overrides:
initin classManagerServlet- Throws:
ServletException- if an exception occurs that interrupts the servlet's normal operation- See Also:
GenericServlet.init()
-
expireSessions
protected String expireSessions(ContextName cn, HttpServletRequest req, StringManager smClient)
Extract the expiration request parameter- Parameters:
cn- Name of the application from which to expire sessionsreq- The Servlet requestsmClient- StringManager for the client's locale- Returns:
- message string
-
doSessions
protected 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 operationreq- The Servlet requestresp- The Servlet responsesmClient- StringManager for the client's locale- Throws:
ServletException- Propagated Servlet errorIOException- An IO error occurred
-
getSessionsForName
protected List<Session> getSessionsForName(ContextName cn, StringManager smClient)
-
getSessionForNameAndId
protected Session getSessionForNameAndId(ContextName cn, String id, StringManager smClient)
-
displaySessionsListPage
protected 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 listedreq- The Servlet requestresp- The Servlet responsesmClient- StringManager for the client's locale- Throws:
ServletException- Propagated Servlet errorIOException- An IO error occurred
-
displaySessionDetailPage
protected void displaySessionDetailPage(HttpServletRequest req, HttpServletResponse resp, ContextName cn, String sessionId, StringManager smClient) throws ServletException, IOException
Display session details.- Parameters:
req- The Servlet requestresp- The Servlet responsecn- Name of the application for which the sessions will be listedsessionId- the session idsmClient- StringManager for the client's locale- Throws:
ServletException- Propagated Servlet errorIOException- An IO error occurred
-
invalidateSessions
protected int invalidateSessions(ContextName cn, String[] sessionIds, StringManager smClient)
Invalidate specified sessions.- Parameters:
cn- Name of the application for which sessions are to be invalidatedsessionIds- the session ids of the sessionssmClient- StringManager for the client's locale- Returns:
- number of invalidated sessions
-
removeSessionAttribute
protected 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 removedsessionId- the session idattributeName- the attribute namesmClient- StringManager for the client's locale- Returns:
- true if there was an attribute removed, false otherwise
-
getComparator
protected Comparator<Session> getComparator(String sortBy)
-
-