Package org.apache.catalina.manager.host
Class HostManagerServlet
java.lang.Object
javax.servlet.GenericServlet
javax.servlet.http.HttpServlet
org.apache.catalina.manager.host.HostManagerServlet
- All Implemented Interfaces:
Serializable
,Servlet
,ServletConfig
,ContainerServlet
- Direct Known Subclasses:
HTMLHostManagerServlet
Servlet that enables remote management of the virtual hosts installed 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.
This servlet examines the value returned by getPathInfo()
and related query parameters to determine what
action is being requested. The following actions and parameters (starting after the servlet path) are supported:
- /add?name={host-name}&aliases={host-aliases}&manager={manager} - Create and add a new virtual
host. The
host-name
attribute indicates the name of the new host. Thehost-aliases
attribute is a comma separated list of the host alias names. Themanager
attribute is a boolean value indicating if the webapp manager will be installed in the newly created host (optional, false by default). - /remove?name={host-name} - Remove a virtual host. The
host-name
attribute indicates the name of the host. - /list - List the virtual hosts installed on the server. Each host will be listed with the following format
host-name#host-aliases
. - /start?name={host-name} - Start the virtual host.
- /stop?name={host-name} - Stop the virtual host.
NOTE - Attempting to stop or remove the host containing this servlet itself will not succeed. Therefore, this servlet should generally be deployed in a separate virtual host.
The following servlet initialization parameters are recognized:
- debug - The debugging detail level that controls the amount of information that is logged by this servlet. Default is zero.
- Author:
- Craig R. McClanahan, Remy Maucherat
- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionprotected Context
The Context container associated with our web application.protected int
The debugging detail level for this servlet.protected Engine
The associated engine.protected Host
The associated host.protected static final StringManager
The string manager for this package.protected Wrapper
The Wrapper container associated with this servlet. -
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionprotected void
add
(PrintWriter writer, String name, String aliases, String appBase, boolean manager, boolean autoDeploy, boolean deployOnStartup, boolean deployXML, boolean unpackWARs, boolean copyXML, StringManager smClient) Add a host using the specified parameters.protected void
add
(HttpServletRequest request, PrintWriter writer, String name, boolean htmlMode, StringManager smClient) Add host with the given parameters.protected boolean
booleanParameter
(HttpServletRequest request, String parameter, boolean theDefault, boolean htmlMode) Extract boolean value from checkbox with default.void
destroy()
Finalize this servlet.void
doGet
(HttpServletRequest request, HttpServletResponse response) Process a GET request for the specified resource.protected File
getConfigBase
(String hostName) Get config base.Return the Wrapper with which we are associated.void
init()
A convenience method which can be overridden so that there's no need to callsuper.init(config)
.protected void
list
(PrintWriter writer, StringManager smClient) Render a list of the currently active Contexts in our virtual host.protected void
persist
(PrintWriter writer, StringManager smClient) Persist the current configuration to server.xml.protected void
remove
(PrintWriter writer, String name, StringManager smClient) Remove the specified host.void
setWrapper
(Wrapper wrapper) Set the Wrapper with which we are associated.protected void
start
(PrintWriter writer, String name, StringManager smClient) Start the host with the specified name.protected void
stop
(PrintWriter writer, String name, StringManager smClient) Stop the host with the specified name.Methods inherited from class javax.servlet.http.HttpServlet
doDelete, doHead, doOptions, doPost, doPut, doTrace, getLastModified, service, service
Methods inherited from class javax.servlet.GenericServlet
getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, log, log
-
Field Details
-
context
The Context container associated with our web application. -
debug
protected int debugThe debugging detail level for this servlet. -
installedHost
The associated host. -
engine
The associated engine. -
sm
The string manager for this package. -
wrapper
The Wrapper container associated with this servlet.
-
-
Constructor Details
-
HostManagerServlet
public HostManagerServlet()
-
-
Method Details
-
getWrapper
Return the Wrapper with which we are associated.- Specified by:
getWrapper
in interfaceContainerServlet
- Returns:
- The Wrapper with which this Servlet is associated.
-
setWrapper
Set the Wrapper with which we are associated.- Specified by:
setWrapper
in interfaceContainerServlet
- Parameters:
wrapper
- The new wrapper
-
destroy
public void destroy()Finalize this servlet.- Specified by:
destroy
in interfaceServlet
- Overrides:
destroy
in classGenericServlet
-
doGet
public void doGet(HttpServletRequest request, HttpServletResponse response) throws IOException, ServletException Process a GET request for the specified resource.- Overrides:
doGet
in 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
protected void add(HttpServletRequest request, PrintWriter writer, String name, boolean htmlMode, StringManager smClient) Add host with the given parameters.- Parameters:
request
- The requestwriter
- The output writername
- The host namehtmlMode
- Flag valuesmClient
- StringManager for the client's locale
-
booleanParameter
protected boolean booleanParameter(HttpServletRequest request, String parameter, boolean theDefault, boolean htmlMode) Extract boolean value from checkbox with default.- Parameters:
request
- The Servlet requestparameter
- The parameter nametheDefault
- Default valuehtmlMode
- Flag value- Returns:
- the boolean value for the parameter
-
init
Description copied from class:javax.servlet.GenericServlet
A convenience method which can be overridden so that there's no need to callsuper.init(config)
.Instead of overriding
GenericServlet.init(ServletConfig)
, simply override this method and it will be called byGenericServlet.init(ServletConfig config)
. TheServletConfig
object can still be retrieved viaGenericServlet.getServletConfig()
.- Overrides:
init
in classGenericServlet
- Throws:
ServletException
- if an exception occurs that interrupts the servlet's normal operation
-
add
protected void add(PrintWriter writer, String name, String aliases, String appBase, boolean manager, boolean autoDeploy, boolean deployOnStartup, boolean deployXML, boolean unpackWARs, boolean copyXML, StringManager smClient) Add a host using the specified parameters.- Parameters:
writer
- Writer to render results toname
- host namealiases
- comma separated alias listappBase
- application base for the hostmanager
- should the manager webapp be deployed to the new host ?autoDeploy
- Flag valuedeployOnStartup
- Flag valuedeployXML
- Flag valueunpackWARs
- Flag valuecopyXML
- Flag valuesmClient
- StringManager for the client's locale
-
remove
Remove the specified host.- Parameters:
writer
- Writer to render results toname
- host namesmClient
- StringManager for the client's locale
-
list
Render a list of the currently active Contexts in our virtual host.- Parameters:
writer
- Writer to render tosmClient
- StringManager for the client's locale
-
start
Start the host with the specified name.- Parameters:
writer
- Writer to render toname
- Host namesmClient
- StringManager for the client's locale
-
stop
Stop the host with the specified name.- Parameters:
writer
- Writer to render toname
- Host namesmClient
- StringManager for the client's locale
-
persist
Persist the current configuration to server.xml.- Parameters:
writer
- Writer to render tosmClient
- i18n resources localized for the client
-
getConfigBase
Get config base.- Parameters:
hostName
- The host name- Returns:
- the config base for the host
-