|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.apache.catalina.core.ContainerBase | +--org.apache.catalina.core.StandardWrapper
Standard implementation of the Wrapper interface that represents an individual servlet definition. No child Containers are allowed, and the parent Container must be a Context.
Field Summary |
Fields inherited from class org.apache.catalina.core.ContainerBase |
children, cluster, debug, lifecycle, listeners, loader, logger, manager, mapper, mapperClass, mappers, name, parent, parentClassLoader, pipeline, realm, resources, sm, started, support |
Fields inherited from interface org.apache.catalina.Container |
ADD_CHILD_EVENT, ADD_MAPPER_EVENT, ADD_VALVE_EVENT, REMOVE_CHILD_EVENT, REMOVE_MAPPER_EVENT, REMOVE_VALVE_EVENT |
Fields inherited from interface org.apache.catalina.Lifecycle |
START_EVENT, STOP_EVENT |
Constructor Summary | |
StandardWrapper()
Create a new StandardWrapper component with the default basic Valve. |
Method Summary | |
void |
addChild(Container child)
Refuse to add a child Container, because Wrappers are the lowest level of the Container hierarchy. |
protected void |
addDefaultMapper(java.lang.String mapperClass)
Add a default Mapper implementation if none have been configured explicitly. |
void |
addInitParameter(java.lang.String name,
java.lang.String value)
Add a new servlet initialization parameter for this servlet. |
void |
addInstanceListener(InstanceListener listener)
Add a new listener interested in InstanceEvents. |
void |
addSecurityReference(java.lang.String name,
java.lang.String link)
Add a new security role reference record to the set of records for this servlet. |
javax.servlet.Servlet |
allocate()
Allocate an initialized instance of this Servlet that is ready to have its service() method called. |
void |
deallocate(javax.servlet.Servlet servlet)
Return this previously allocated servlet to the pool of available instances. |
java.lang.String |
findInitParameter(java.lang.String name)
Return the value for the specified initialization parameter name, if any; otherwise return null . |
java.lang.String[] |
findInitParameters()
Return the names of all defined initialization parameters for this servlet. |
java.lang.String |
findSecurityReference(java.lang.String name)
Return the security role link for the specified security role reference name, if any; otherwise return null . |
java.lang.String[] |
findSecurityReferences()
Return the set of security role reference names associated with this servlet, if any; otherwise return a zero-length array. |
long |
getAvailable()
Return the available date/time for this servlet, in milliseconds since the epoch. |
int |
getCountAllocated()
Return the number of active allocations of this servlet, even if they are all for the same instance (as will be true for servlets that do not implement SingleThreadModel . |
int |
getDebug()
Return the debugging detail level for this component. |
java.lang.String |
getInfo()
Return descriptive information about this Container implementation and the corresponding version number, in the format <description>/<version> . |
java.lang.String |
getInitParameter(java.lang.String name)
Return the initialization parameter value for the specified name, if any; otherwise return null . |
java.util.Enumeration |
getInitParameterNames()
Return the set of initialization parameter names defined for this servlet. |
InstanceSupport |
getInstanceSupport()
Return the InstanceSupport object for this Wrapper instance. |
java.lang.String |
getJspFile()
Return the context-relative URI of the JSP file for this servlet. |
int |
getLoadOnStartup()
Return the load-on-startup order value (negative value means load on first call). |
int |
getMaxInstances()
Return maximum number of instances that will be allocated when a single thread model servlet is used. |
java.lang.String |
getRunAs()
Return the run-as identity for this servlet. |
java.lang.String |
getServletClass()
Return the fully qualified servlet class name for this servlet. |
javax.servlet.ServletContext |
getServletContext()
Return the servlet context with which this servlet is associated. |
java.lang.String |
getServletName()
Return the name of this servlet. |
boolean |
isSingleThreadModel()
Return true if the servlet class represented by this
component implements the SingleThreadModel interface. |
boolean |
isUnavailable()
Is this servlet currently unavailable? |
void |
load()
Load and initialize an instance of this servlet, if there is not already at least one initialized instance. |
javax.servlet.Servlet |
loadServlet()
Load and initialize an instance of this servlet, if there is not already at least one initialized instance. |
protected java.lang.String |
logName()
Log the abbreviated name of this Container for logging messages. |
void |
removeInitParameter(java.lang.String name)
Remove the specified initialization parameter from this servlet. |
void |
removeInstanceListener(InstanceListener listener)
Remove a listener no longer interested in InstanceEvents. |
void |
removeSecurityReference(java.lang.String name)
Remove any security role reference for the specified role name. |
void |
setAvailable(long available)
Set the available date/time for this servlet, in milliseconds since the epoch. |
void |
setDebug(int debug)
Set the debugging detail level for this component. |
void |
setJspFile(java.lang.String jspFile)
Set the context-relative URI of the JSP file for this servlet. |
void |
setLoadOnStartup(int value)
Set the load-on-startup order value (negative value means load on first call). |
void |
setLoadOnStartupString(java.lang.String value)
Set the load-on-startup order value from a (possibly null) string. |
void |
setMaxInstances(int maxInstances)
Set the maximum number of instances that will be allocated when a single thread model servlet is used. |
void |
setParent(Container container)
Set the parent Container of this Wrapper, but only if it is a Context. |
void |
setRunAs(java.lang.String runAs)
Set the run-as identity for this servlet. |
void |
setServletClass(java.lang.String servletClass)
Set the fully qualified servlet class name for this servlet. |
void |
setServletName(java.lang.String name)
Set the name of this servlet. |
void |
start()
Start this component, pre-loading the servlet if the load-on-startup value is set appropriately. |
void |
stop()
Stop this component, gracefully shutting down the servlet if it has been initialized. |
java.lang.String |
toString()
Return a String representation of this component. |
void |
unavailable(javax.servlet.UnavailableException unavailable)
Process an UnavailableException, marking this servlet as unavailable for the specified amount of time. |
void |
unload()
Unload all initialized instances of this servlet, after calling the destroy() method for each instance. |
Methods inherited from class org.apache.catalina.core.ContainerBase |
addContainerListener, addLifecycleListener, addMapper, addPropertyChangeListener, addValve, findChild, findChildren, findMapper, findMappers, fireContainerEvent, getBasic, getCluster, getLoader, getLogger, getManager, getName, getParent, getParentClassLoader, getPipeline, getRealm, getResources, getValves, invoke, log, log, map, removeChild, removeContainerListener, removeLifecycleListener, removeMapper, removePropertyChangeListener, removeValve, setBasic, setCluster, setLoader, setLogger, setManager, setName, setParentClassLoader, setRealm, setResources |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface org.apache.catalina.Container |
addContainerListener, addMapper, addPropertyChangeListener, findChild, findChildren, findMapper, findMappers, getCluster, getLoader, getLogger, getManager, getName, getParent, getParentClassLoader, getRealm, getResources, invoke, map, removeChild, removeContainerListener, removeMapper, removePropertyChangeListener, setCluster, setLoader, setLogger, setManager, setName, setParentClassLoader, setRealm, setResources |
Constructor Detail |
public StandardWrapper()
Method Detail |
public long getAvailable()
getAvailable
in interface Wrapper
public void setAvailable(long available)
setAvailable
in interface Wrapper
available
- The new available date/timepublic int getCountAllocated()
SingleThreadModel
.
public int getDebug()
getDebug
in class ContainerBase
public void setDebug(int debug)
setDebug
in class ContainerBase
debug
- The new debugging detail levelpublic java.lang.String getInfo()
<description>/<version>
.
getInfo
in interface Container
getInfo
in class ContainerBase
public InstanceSupport getInstanceSupport()
public java.lang.String getJspFile()
getJspFile
in interface Wrapper
public void setJspFile(java.lang.String jspFile)
setJspFile
in interface Wrapper
jspFile
- JSP file URIpublic int getLoadOnStartup()
getLoadOnStartup
in interface Wrapper
public void setLoadOnStartup(int value)
setLoadOnStartup
in interface Wrapper
value
- New load-on-startup valuepublic void setLoadOnStartupString(java.lang.String value)
value
- New load-on-startup valuepublic int getMaxInstances()
public void setMaxInstances(int maxInstances)
public void setParent(Container container)
setParent
in interface Container
setParent
in class ContainerBase
container
- Proposed parent Containerpublic java.lang.String getRunAs()
getRunAs
in interface Wrapper
public void setRunAs(java.lang.String runAs)
setRunAs
in interface Wrapper
public java.lang.String getServletClass()
getServletClass
in interface Wrapper
public void setServletClass(java.lang.String servletClass)
setServletClass
in interface Wrapper
servletClass
- Servlet class namepublic void setServletName(java.lang.String name)
Container.setName()
method, and complements the
getServletName()
method required by the
ServletConfig
interface.
name
- The new name of this servletpublic boolean isSingleThreadModel()
true
if the servlet class represented by this
component implements the SingleThreadModel
interface.
public boolean isUnavailable()
isUnavailable
in interface Wrapper
public void addChild(Container child)
addChild
in interface Container
addChild
in class ContainerBase
child
- Child container to be addedpublic void addInitParameter(java.lang.String name, java.lang.String value)
addInitParameter
in interface Wrapper
name
- Name of this initialization parameter to addvalue
- Value of this initialization parameter to addpublic void addInstanceListener(InstanceListener listener)
addInstanceListener
in interface Wrapper
listener
- The new listenerpublic void addSecurityReference(java.lang.String name, java.lang.String link)
addSecurityReference
in interface Wrapper
name
- Role name used within this servletlink
- Role name used within the web applicationpublic javax.servlet.Servlet allocate() throws javax.servlet.ServletException
service()
method called. If the servlet class does
not implement SingleThreadModel
, the (only) initialized
instance may be returned immediately. If the servlet class implements
SingleThreadModel
, the Wrapper implementation must ensure
that this instance is not allocated again until it is deallocated by a
call to deallocate()
.
allocate
in interface Wrapper
javax.servlet.ServletException
- if the servlet init() method threw
an exception
javax.servlet.ServletException
- if a loading error occurspublic void deallocate(javax.servlet.Servlet servlet) throws javax.servlet.ServletException
deallocate
in interface Wrapper
servlet
- The servlet to be returned
javax.servlet.ServletException
- if a deallocation error occurspublic java.lang.String findInitParameter(java.lang.String name)
null
.
findInitParameter
in interface Wrapper
name
- Name of the requested initialization parameterpublic java.lang.String[] findInitParameters()
findInitParameters
in interface Wrapper
public java.lang.String findSecurityReference(java.lang.String name)
null
.
findSecurityReference
in interface Wrapper
name
- Security role reference used within this servletpublic java.lang.String[] findSecurityReferences()
findSecurityReferences
in interface Wrapper
public void load() throws javax.servlet.ServletException
IMPLEMENTATION NOTE: Servlets whose classnames begin with
org.apache.catalina.
(so-called "container" servlets)
are loaded by the same classloader that loaded this class, rather than
the classloader for the current web application.
This gives such classes access to Catalina internals, which are
prevented for classes loaded for web applications.
load
in interface Wrapper
javax.servlet.ServletException
- if the servlet init() method threw
an exception
javax.servlet.ServletException
- if some other loading problem occurspublic javax.servlet.Servlet loadServlet() throws javax.servlet.ServletException
javax.servlet.ServletException
public void removeInitParameter(java.lang.String name)
removeInitParameter
in interface Wrapper
name
- Name of the initialization parameter to removepublic void removeInstanceListener(InstanceListener listener)
removeInstanceListener
in interface Wrapper
listener
- The listener to removepublic void removeSecurityReference(java.lang.String name)
removeSecurityReference
in interface Wrapper
name
- Security role used within this servlet to be removedpublic java.lang.String toString()
toString
in class java.lang.Object
public void unavailable(javax.servlet.UnavailableException unavailable)
unavailable
in interface Wrapper
unavailable
- The exception that occurred, or null
to mark this servlet as permanently unavailablepublic void unload() throws javax.servlet.ServletException
destroy()
method for each instance. This can be used,
for example, prior to shutting down the entire servlet engine, or
prior to reloading all of the classes from the Loader associated with
our Loader's repository.
unload
in interface Wrapper
javax.servlet.ServletException
- if an exception is thrown by the
destroy() methodpublic java.lang.String getInitParameter(java.lang.String name)
null
.
getInitParameter
in interface javax.servlet.ServletConfig
name
- Name of the initialization parameter to retrievepublic java.util.Enumeration getInitParameterNames()
getInitParameterNames
in interface javax.servlet.ServletConfig
public javax.servlet.ServletContext getServletContext()
getServletContext
in interface javax.servlet.ServletConfig
public java.lang.String getServletName()
getServletName
in interface javax.servlet.ServletConfig
protected void addDefaultMapper(java.lang.String mapperClass)
addDefaultMapper
in class ContainerBase
mapperClass
- Java class name of the default Mapperprotected java.lang.String logName()
logName
in class ContainerBase
public void start() throws LifecycleException
start
in interface Lifecycle
start
in class ContainerBase
LifecycleException
- if a fatal error occurs during startuppublic void stop() throws LifecycleException
stop
in interface Lifecycle
stop
in class ContainerBase
LifecycleException
- if a fatal error occurs during shutdown
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |