HTMLHostManagerServlet (Apache Tomcat 8.0.53 API Documentation)

java.lang.Object
- javax.servlet.GenericServlet
- - javax.servlet.http.HttpServlet
  - - org.apache.catalina.manager.host.HostManagerServlet
    - - org.apache.catalina.manager.host.HTMLHostManagerServlet

All Implemented Interfaces:

java.io.Serializable, Servlet, ServletConfig, ContainerServlet
```
public final class HTMLHostManagerServlet
extends HostManagerServlet
```
Servlet that enables remote management of the virtual hosts deployed on the server. 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 HostManagerServlet and this Servlet is that this Servlet prints out a HTML interface which makes it easier to administrate.
However if you use a software that parses the output of HostManagerServlet you won't be able to upgrade to this Servlet since the output are not in the same format as from HostManagerServlet

Author:

Bip Thelin, Malcolm Edgar, Glenn L. Nielsen, Peter Rossbach

See Also:
ManagerServlet, Serialized Form

Field Summary
- Fields inherited from class org.apache.catalina.manager.host.HostManagerServlet
  context, debug, engine, installedHost, sm, wrapper

Constructor Summary

Constructors
Constructor and Description

HTMLHostManagerServlet()

Constructors
Constructor and Description
`HTMLHostManagerServlet()`

Method Summary

Methods
Modifier and Type	Method and Description
`protected java.lang.String`	`add(HttpServletRequest request, java.lang.String name, StringManager smClient)` Add a host using the specified parameters.
`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.
`void`	`list(HttpServletRequest request, HttpServletResponse response, java.lang.String message, StringManager smClient)` Render a HTML list of the currently active Contexts in our virtual host, and memory and server status information.
`protected java.lang.String`	`remove(java.lang.String name, StringManager smClient)` Remove the specified host.
`protected java.lang.String`	`start(java.lang.String name, StringManager smClient)` Start the host with the specified name.
`protected java.lang.String`	`stop(java.lang.String name, StringManager smClient)` Stop the host with the specified name.

Methods inherited from class org.apache.catalina.manager.host.HostManagerServlet
add, add, booleanParameter, destroy, getConfigBase, getWrapper, init, list, remove, setWrapper, start, stop

Methods inherited from class javax.servlet.http.HttpServlet
doDelete, doHead, doOptions, doPut, doTrace, getLastModified, service, service

Methods inherited from class javax.servlet.GenericServlet
getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, log, log

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - HTMLHostManagerServlet
```
public HTMLHostManagerServlet()
```
- Method Detail
  - doGet
```
public void doGet(HttpServletRequest request,
         HttpServletResponse response)
           throws java.io.IOException,
                  ServletException
```
    Process a GET request for the specified resource.
    
    Overrides:
    
    doGet in class HostManagerServlet
    
    Parameters:
    request - The servlet request we are processing
    response - The servlet response we are creating
    
    Throws:
    
    java.io.IOException - if an input/output error occurs
    
    ServletException - if a servlet-specified error occurs
    See Also:
    ServletResponse.setContentType(java.lang.String)
  - doPost
```
public void doPost(HttpServletRequest request,
          HttpServletResponse response)
            throws ServletException,
                   java.io.IOException
```
    Process a POST request for the specified resource.
    
    Overrides:
    
    doPost in class HttpServlet
    
    Parameters:
    request - The servlet request we are processing
    response - The servlet response we are creating
    
    Throws:
    
    java.io.IOException - if an input/output error occurs
    
    ServletException - if a servlet-specified error occurs
    See Also:
    ServletOutputStream, ServletResponse.setContentType(java.lang.String)
  - add
```
protected java.lang.String add(HttpServletRequest request,
                   java.lang.String name,
                   StringManager smClient)
```
    Add a host using the specified parameters.
    
    Parameters:
    name - host name
  - remove
```
protected java.lang.String remove(java.lang.String name,
                      StringManager smClient)
```
    Remove the specified host.
    
    Parameters:
    name - host name
  - start
```
protected java.lang.String start(java.lang.String name,
                     StringManager smClient)
```
    Start the host with the specified name.
    
    Parameters:
    name - Host name
  - stop
```
protected java.lang.String stop(java.lang.String name,
                    StringManager smClient)
```
    Stop the host with the specified name.
    
    Parameters:
    name - Host name
  - list
```
public void list(HttpServletRequest request,
        HttpServletResponse response,
        java.lang.String message,
        StringManager smClient)
          throws java.io.IOException
```
    Render a 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
    
    Throws:
    
    java.io.IOException

Class HTMLHostManagerServlet

Field Summary

Fields inherited from class org.apache.catalina.manager.host.HostManagerServlet

Constructor Summary

Method Summary

Methods inherited from class org.apache.catalina.manager.host.HostManagerServlet

Methods inherited from class javax.servlet.http.HttpServlet

Methods inherited from class javax.servlet.GenericServlet

Methods inherited from class java.lang.Object

Constructor Detail

HTMLHostManagerServlet

Method Detail

doGet

doPost

add

remove

start

stop

list