public class ManagerServlet extends HttpServlet implements ContainerServlet
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:
docBase
attribute
of the context configuration file is used to locate the actual
WAR or directory containing the application.{config-url}
, overriding the
docBase
attribute with the contents of the web
application archive found at {war-url}
./xxx
, based
on the contents of the web application archive found at the
specified URL.path:status:sessions
.
Where path is the context path. Status is either running or stopped.
Sessions is the number of active Sessions./xxx
for this
virtual host./xxx
which were idle for at
least mm minutes./xxx
for this virtual host./xxx
for this virtual host./xxx
for this virtual host,
and remove the underlying WAR file or document base directory.
(NOTE - This is only allowed if the WAR file or document
base is stored in the appBase
directory of this host,
typically as a result of being placed there via the /deploy
command./xxx
to an appropriately
named context.xml file in the xmlBase
for the associated
Host.Use path=/
for the ROOT context.
The syntax of the URL for a web application archive must conform to one of the following patterns to be successfully deployed:
NOTE - Attempting to reload or remove the application containing this servlet itself will not succeed. Therefore, this servlet should generally be deployed as a separate web application within the virtual host to be managed.
The following servlet initialization parameters are recognized:
Modifier and Type | Field and Description |
---|---|
protected java.io.File |
configBase
Path where context descriptors should be deployed.
|
protected Context |
context
The Context container associated with our web application.
|
protected int |
debug
The debugging detail level for this servlet.
|
protected javax.naming.Context |
global
The global JNDI
NamingContext for this server,
if available. |
protected Host |
host
The associated host.
|
protected javax.management.MBeanServer |
mBeanServer
MBean server.
|
protected javax.management.ObjectName |
oname
The associated deployer ObjectName.
|
protected static StringManager |
sm
The string manager for this package.
|
protected java.io.File |
versioned
Path used to store revisions of webapps.
|
protected Wrapper |
wrapper
The Wrapper container associated with this servlet.
|
Constructor and Description |
---|
ManagerServlet() |
Modifier and Type | Method and Description |
---|---|
protected void |
addServiced(java.lang.String name)
Invoke the addServiced method on the deployer.
|
protected void |
check(java.lang.String name)
Invoke the check method on the deployer.
|
static boolean |
copy(java.io.File src,
java.io.File dest)
Copy the specified file or directory to the destination.
|
static boolean |
copyInternal(java.io.File src,
java.io.File dest,
byte[] buf)
Copy the specified file or directory to the destination.
|
protected void |
deploy(java.io.PrintWriter writer,
ContextName cn,
java.lang.String tag,
boolean update,
HttpServletRequest request,
StringManager smClient)
Deploy a web application archive (included in the current request)
at the specified context path.
|
protected void |
deploy(java.io.PrintWriter writer,
ContextName cn,
java.lang.String tag,
StringManager smClient)
Install an application for the specified path from the specified
web application archive.
|
protected void |
deploy(java.io.PrintWriter writer,
java.lang.String config,
ContextName cn,
java.lang.String war,
boolean update,
StringManager smClient)
Install an application for the specified path from the specified
web application archive.
|
void |
destroy()
Finalize this servlet.
|
void |
doGet(HttpServletRequest request,
HttpServletResponse response)
Process a GET request for the specified resource.
|
void |
doPut(HttpServletRequest request,
HttpServletResponse response)
Process a PUT request for the specified resource.
|
protected void |
expireSessions(java.io.PrintWriter writer,
ContextName cn,
HttpServletRequest req,
StringManager smClient)
Extract the expiration request parameter
|
protected void |
findleaks(boolean statusLine,
java.io.PrintWriter writer,
StringManager smClient)
Find potential memory leaks caused by web application reload.
|
protected java.util.Map<java.lang.String,java.util.List<java.lang.String>> |
getConnectorCiphers() |
Wrapper |
getWrapper()
Return the Wrapper with which we are associated.
|
void |
init()
Initialize this servlet.
|
protected boolean |
isDeployed(java.lang.String name)
Invoke the isDeployed method on the deployer.
|
protected boolean |
isServiced(java.lang.String name)
Invoke the isServiced method on the deployer.
|
protected void |
list(java.io.PrintWriter writer,
StringManager smClient)
Render a list of the currently active Contexts in our virtual host.
|
protected void |
printResources(java.io.PrintWriter writer,
java.lang.String prefix,
javax.naming.Context namingContext,
java.lang.String type,
java.lang.Class<?> clazz,
StringManager smClient)
List the resources of the given context.
|
protected void |
reload(java.io.PrintWriter writer,
ContextName cn,
StringManager smClient)
Reload the web application at the specified context path.
|
protected void |
removeServiced(java.lang.String name)
Invoke the removeServiced method on the deployer.
|
protected void |
resources(java.io.PrintWriter writer,
java.lang.String type,
StringManager smClient)
Render a list of available global JNDI resources.
|
protected void |
save(java.io.PrintWriter writer,
java.lang.String path,
StringManager smClient)
Store server configuration.
|
protected void |
serverinfo(java.io.PrintWriter writer,
StringManager smClient)
Writes System OS and JVM properties.
|
protected void |
sessions(java.io.PrintWriter writer,
ContextName cn,
int idle,
StringManager smClient)
Session information for the web application at the specified context path.
|
void |
setWrapper(Wrapper wrapper)
Set the Wrapper with which we are associated.
|
protected void |
sslConnectorCiphers(java.io.PrintWriter writer,
StringManager smClient) |
protected void |
start(java.io.PrintWriter writer,
ContextName cn,
StringManager smClient)
Start the web application at the specified context path.
|
protected void |
stop(java.io.PrintWriter writer,
ContextName cn,
StringManager smClient)
Stop the web application at the specified context path.
|
protected void |
threadDump(java.io.PrintWriter writer,
StringManager smClient,
java.util.Enumeration<java.util.Locale> requestedLocales)
Write a JVM thread dump
|
protected void |
undeploy(java.io.PrintWriter writer,
ContextName cn,
StringManager smClient)
Undeploy the web application at the specified context path.
|
protected boolean |
undeployDir(java.io.File dir)
Delete the specified directory, including all of its contents and
subdirectories recursively.
|
protected void |
uploadWar(java.io.PrintWriter writer,
HttpServletRequest request,
java.io.File war,
StringManager smClient)
Upload the WAR file included in this request, and store it at the
specified file location.
|
protected static boolean |
validateContextName(ContextName cn,
java.io.PrintWriter writer,
StringManager sm) |
protected void |
vmInfo(java.io.PrintWriter writer,
StringManager smClient,
java.util.Enumeration<java.util.Locale> requestedLocales)
Write some VM info
|
doDelete, doHead, doOptions, doPost, doTrace, getLastModified, service, service
getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, log, log
protected java.io.File configBase
protected transient Context context
protected int debug
protected java.io.File versioned
protected transient Host host
protected transient javax.management.MBeanServer mBeanServer
protected javax.management.ObjectName oname
protected transient javax.naming.Context global
NamingContext
for this server,
if available.protected static final StringManager sm
protected transient Wrapper wrapper
public Wrapper getWrapper()
getWrapper
in interface ContainerServlet
public void setWrapper(Wrapper wrapper)
setWrapper
in interface ContainerServlet
wrapper
- The new wrapperpublic void destroy()
destroy
in interface Servlet
destroy
in class GenericServlet
public void doGet(HttpServletRequest request, HttpServletResponse response) throws java.io.IOException, ServletException
doGet
in class HttpServlet
request
- The servlet request we are processingresponse
- The servlet response we are creatingjava.io.IOException
- if an input/output error occursServletException
- if a servlet-specified error occursServletResponse.setContentType(java.lang.String)
public void doPut(HttpServletRequest request, HttpServletResponse response) throws java.io.IOException, ServletException
doPut
in class HttpServlet
request
- The servlet request we are processingresponse
- The servlet response we are creatingjava.io.IOException
- if an input/output error occursServletException
- if a servlet-specified error occurspublic void init() throws ServletException
init
in class GenericServlet
ServletException
- if an exception occurs that interrupts the servlet's
normal operationprotected void findleaks(boolean statusLine, java.io.PrintWriter writer, StringManager smClient)
protected void vmInfo(java.io.PrintWriter writer, StringManager smClient, java.util.Enumeration<java.util.Locale> requestedLocales)
writer
- protected void threadDump(java.io.PrintWriter writer, StringManager smClient, java.util.Enumeration<java.util.Locale> requestedLocales)
writer
- protected void sslConnectorCiphers(java.io.PrintWriter writer, StringManager smClient)
protected void save(java.io.PrintWriter writer, java.lang.String path, StringManager smClient)
writer
- Destination for any user message(s) during this operationpath
- Optional context path to savesmClient
- i18n support for current client's localeprotected void deploy(java.io.PrintWriter writer, ContextName cn, java.lang.String tag, boolean update, HttpServletRequest request, StringManager smClient)
writer
- Writer to render results tocn
- Name of the application to be installedtag
- Tag to be associated with the webappupdate
- Flag that indicates that any existing app should be
replacedrequest
- Servlet request we are processingsmClient
- i18n messages using the locale of the clientprotected void deploy(java.io.PrintWriter writer, ContextName cn, java.lang.String tag, StringManager smClient)
writer
- Writer to render results totag
- Revision tag to deploy fromcn
- Name of the application to be installedsmClient
- i18n messages using the locale of the clientprotected void deploy(java.io.PrintWriter writer, java.lang.String config, ContextName cn, java.lang.String war, boolean update, StringManager smClient)
writer
- Writer to render results toconfig
- URL of the context configuration file to be installedcn
- Name of the application to be installedwar
- URL of the web application archive to be installedupdate
- true to override any existing webapp on the pathsmClient
- i18n messages using the locale of the clientprotected void list(java.io.PrintWriter writer, StringManager smClient)
writer
- Writer to render toprotected void reload(java.io.PrintWriter writer, ContextName cn, StringManager smClient)
writer
- Writer to render tocn
- Name of the application to be restartedprotected void resources(java.io.PrintWriter writer, java.lang.String type, StringManager smClient)
type
- Fully qualified class name of the resource type of interest,
or null
to list resources of all typesprotected void printResources(java.io.PrintWriter writer, java.lang.String prefix, javax.naming.Context namingContext, java.lang.String type, java.lang.Class<?> clazz, StringManager smClient)
protected void serverinfo(java.io.PrintWriter writer, StringManager smClient)
writer
- Writer to render toprotected void sessions(java.io.PrintWriter writer, ContextName cn, int idle, StringManager smClient)
writer
- Writer to render tocn
- Name of the application to list session information foridle
- Expire all sessions with idle time > idle for this contextprotected void expireSessions(java.io.PrintWriter writer, ContextName cn, HttpServletRequest req, StringManager smClient)
cn
- req
- protected void start(java.io.PrintWriter writer, ContextName cn, StringManager smClient)
writer
- Writer to render tocn
- Name of the application to be startedprotected void stop(java.io.PrintWriter writer, ContextName cn, StringManager smClient)
writer
- Writer to render tocn
- Name of the application to be stoppedprotected void undeploy(java.io.PrintWriter writer, ContextName cn, StringManager smClient)
writer
- Writer to render tocn
- Name of the application to be removedprotected boolean isDeployed(java.lang.String name) throws java.lang.Exception
java.lang.Exception
protected void check(java.lang.String name) throws java.lang.Exception
java.lang.Exception
protected boolean isServiced(java.lang.String name) throws java.lang.Exception
java.lang.Exception
protected void addServiced(java.lang.String name) throws java.lang.Exception
java.lang.Exception
protected void removeServiced(java.lang.String name) throws java.lang.Exception
java.lang.Exception
protected boolean undeployDir(java.io.File dir)
dir
- File object representing the directory to be deleted.protected void uploadWar(java.io.PrintWriter writer, HttpServletRequest request, java.io.File war, StringManager smClient) throws java.io.IOException
writer
- Writer to render torequest
- The servlet request we are processingwar
- The file into which we should store the uploaded WARsmClient
- The StringManager used to construct i18n messages based
on the Locale of the clientjava.io.IOException
- if an I/O error occurs during processingprotected static boolean validateContextName(ContextName cn, java.io.PrintWriter writer, StringManager sm)
public static boolean copy(java.io.File src, java.io.File dest)
src
- File object representing the sourcedest
- File object representing the destinationpublic static boolean copyInternal(java.io.File src, java.io.File dest, byte[] buf)
src
- File object representing the sourcedest
- File object representing the destinationprotected java.util.Map<java.lang.String,java.util.List<java.lang.String>> getConnectorCiphers()
Copyright © 2000-2018 Apache Software Foundation. All Rights Reserved.