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,Serializable,ContainerServlet
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:
-
Field Summary
Fields inherited from class org.apache.catalina.manager.host.HostManagerServlet
context, debug, engine, installedHost, sm, wrapperFields inherited from class jakarta.servlet.http.HttpServlet
LEGACY_DO_HEAD -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected Stringadd(HttpServletRequest request, String name, StringManager smClient) Add a host using the specified parameters.voiddoGet(HttpServletRequest request, HttpServletResponse response) Process a GET request for the specified resource.voiddoPost(HttpServletRequest request, HttpServletResponse response) Process a POST request for the specified resource.voidlist(HttpServletRequest request, HttpServletResponse response, String message, StringManager smClient) Render an HTML list of the currently active Contexts in our virtual host, and memory and server status information.protected Stringpersist(StringManager smClient) Persist the current configuration to server.xml.protected Stringremove(String name, StringManager smClient) Remove the specified host.protected Stringstart(String name, StringManager smClient) Start the host with the specified name.protected Stringstop(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, stopMethods inherited from class jakarta.servlet.http.HttpServlet
doDelete, doHead, doOptions, doPut, doTrace, getLastModified, init, service, serviceMethods inherited from class jakarta.servlet.GenericServlet
getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, log, log
-
Constructor Details
-
HTMLHostManagerServlet
public HTMLHostManagerServlet()
-
-
Method Details
-
doGet
public void doGet(HttpServletRequest request, HttpServletResponse response) throws IOException, ServletException Process a GET request for the specified resource.- Overrides:
doGetin classHostManagerServlet- Parameters:
request- The servlet request we are processingresponse- The servlet response we are creating- Throws:
IOException- if an input/output error occursServletException- if a servlet-specified error occurs- See Also:
-
doPost
public void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException Process a POST request for the specified resource.- Overrides:
doPostin classHttpServlet- Parameters:
request- The servlet request we are processingresponse- The servlet response we are creating- Throws:
IOException- if an input/output error occursServletException- if a servlet-specified error occurs- See Also:
-
add
Add a host using the specified parameters.- Parameters:
request- The Servlet requestname- Host namesmClient- StringManager for the client's locale- Returns:
- output
-
remove
Remove the specified host.- Parameters:
name- Host namesmClient- StringManager for the client's locale- Returns:
- output
-
start
Start the host with the specified name.- Parameters:
name- Host namesmClient- StringManager for the client's locale- Returns:
- output
-
stop
Stop the host with the specified name.- Parameters:
name- Host namesmClient- StringManager for the client's locale- Returns:
- output
-
persist
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, 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 requestresponse- The responsemessage- a message to displaysmClient- StringManager for the client's locale- Throws:
IOException- An IO error occurred
-