Package org.apache.catalina.manager
Class HTMLManagerServlet
java.lang.Object
javax.servlet.GenericServlet
javax.servlet.http.HttpServlet
org.apache.catalina.manager.ManagerServlet
org.apache.catalina.manager.HTMLManagerServlet
- All Implemented Interfaces:
Serializable
,Servlet
,ServletConfig
,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 Summary
Fields inherited from class org.apache.catalina.manager.ManagerServlet
configBase, context, debug, global, host, mBeanServer, oname, sm, versioned, wrapper
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionprotected String
deployInternal
(String config, ContextName cn, String war, StringManager smClient) Deploy an application for the specified path from the specified web application archive.protected void
displaySessionDetailPage
(HttpServletRequest req, HttpServletResponse resp, ContextName cn, String sessionId, StringManager smClient) Display session details.protected void
displaySessionsListPage
(ContextName cn, HttpServletRequest req, HttpServletResponse resp, StringManager smClient) List session.void
doGet
(HttpServletRequest request, HttpServletResponse response) Process a GET request for the specified resource.void
doPost
(HttpServletRequest request, HttpServletResponse response) Process a POST request for the specified resource.protected void
doSessions
(ContextName cn, HttpServletRequest req, HttpServletResponse resp, StringManager smClient) Handle session operations.protected String
expireSessions
(ContextName cn, HttpServletRequest req, StringManager smClient) Extract the expiration request parameterprotected String
findleaks
(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 Session
getSessionForNameAndId
(ContextName cn, String id, StringManager smClient) getSessionsForName
(ContextName cn, StringManager smClient) void
init()
Initialize this servlet.protected int
invalidateSessions
(ContextName cn, String[] sessionIds, StringManager smClient) Invalidate specified sessions.protected void
list
(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 String
reload
(ContextName cn, StringManager smClient) Reload the web application at the specified context path.protected boolean
removeSessionAttribute
(ContextName cn, String sessionId, String attributeName, StringManager smClient) Removes an attribute from an HttpSessionprotected String
sessions
(ContextName cn, int idle, StringManager smClient) Display session information and invoke list.protected void
sslConnectorCerts
(HttpServletRequest request, HttpServletResponse response, StringManager smClient) protected void
sslConnectorCiphers
(HttpServletRequest request, HttpServletResponse response, StringManager smClient) protected void
sslConnectorTrustedCerts
(HttpServletRequest request, HttpServletResponse response, StringManager smClient) protected String
sslReload
(String tlsHostName, StringManager smClient) protected String
start
(ContextName cn, StringManager smClient) Start the web application at the specified context path.protected String
stop
(ContextName cn, StringManager smClient) Stop the web application at the specified context path.protected String
undeploy
(ContextName cn, StringManager smClient) Undeploy the web application at the specified context path.protected String
upload
(HttpServletRequest request, StringManager smClient) Methods inherited from class org.apache.catalina.manager.ManagerServlet
addServiced, check, copy, copyInternal, deploy, deploy, deploy, destroy, doPut, expireSessions, findleaks, getConnectorCerts, getConnectorCiphers, getConnectorTrustedCerts, getWrapper, isDeployed, isServiced, list, printResources, printResources, reload, removeServiced, resources, save, serverinfo, sessions, setWrapper, sslConnectorCiphers, sslReload, start, stop, threadDump, tryAddServiced, undeploy, undeployDir, uploadWar, validateContextName, vmInfo
Methods inherited from class javax.servlet.http.HttpServlet
doDelete, doHead, doOptions, doTrace, getLastModified, service, service
Methods inherited from class javax.servlet.GenericServlet
getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletName, init, log, log
-
Constructor Details
-
HTMLManagerServlet
public HTMLManagerServlet()
-
-
Method Details
-
doGet
public void doGet(HttpServletRequest request, HttpServletResponse response) throws IOException, ServletException Process a GET request for the specified resource.- Overrides:
doGet
in 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:
-
doPost
public void doPost(HttpServletRequest request, HttpServletResponse response) throws IOException, ServletException Process a POST request for the specified resource.- Overrides:
doPost
in 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:
-
upload
-
deployInternal
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
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:
-
undeploy
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:
-
sessions
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:
-
start
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:
-
stop
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:
-
findleaks
Find potential memory leaks caused by web application reload.- Parameters:
smClient
- StringManager for the client's locale- Returns:
- message String
- See Also:
-
sslReload
-
sslConnectorCiphers
protected void sslConnectorCiphers(HttpServletRequest request, HttpServletResponse response, StringManager smClient) throws ServletException, IOException - Throws:
ServletException
IOException
-
sslConnectorCerts
protected void sslConnectorCerts(HttpServletRequest request, HttpServletResponse response, StringManager smClient) throws ServletException, IOException - Throws:
ServletException
IOException
-
sslConnectorTrustedCerts
protected void sslConnectorTrustedCerts(HttpServletRequest request, HttpServletResponse response, StringManager smClient) throws ServletException, IOException - Throws:
ServletException
IOException
-
getServletInfo
Description copied from class:javax.servlet.GenericServlet
Returns 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:
getServletInfo
in interfaceServlet
- Overrides:
getServletInfo
in classGenericServlet
- Returns:
- String information about this servlet, by default an empty string
- See Also:
-
init
Description copied from class:ManagerServlet
Initialize this servlet.- Overrides:
init
in classManagerServlet
- Throws:
ServletException
- if an exception occurs that interrupts the servlet's normal operation- See Also:
-
expireSessions
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
-
getSessionForNameAndId
-
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
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
-