Class HTMLManagerServlet

  • All Implemented Interfaces:
    Servlet, ServletConfig, java.io.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:
    ManagerServlet, Serialized Form
    • Constructor Detail

      • HTMLManagerServlet

        public HTMLManagerServlet()
    • Method Detail

      • doGet

        public void doGet​(HttpServletRequest request,
                          HttpServletResponse response)
                   throws java.io.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:
        java.io.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:
        ServletResponse.setContentType(java.lang.String)
      • doPost

        public void doPost​(HttpServletRequest request,
                           HttpServletResponse response)
                    throws java.io.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:
        java.io.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:
        ServletOutputStream, ServletResponse.setContentType(java.lang.String)
      • 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 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,
                            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 request
        response - The response
        message - a message to display
        smClient - internationalized strings
        Throws:
        java.io.IOException - an IO error occurred
      • sslReload

        protected java.lang.String sslReload​(java.lang.String tlsHostName,
                                             StringManager smClient)
      • getServletInfo

        public java.lang.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
      • 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 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,
                                  java.io.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
        java.io.IOException - An IO error occurred
      • 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 listed
        req - The Servlet request
        resp - The Servlet response
        smClient - StringManager for the client's locale
        Throws:
        ServletException - Propagated Servlet error
        java.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 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
        java.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 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,
                                                 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 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 java.util.Comparator<Session> getComparator​(java.lang.String sortBy)