Package org.apache.catalina.manager.host

Class HTMLHostManagerServlet

java.lang.Object

jakarta.servlet.GenericServlet

jakarta.servlet.http.HttpServlet

org.apache.catalina.manager.host.HostManagerServlet

org.apache.catalina.manager.host.HTMLHostManagerServlet

All Implemented Interfaces:

Servlet, ServletConfig, java.io.Serializable, 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 an 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	Description
HTMLHostManagerServlet()

Method Summary

Modifier and Type	Method	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 an HTML list of the currently active Contexts in our virtual host, and memory and server status information.
protected java.lang.String	persist(StringManager smClient)	Persist the current configuration to server.xml.
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, persist, remove, setWrapper, start, stop

Methods inherited from class jakarta.servlet.http.HttpServlet

doDelete, doHead, doOptions, doPut, doTrace, getLastModified, service, service

Methods inherited from class jakarta.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:

request - The Servlet request

name - Host name

smClient - StringManager for the client's locale

Returns:

output

remove

protected java.lang.String remove(java.lang.String name,
                                  StringManager smClient)

Remove the specified host.

Parameters:

name - Host name

smClient - StringManager for the client's locale

Returns:

output

start

protected java.lang.String start(java.lang.String name,
                                 StringManager smClient)

Start the host with the specified name.

Parameters:

name - Host name

smClient - StringManager for the client's locale

Returns:

output

stop

protected java.lang.String stop(java.lang.String name,
                                StringManager smClient)

Stop the host with the specified name.

Parameters:

name - Host name

smClient - StringManager for the client's locale

Returns:

output

persist

protected java.lang.String persist(StringManager smClient)

Persist the current configuration to server.xml.

Parameters:

smClient - i18n resources localized for the client

Returns:

output

list

public 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 - StringManager for the client's locale

Throws:

java.io.IOException - An IO error occurred