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:
java.io.Serializable
,Servlet
,ServletConfig
,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
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 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
-
-
Constructor Summary
Constructors Constructor Description HTMLManagerServlet()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected java.lang.String
deployInternal(java.lang.String config, ContextName cn, java.lang.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, java.lang.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)
Called by the server (via theservice
method) to allow a servlet to handle a GET request.void
doPost(HttpServletRequest request, HttpServletResponse response)
Called by the server (via theservice
method) to allow a servlet to handle a POST request.protected void
doSessions(ContextName cn, HttpServletRequest req, HttpServletResponse resp, StringManager smClient)
Handle session operations.protected java.lang.String
expireSessions(ContextName cn, HttpServletRequest req, StringManager smClient)
Extract the expiration request parameterprotected java.lang.String
findleaks(StringManager smClient)
Find potential memory leaks caused by web application reload.protected java.util.Comparator<Session>
getComparator(java.lang.String sortBy)
java.lang.String
getServletInfo()
Returns information about the servlet, such as author, version, and copyright.protected Session
getSessionForNameAndId(ContextName cn, java.lang.String id, StringManager smClient)
protected java.util.List<Session>
getSessionsForName(ContextName cn, StringManager smClient)
void
init()
A convenience method which can be overridden so that there's no need to callsuper.init(config)
.protected int
invalidateSessions(ContextName cn, java.lang.String[] sessionIds, StringManager smClient)
Invalidate specified sessions.protected void
list(HttpServletRequest request, HttpServletResponse response, java.lang.String message, StringManager smClient)
Render an HTML list of the currently active Contexts in our virtual host, and memory and server status information.protected java.lang.String
reload(ContextName cn, StringManager smClient)
Reload the web application at the specified context path.protected boolean
removeSessionAttribute(ContextName cn, java.lang.String sessionId, java.lang.String attributeName, StringManager smClient)
Removes an attribute from an HttpSessionprotected java.lang.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 java.lang.String
sslReload(java.lang.String tlsHostName, StringManager smClient)
protected java.lang.String
start(ContextName cn, StringManager smClient)
Start the web application at the specified context path.protected java.lang.String
stop(ContextName cn, StringManager smClient)
Stop the web application at the specified context path.protected java.lang.String
undeploy(ContextName cn, StringManager smClient)
Undeploy the web application at the specified context path.protected java.lang.String
upload(HttpServletRequest request, StringManager smClient)
-
Methods inherited from class org.apache.catalina.manager.ManagerServlet
addServiced, check, 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, 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
-
-
-
-
Method Detail
-
doGet
public void doGet(HttpServletRequest request, HttpServletResponse response) throws java.io.IOException, ServletException
Description copied from class:javax.servlet.http.HttpServlet
Called by the server (via theservice
method) to allow a servlet to handle a GET request.Overriding this method to support a GET request also automatically supports an HTTP HEAD request. A HEAD request is a GET request that returns no body in the response, only the request header fields.
When overriding this method, read the request data, write the response headers, get the response's Writer or output stream object, and finally, write the response data. It's best to include content type and encoding. When using a
PrintWriter
object to return the response, set the content type before accessing thePrintWriter
object.The servlet container must write the headers before committing the response, because in HTTP the headers must be sent before the response body.
Where possible, set the Content-Length header (with the
ServletResponse.setContentLength(int)
method), to allow the servlet container to use a persistent connection to return its response to the client, improving performance. The content length is automatically set if the entire response fits inside the response buffer.When using HTTP 1.1 chunked encoding (which means that the response has a Transfer-Encoding header), do not set the Content-Length header.
The GET method should be safe, that is, without any side effects for which users are held responsible. For example, most form queries have no side effects. If a client request is intended to change stored data, the request should use some other HTTP method.
The GET method should also be idempotent, meaning that it can be safely repeated. Sometimes making a method safe also makes it idempotent. For example, repeating queries is both safe and idempotent, but buying a product online or modifying data is neither safe nor idempotent.
If the request is incorrectly formatted,
doGet
returns an HTTP "Bad Request" message.- Overrides:
doGet
in classManagerServlet
- Parameters:
request
- anHttpServletRequest
object that contains the request the client has made of the servletresponse
- anHttpServletResponse
object that contains the response the servlet sends to the client- Throws:
java.io.IOException
- if an input or output error is detected when the servlet handles the GET requestServletException
- if the request for the GET could not be handled- See Also:
ServletResponse.setContentType(java.lang.String)
-
doPost
public void doPost(HttpServletRequest request, HttpServletResponse response) throws java.io.IOException, ServletException
Description copied from class:javax.servlet.http.HttpServlet
Called by the server (via theservice
method) to allow a servlet to handle a POST request. The HTTP POST method allows the client to send data of unlimited length to the Web server a single time and is useful when posting information such as credit card numbers.When overriding this method, read the request data, write the response headers, get the response's Writer or output stream object, and finally, write the response data. It's best to include content type and encoding. When using a
PrintWriter
object to return the response, set the content type before accessing thePrintWriter
object.The servlet container must write the headers before committing the response, because in HTTP the headers must be sent before the response body.
Where possible, set the Content-Length header (with the
ServletResponse.setContentLength(int)
method), to allow the servlet container to use a persistent connection to return its response to the client, improving performance. The content length is automatically set if the entire response fits inside the response buffer.When using HTTP 1.1 chunked encoding (which means that the response has a Transfer-Encoding header), do not set the Content-Length header.
This method does not need to be either safe or idempotent. Operations requested through POST can have side effects for which the user can be held accountable, for example, updating stored data or buying items online.
If the HTTP POST request is incorrectly formatted,
doPost
returns an HTTP "Bad Request" message.- Overrides:
doPost
in classHttpServlet
- Parameters:
request
- anHttpServletRequest
object that contains the request the client has made of the servletresponse
- anHttpServletResponse
object that contains the response the servlet sends to the client- Throws:
java.io.IOException
- if an input or output error is detected when the servlet handles the requestServletException
- if the request for the POST could not be handled- See Also:
ServletOutputStream
,ServletResponse.setContentType(java.lang.String)
-
upload
protected java.lang.String upload(HttpServletRequest request, StringManager smClient)
-
deployInternal
protected java.lang.String deployInternal(java.lang.String config, ContextName cn, java.lang.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, java.lang.String message, StringManager smClient) throws java.io.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:
java.io.IOException
- an IO error occurred
-
reload
protected java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.lang.String sslReload(java.lang.String tlsHostName, StringManager smClient)
-
sslConnectorCiphers
protected void sslConnectorCiphers(HttpServletRequest request, HttpServletResponse response, StringManager smClient) throws ServletException, java.io.IOException
- Throws:
ServletException
java.io.IOException
-
sslConnectorCerts
protected void sslConnectorCerts(HttpServletRequest request, HttpServletResponse response, StringManager smClient) throws ServletException, java.io.IOException
- Throws:
ServletException
java.io.IOException
-
sslConnectorTrustedCerts
protected void sslConnectorTrustedCerts(HttpServletRequest request, HttpServletResponse response, StringManager smClient) throws ServletException, java.io.IOException
- Throws:
ServletException
java.io.IOException
-
getServletInfo
public java.lang.String 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
-
init
public void init() throws ServletException
Description copied from class:javax.servlet.GenericServlet
A convenience method which can be overridden so that there's no need to callsuper.init(config)
.Instead of overriding
GenericServlet.init(ServletConfig)
, simply override this method and it will be called byGenericServlet.init(ServletConfig config)
. TheServletConfig
object can still be retrieved viaGenericServlet.getServletConfig()
.- Overrides:
init
in classManagerServlet
- Throws:
ServletException
- if an exception occurs that interrupts the servlet's normal operation
-
expireSessions
protected java.lang.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, java.io.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 errorjava.io.IOException
- An IO error occurred
-
getSessionsForName
protected java.util.List<Session> getSessionsForName(ContextName cn, StringManager smClient)
-
getSessionForNameAndId
protected Session getSessionForNameAndId(ContextName cn, java.lang.String id, StringManager smClient)
-
displaySessionsListPage
protected void displaySessionsListPage(ContextName cn, HttpServletRequest req, HttpServletResponse resp, StringManager smClient) throws ServletException, java.io.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 errorjava.io.IOException
- An IO error occurred
-
displaySessionDetailPage
protected void displaySessionDetailPage(HttpServletRequest req, HttpServletResponse resp, ContextName cn, java.lang.String sessionId, StringManager smClient) throws ServletException, java.io.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 errorjava.io.IOException
- An IO error occurred
-
invalidateSessions
protected int invalidateSessions(ContextName cn, java.lang.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, java.lang.String sessionId, java.lang.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 java.util.Comparator<Session> getComparator(java.lang.String sortBy)
-
-