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 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:

  • Constructor Details

    • HTMLManagerServlet

      public HTMLManagerServlet()

  • Method Details

    • doGet

      public void doGet(HttpServletRequest request, HttpServletResponse response) throws IOException, ServletException
      Description copied from class: jakarta.servlet.http.HttpServlet
      Called by the server (via the service 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 the PrintWriter 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 class ManagerServlet
      Parameters:
      request - an HttpServletRequest object that contains the request the client has made of the servlet
      response - an HttpServletResponse object that contains the response the servlet sends to the client
      Throws:
      IOException - if an input or output error is detected when the servlet handles the GET request
      ServletException - if the request for the GET could not be handled
      See Also:

    • doPost

      public void doPost(HttpServletRequest request, HttpServletResponse response) throws IOException, ServletException
      Description copied from class: jakarta.servlet.http.HttpServlet
      Called by the server (via the service 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 the PrintWriter 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 class HttpServlet
      Parameters:
      request - an HttpServletRequest object that contains the request the client has made of the servlet
      response - an HttpServletResponse object that contains the response the servlet sends to the client
      Throws:
      IOException - if an input or output error is detected when the servlet handles the request
      ServletException - if the request for the POST could not be handled
      See Also:

    • 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 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

    • 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 request
      response - The response
      message - a message to display
      smClient - 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 restarted
      smClient - StringManager for the client's locale
      Returns:
      message String
      See Also:

    • 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 undeployed
      smClient - StringManager for the client's locale
      Returns:
      message String
      See Also:

    • 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 information
      idle - Expire all sessions with idle time ≥ idle for this context
      smClient - StringManager for the client's locale
      Returns:
      message String
      See Also:

    • 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 started
      smClient - StringManager for the client's locale
      Returns:
      message String
      See Also:

    • 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 stopped
      smClient - StringManager for the client's locale
      Returns:
      message String
      See Also:

    • 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:

    • sslReload

      protected String sslReload(String tlsHostName, StringManager smClient)

    • 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

      public String getServletInfo()
      Description copied from class: jakarta.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. See Servlet.getServletInfo().
      Specified by:
      getServletInfo in interface Servlet
      Overrides:
      getServletInfo in class GenericServlet
      Returns:
      String information about this servlet, by default an empty string

    • init

      public void init() throws ServletException
      Description copied from class: jakarta.servlet.GenericServlet
      A convenience method which can be overridden so that there's no need to call super.init(config).

      Instead of overriding GenericServlet.init(ServletConfig), simply override this method and it will be called by GenericServlet.init(ServletConfig config). The ServletConfig object can still be retrieved via GenericServlet.getServletConfig().

      Overrides:
      init in class ManagerServlet
      Throws:
      ServletException - if an exception occurs that interrupts the servlet's normal operation

    • 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 sessions
      req - The Servlet request
      smClient - 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 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

      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 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

    • displaySessionDetailPage

      protected 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

    • 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 invalidated
      sessionIds - the session ids of the sessions
      smClient - 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 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

      protected Comparator<Session> getComparator(String sortBy)