Tomcat 10.1.19 · org.apache.catalina.manager.host.HTMLHostManagerServlet

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

Field Summary

Modifier and Type	Field and Description
private static final String	ADD_SECTION_BOOLEAN
private static final String	ADD_SECTION_END
private static final String	ADD_SECTION_START
private static final String	HOSTS_HEADER_SECTION
private static final String	HOSTS_ROW_BUTTON_SECTION
private static final String	HOSTS_ROW_DETAILS_SECTION
private static final String	MANAGER_HOST_ROW_BUTTON_SECTION
private static final String	PERSIST_SECTION
private static final long	serialVersionUID Hides org.apache.catalina.manager.host.HostManagerServlet.serialVersionUID.

Inherited from org.apache.catalina.manager.host.HostManagerServlet:: context debug engine installedHost sm wrapper

Constructor Summary

Access	Constructor and Description
public	HTMLHostManagerServlet()

Method Summary

Modifier and Type	Method and Description
protected String	Returns: output add(HttpServletRequest The Servlet request request, String Host name name, StringManager StringManager for the client's locale smClient) Add a host using the specified parameters.
public void	doGet(HttpServletRequest The servlet request we are processing request, HttpServletResponse The servlet response we are creating response) Overrides org.apache.catalina.manager.host.HostManagerServlet.doGet. Process a GET request for the specified resource.
public void	doPost(HttpServletRequest The servlet request we are processing request, HttpServletResponse The servlet response we are creating response) Overrides jakarta.servlet.http.HttpServlet.doPost. Process a POST request for the specified resource.
public void	list(HttpServletRequest The request request, HttpServletResponse The response response, String a message to display message, StringManager StringManager for the client's locale smClient) Render an HTML list of the currently active Contexts in our virtual host, and memory and server status information.
protected String	Returns: output persist(StringManager i18n resources localized for the client smClient) Persist the current configuration to server.xml.
protected String	Returns: output remove(String Host name name, StringManager StringManager for the client's locale smClient) Remove the specified host.
protected String	Returns: output start(String Host name name, StringManager StringManager for the client's locale smClient) Start the host with the specified name.
protected String	Returns: output stop(String Host name name, StringManager StringManager for the client's locale smClient) Stop the host with the specified name.

Inherited from org.apache.catalina.manager.host.HostManagerServlet:: add add booleanParameter destroy getConfigBase getWrapper init list persist remove setWrapper start stop

Field Detail

ADD_SECTION_BOOLEAN	back to summary
private static final String ADD_SECTION_BOOLEAN

ADD_SECTION_END	back to summary
private static final String ADD_SECTION_END

ADD_SECTION_START	back to summary
private static final String ADD_SECTION_START

HOSTS_HEADER_SECTION	back to summary
private static final String HOSTS_HEADER_SECTION

HOSTS_ROW_BUTTON_SECTION	back to summary
private static final String HOSTS_ROW_BUTTON_SECTION

HOSTS_ROW_DETAILS_SECTION	back to summary
private static final String HOSTS_ROW_DETAILS_SECTION

MANAGER_HOST_ROW_BUTTON_SECTION	back to summary
private static final String MANAGER_HOST_ROW_BUTTON_SECTION

PERSIST_SECTION	back to summary
private static final String PERSIST_SECTION

serialVersionUID	back to summary
private static final long serialVersionUID Hides org.apache.catalina.manager.host.HostManagerServlet.serialVersionUID.

Constructor Detail

HTMLHostManagerServlet	back to summary
public HTMLHostManagerServlet()

Method Detail

add	back to summary
protected String add(HttpServletRequest request, String name, StringManager smClient) Add a host using the specified parameters. Parameters request:HttpServletRequest The Servlet request name:String Host name smClient:StringManager StringManager for the client's locale Returns:String output

add

back to summary

protected String add(HttpServletRequest request, String name, StringManager smClient)

Add a host using the specified parameters.

Parameters

request:HttpServletRequest: The Servlet request
name:String: Host name
smClient:StringManager: StringManager for the client's locale

Returns:String

output

doGet	back to summary
public void doGet(HttpServletRequest request, HttpServletResponse response) throws IOException, ServletException Overrides org.apache.catalina.manager.host.HostManagerServlet.doGet. Process a GET request for the specified resource. Parameters request:HttpServletRequest The servlet request we are processing response:HttpServletResponse The servlet response we are creating Annotations @Override Exceptions IOException: if an input/output error occurs ServletException: if a servlet-specified error occurs

doGet

back to summary

public void doGet(HttpServletRequest request, HttpServletResponse response) throws IOException, ServletException

Overrides org.apache.catalina.manager.host.HostManagerServlet.doGet.

Process a GET request for the specified resource.

Parameters

request:HttpServletRequest: The servlet request we are processing
response:HttpServletResponse: The servlet response we are creating

Annotations

@Override

Exceptions

IOException:: if an input/output error occurs
ServletException:: if a servlet-specified error occurs

doPost	back to summary
public void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException Overrides jakarta.servlet.http.HttpServlet.doPost. Process a POST request for the specified resource. Parameters request:HttpServletRequest The servlet request we are processing response:HttpServletResponse The servlet response we are creating Annotations @Override Exceptions ServletException: if a servlet-specified error occurs IOException: if an input/output error occurs

doPost

back to summary

public void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException

Overrides jakarta.servlet.http.HttpServlet.doPost.

Process a POST request for the specified resource.

Parameters

request:HttpServletRequest: The servlet request we are processing
response:HttpServletResponse: The servlet response we are creating

Annotations

@Override

Exceptions

ServletException:: if a servlet-specified error occurs
IOException:: if an input/output error occurs

list	back to summary
public 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:HttpServletRequest The request response:HttpServletResponse The response message:String a message to display smClient:StringManager StringManager for the client's locale Exceptions IOException: An IO error occurred

list

back to summary

public 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:HttpServletRequest: The request
response:HttpServletResponse: The response
message:String: a message to display
smClient:StringManager: StringManager for the client's locale

Exceptions

IOException:: An IO error occurred

persist	back to summary
protected String persist(StringManager smClient) Persist the current configuration to server.xml. Parameters smClient:StringManager i18n resources localized for the client Returns:String output

persist

back to summary

protected String persist(StringManager smClient)

Persist the current configuration to server.xml.

Parameters

smClient:StringManager: i18n resources localized for the client

Returns:String

output

remove	back to summary
protected String remove(String name, StringManager smClient) Remove the specified host. Parameters name:String Host name smClient:StringManager StringManager for the client's locale Returns:String output

remove

back to summary

protected String remove(String name, StringManager smClient)

Remove the specified host.

Parameters

name:String: Host name
smClient:StringManager: StringManager for the client's locale

Returns:String

output

start	back to summary
protected String start(String name, StringManager smClient) Start the host with the specified name. Parameters name:String Host name smClient:StringManager StringManager for the client's locale Returns:String output

start

back to summary

protected String start(String name, StringManager smClient)

Start the host with the specified name.

Parameters

name:String: Host name
smClient:StringManager: StringManager for the client's locale

Returns:String

output

stop	back to summary
protected String stop(String name, StringManager smClient) Stop the host with the specified name. Parameters name:String Host name smClient:StringManager StringManager for the client's locale Returns:String output

stop

back to summary

protected String stop(String name, StringManager smClient)

Stop the host with the specified name.

Parameters

name:String: Host name
smClient:StringManager: StringManager for the client's locale

Returns:String

output

public final Class HTMLHostManagerServlet

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail