StandardWrapper (Apache Tomcat 8.0.53 API Documentation)

java.lang.Object
- org.apache.catalina.util.LifecycleBase
- - org.apache.catalina.util.LifecycleMBeanBase
  - - org.apache.catalina.core.ContainerBase
    - - org.apache.catalina.core.StandardWrapper

All Implemented Interfaces:

javax.management.MBeanRegistration, javax.management.NotificationBroadcaster, javax.management.NotificationEmitter, ServletConfig, Container, JmxEnabled, Lifecycle, Wrapper

Direct Known Subclasses:

Tomcat.ExistingStandardWrapper
```
public class StandardWrapper
extends ContainerBase
implements ServletConfig, Wrapper, javax.management.NotificationEmitter
```
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.

Author:

Craig R. McClanahan, Remy Maucherat

Nested Class Summary
- Nested classes/interfaces inherited from class org.apache.catalina.core.ContainerBase
  ContainerBase.ContainerBackgroundProcessor, ContainerBase.PrivilegedAddChild
- Nested classes/interfaces inherited from interface org.apache.catalina.Lifecycle
  Lifecycle.SingleUse

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`asyncSupported` Async support
`protected long`	`available` The date and time at which this servlet will become available (in milliseconds since the epoch), or zero if the servlet is available.
`protected javax.management.NotificationBroadcasterSupport`	`broadcaster` The broadcaster that sends j2ee notifications.
`protected int`	`classLoadTime`
`protected static java.lang.Class<?>[]`	`classType` Static class array used when the SecurityManager is turned on and `Servlet.init` is invoked.
`protected java.util.concurrent.atomic.AtomicInteger`	`countAllocated` The count of allocations that are currently active (even if they are for the same instance, as will be true on a non-STM servlet).
`protected static java.lang.String[]`	`DEFAULT_SERVLET_METHODS`
`protected boolean`	`enabled` Enabled
`protected StandardWrapperFacade`	`facade` The facade associated with this wrapper.
`protected Servlet`	`instance` The (single) possibly uninitialized instance of this servlet.
`protected boolean`	`instanceInitialized` Flag that indicates if this instance has been initialized
`protected java.util.Stack<Servlet>`	`instancePool` Stack containing the STM instances.
`protected InstanceSupport`	`instanceSupport` Deprecated. Will be removed in 8.5.x onwards
`protected boolean`	`isJspServlet` True if this StandardWrapper is for the JspServlet
`protected javax.management.ObjectName`	`jspMonitorON` The ObjectName of the JSP monitoring mbean
`protected int`	`loadOnStartup` The load-on-startup order value (negative value means load on first call) for this servlet.
`protected long`	`loadTime`
`protected java.util.ArrayList<java.lang.String>`	`mappings` Mappings associated with the wrapper.
`protected int`	`maxInstances` Maximum number of STM instances.
`protected MultipartConfigElement`	`multipartConfigElement` Multipart config
`protected int`	`nInstances` Number of instances currently loaded for a STM servlet.
`protected javax.management.MBeanNotificationInfo[]`	`notificationInfo`
`protected java.util.HashMap<java.lang.String,java.lang.String>`	`parameters` The initialization parameters for this servlet, keyed by parameter name.
`protected java.util.HashMap<java.lang.String,java.lang.String>`	`references` The security role references for this servlet, keyed by role name used in the servlet.
`protected java.lang.String`	`runAs` The run-as identity for this servlet.
`protected long`	`sequenceNumber` The notification sequence number.
`protected java.lang.String`	`servletClass` The fully qualified servlet class name for this servlet.
`protected boolean`	`singleThreadModel` Does this servlet implement the SingleThreadModel interface?
`protected boolean`	`swallowOutput` Should we swallow System.out
`protected org.apache.catalina.core.StandardWrapperValve`	`swValve`
`protected long`	`unloadDelay` Wait time for servlet unload in ms.
`protected boolean`	`unloading` Are we unloading our servlet instance at the moment?

Fields inherited from class org.apache.catalina.core.ContainerBase
accessLog, backgroundProcessorDelay, children, cluster, listeners, logger, logName, name, parent, parentClassLoader, pipeline, sm, startChildren, startStopExecutor, support

Fields inherited from class org.apache.catalina.util.LifecycleMBeanBase
mserver

Fields inherited from interface org.apache.catalina.Wrapper
ADD_MAPPING_EVENT, REMOVE_MAPPING_EVENT

Fields inherited from interface org.apache.catalina.Container
ADD_CHILD_EVENT, ADD_VALVE_EVENT, REMOVE_CHILD_EVENT, REMOVE_VALVE_EVENT

Fields inherited from interface org.apache.catalina.Lifecycle
AFTER_DESTROY_EVENT, AFTER_INIT_EVENT, AFTER_START_EVENT, AFTER_STOP_EVENT, BEFORE_DESTROY_EVENT, BEFORE_INIT_EVENT, BEFORE_START_EVENT, BEFORE_STOP_EVENT, CONFIGURE_START_EVENT, CONFIGURE_STOP_EVENT, PERIODIC_EVENT, START_EVENT, STOP_EVENT

Constructor Summary

Constructors
Constructor and Description

StandardWrapper()
Create a new StandardWrapper component with the default basic Valve.

Constructors
Constructor and Description
`StandardWrapper()` Create a new StandardWrapper component with the default basic Valve.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addChild(Container child)` Refuse to add a child Container, because Wrappers are the lowest level of the Container hierarchy.
`void`	`addInitParameter(java.lang.String name, java.lang.String value)` Add a new servlet initialization parameter for this servlet.
`void`	`addInstanceListener(InstanceListener listener)` Deprecated. Will be removed in 8.5.x onwards
`void`	`addMapping(java.lang.String mapping)` Add a mapping associated with the Wrapper.
`void`	`addNotificationListener(javax.management.NotificationListener listener, javax.management.NotificationFilter filter, java.lang.Object object)`
`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.
`Servlet`	`allocate()` Allocate an initialized instance of this Servlet that is ready to have its `service()` method called.
`void`	`backgroundProcess()` Execute a periodic task, such as reloading, etc.
`void`	`deallocate(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[]`	`findMappings()` Return the mappings associated with this wrapper.
`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.
`protected java.lang.reflect.Method[]`	`getAllDeclaredMethods(java.lang.Class<?> c)`
`long`	`getAvailable()` Return the available date/time for this servlet, in milliseconds since the epoch.
`int`	`getClassLoadTime()`
`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`	`getErrorCount()`
`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<java.lang.String>`	`getInitParameterNames()` Return the set of initialization parameter names defined for this servlet.
`InstanceSupport`	`getInstanceSupport()` Deprecated. Will be removed in 8.5.x onwards
`int`	`getLoadOnStartup()` Return the load-on-startup order value (negative value means load on first call).
`java.lang.String`	`getLoadOnStartupString()`
`long`	`getLoadTime()`
`int`	`getMaxInstances()` Return maximum number of instances that will be allocated when a single thread model servlet is used.
`long`	`getMaxTime()`
`long`	`getMinTime()`
`MultipartConfigElement`	`getMultipartConfigElement()` Get the multi-part configuration for the associated servlet.
`javax.management.MBeanNotificationInfo[]`	`getNotificationInfo()`
`protected java.lang.String`	`getObjectNameKeyProperties()` Allow sub-classes to specify the key properties component of the `ObjectName` that will be used to register this component.
`long`	`getProcessingTime()`
`int`	`getRequestCount()`
`static java.lang.Throwable`	`getRootCause(ServletException e)` Extract the root cause from a servlet exception.
`java.lang.String`	`getRunAs()` Return the run-as identity for this servlet.
`Servlet`	`getServlet()` Return the associated servlet instance.
`java.lang.String`	`getServletClass()` Return the fully qualified servlet class name for this servlet.
`ServletContext`	`getServletContext()` Return the servlet context with which this servlet is associated.
`java.lang.String[]`	`getServletMethods()` Gets the names of the methods supported by the underlying servlet.
`java.lang.String`	`getServletName()` Return the name of this servlet.
`void`	`incrementErrorCount()` Increment the error count used for monitoring.
`boolean`	`isAsyncSupported()` Does the associated Servlet support async processing?
`protected boolean`	`isContainerProvidedServlet(java.lang.String classname)` Return `true` if the specified class name represents a container provided servlet class that should be loaded by the server class loader.
`boolean`	`isEnabled()` Is the associated Servlet enabled?
`boolean`	`isOverridable()` Is the Servlet overridable by a ServletContainerInitializer?
`java.lang.Boolean`	`isSingleThreadModel()` Does the servlet class represented by this component implement the `SingleThreadModel` interface?
`boolean`	`isStateManageable()` Deprecated. The JSR-77 implementation is incomplete and will be removed in 8.5.x
`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.
`Servlet`	`loadServlet()` Load and initialize an instance of this servlet, if there is not already at least one initialized instance.
`void`	`removeInitParameter(java.lang.String name)` Remove the specified initialization parameter from this servlet.
`void`	`removeInstanceListener(InstanceListener listener)` Deprecated. Will be removed in 8.5.x onwards
`void`	`removeMapping(java.lang.String mapping)` Remove a mapping associated with the wrapper.
`void`	`removeNotificationListener(javax.management.NotificationListener listener)` Remove a JMX-NotificationListener
`void`	`removeNotificationListener(javax.management.NotificationListener listener, javax.management.NotificationFilter filter, java.lang.Object object)`
`void`	`removeSecurityReference(java.lang.String name)` Remove any security role reference for the specified role name.
`void`	`servletSecurityAnnotationScan()` This method is no longer used.
`void`	`setAsyncSupported(boolean asyncSupported)` Set the async support for the associated servlet.
`void`	`setAvailable(long available)` Set the available date/time for this servlet, in milliseconds since the epoch.
`void`	`setEnabled(boolean enabled)` Sets the enabled attribute for the associated 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`	`setMultipartConfigElement(MultipartConfigElement multipartConfigElement)` Set the multi-part configuration for the associated servlet.
`void`	`setOverridable(boolean overridable)` Sets the overridable attribute for this Servlet.
`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`	`setServlet(Servlet servlet)` Set the associated servlet instance.
`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`	`setServletSecurityAnnotationScanRequired(boolean b)` This method is no longer used.
`protected void`	`startInternal()` Start this component and implement the requirements of `LifecycleBase.startInternal()`.
`protected void`	`stopInternal()` Stop this component and implement the requirements of `LifecycleBase.stopInternal()`.
`java.lang.String`	`toString()` Return a String representation of this component.
`void`	`unavailable(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.util.LifecycleMBeanBase
getDomain, getObjectName, postDeregister, postRegister, preDeregister, preRegister, register, setDomain, unregister

Methods inherited from class org.apache.catalina.util.LifecycleBase
addLifecycleListener, destroy, findLifecycleListeners, fireLifecycleEvent, getState, getStateName, init, removeLifecycleListener, setState, setState, start, stop

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.catalina.Lifecycle
addLifecycleListener, destroy, findLifecycleListeners, getState, getStateName, init, removeLifecycleListener, start, stop

- Field Detail
  - DEFAULT_SERVLET_METHODS
```
protected static final java.lang.String[] DEFAULT_SERVLET_METHODS
```
  - available
```
protected long available
```
    The date and time at which this servlet will become available (in milliseconds since the epoch), or zero if the servlet is available. If this value equals Long.MAX_VALUE, the unavailability of this servlet is considered permanent.
  - broadcaster
```
protected final javax.management.NotificationBroadcasterSupport broadcaster
```
    The broadcaster that sends j2ee notifications.
  - countAllocated
```
protected final java.util.concurrent.atomic.AtomicInteger countAllocated
```
    The count of allocations that are currently active (even if they are for the same instance, as will be true on a non-STM servlet).
  - facade
```
protected final StandardWrapperFacade facade
```
    The facade associated with this wrapper.
  - instance
```
protected volatile Servlet instance
```
    The (single) possibly uninitialized instance of this servlet.
  - instanceInitialized
```
protected volatile boolean instanceInitialized
```
    Flag that indicates if this instance has been initialized
  - instanceSupport
```
@Deprecated
protected final InstanceSupport instanceSupport
```
    Deprecated. Will be removed in 8.5.x onwards
    
    The support object for our instance listeners.
  - loadOnStartup
```
protected int loadOnStartup
```
    The load-on-startup order value (negative value means load on first call) for this servlet.
  - mappings
```
protected final java.util.ArrayList<java.lang.String> mappings
```
    Mappings associated with the wrapper.
  - parameters
```
protected java.util.HashMap<java.lang.String,java.lang.String> parameters
```
    The initialization parameters for this servlet, keyed by parameter name.
  - references
```
protected java.util.HashMap<java.lang.String,java.lang.String> references
```
    The security role references for this servlet, keyed by role name used in the servlet. The corresponding value is the role name of the web application itself.
  - runAs
```
protected java.lang.String runAs
```
    The run-as identity for this servlet.
  - sequenceNumber
```
protected long sequenceNumber
```
    The notification sequence number.
  - servletClass
```
protected java.lang.String servletClass
```
    The fully qualified servlet class name for this servlet.
  - singleThreadModel
```
protected volatile boolean singleThreadModel
```
    Does this servlet implement the SingleThreadModel interface?
  - unloading
```
protected volatile boolean unloading
```
    Are we unloading our servlet instance at the moment?
  - maxInstances
```
protected int maxInstances
```
    Maximum number of STM instances.
  - nInstances
```
protected int nInstances
```
    Number of instances currently loaded for a STM servlet.
  - instancePool
```
protected java.util.Stack<Servlet> instancePool
```
    Stack containing the STM instances.
  - unloadDelay
```
protected long unloadDelay
```
    Wait time for servlet unload in ms.
  - isJspServlet
```
protected boolean isJspServlet
```
    True if this StandardWrapper is for the JspServlet
  - jspMonitorON
```
protected javax.management.ObjectName jspMonitorON
```
    The ObjectName of the JSP monitoring mbean
  - swallowOutput
```
protected boolean swallowOutput
```
    Should we swallow System.out
  - swValve
```
protected org.apache.catalina.core.StandardWrapperValve swValve
```
  - loadTime
```
protected long loadTime
```
  - classLoadTime
```
protected int classLoadTime
```
  - multipartConfigElement
```
protected MultipartConfigElement multipartConfigElement
```
    Multipart config
  - asyncSupported
```
protected boolean asyncSupported
```
    Async support
  - enabled
```
protected boolean enabled
```
    Enabled
  - classType
```
protected static java.lang.Class<?>[] classType
```
    Static class array used when the SecurityManager is turned on and Servlet.init is invoked.
  - notificationInfo
```
protected javax.management.MBeanNotificationInfo[] notificationInfo
```
- Constructor Detail
  - StandardWrapper
```
public StandardWrapper()
```
    Create a new StandardWrapper component with the default basic Valve.
- Method Detail
  - isOverridable
```
public boolean isOverridable()
```
    Description copied from interface: Wrapper
    
    Is the Servlet overridable by a ServletContainerInitializer?
    
    Specified by:
    
    isOverridable in interface Wrapper
  - setOverridable
```
public void setOverridable(boolean overridable)
```
    Description copied from interface: Wrapper
    
    Sets the overridable attribute for this Servlet.
    
    Specified by:
    
    setOverridable in interface Wrapper
  - getAvailable
```
public long getAvailable()
```
    Return the available date/time for this servlet, in milliseconds since the epoch. If this date/time is Long.MAX_VALUE, it is considered to mean that unavailability is permanent and any request for this servlet will return an SC_NOT_FOUND error. If this date/time is in the future, any request for this servlet will return an SC_SERVICE_UNAVAILABLE error. If it is zero, the servlet is currently available.
    
    Specified by:
    
    getAvailable in interface Wrapper
  - setAvailable
```
public void setAvailable(long available)
```
    Set the available date/time for this servlet, in milliseconds since the epoch. If this date/time is Long.MAX_VALUE, it is considered to mean that unavailability is permanent and any request for this servlet will return an SC_NOT_FOUND error. If this date/time is in the future, any request for this servlet will return an SC_SERVICE_UNAVAILABLE error.
    
    Specified by:
    
    setAvailable in interface Wrapper
    
    Parameters:
    available - The new available date/time
  - getCountAllocated
```
public 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.
  - getInstanceSupport
```
@Deprecated
public InstanceSupport getInstanceSupport()
```
    Deprecated. Will be removed in 8.5.x onwards
    
    Return the InstanceSupport object for this Wrapper instance.
  - getLoadOnStartup
```
public int getLoadOnStartup()
```
    Return the load-on-startup order value (negative value means load on first call).
    
    Specified by:
    
    getLoadOnStartup in interface Wrapper
  - setLoadOnStartup
```
public void setLoadOnStartup(int value)
```
    Set the load-on-startup order value (negative value means load on first call).
    
    Specified by:
    
    setLoadOnStartup in interface Wrapper
    
    Parameters:
    value - New load-on-startup value
  - setLoadOnStartupString
```
public void setLoadOnStartupString(java.lang.String value)
```
    Set the load-on-startup order value from a (possibly null) string. Per the specification, any missing or non-numeric value is converted to a zero, so that this servlet will still be loaded at startup time, but in an arbitrary order.
    
    Parameters:
    value - New load-on-startup value
  - getLoadOnStartupString
```
public java.lang.String getLoadOnStartupString()
```
  - getMaxInstances
```
public int getMaxInstances()
```
    Return maximum number of instances that will be allocated when a single thread model servlet is used.
  - setMaxInstances
```
public void setMaxInstances(int maxInstances)
```
    Set the maximum number of instances that will be allocated when a single thread model servlet is used.
    
    Parameters:
    maxInstances - New value of maxInstances
  - setParent
```
public void setParent(Container container)
```
    Set the parent Container of this Wrapper, but only if it is a Context.
    
    Specified by:
    
    setParent in interface Container
    
    Overrides:
    
    setParent in class ContainerBase
    
    Parameters:
    container - Proposed parent Container
  - getRunAs
```
public java.lang.String getRunAs()
```
    Return the run-as identity for this servlet.
    
    Specified by:
    
    getRunAs in interface Wrapper
  - setRunAs
```
public void setRunAs(java.lang.String runAs)
```
    Set the run-as identity for this servlet.
    
    Specified by:
    
    setRunAs in interface Wrapper
    
    Parameters:
    runAs - New run-as identity value
  - getServletClass
```
public java.lang.String getServletClass()
```
    Return the fully qualified servlet class name for this servlet.
    
    Specified by:
    
    getServletClass in interface Wrapper
  - setServletClass
```
public void setServletClass(java.lang.String servletClass)
```
    Set the fully qualified servlet class name for this servlet.
    
    Specified by:
    
    setServletClass in interface Wrapper
    
    Parameters:
    servletClass - Servlet class name
  - setServletName
```
public void setServletName(java.lang.String name)
```
    Set the name of this servlet. This is an alias for the normal Container.setName() method, and complements the getServletName() method required by the ServletConfig interface.
    
    Parameters:
    name - The new name of this servlet
  - isSingleThreadModel
```
public java.lang.Boolean isSingleThreadModel()
```
    Does the servlet class represented by this component implement the SingleThreadModel interface? This can only be determined once the class is loaded. Calling this method will not trigger loading the class since that may cause the application to behave unexpectedly.
    
    Returns:
    null if the class has not been loaded, otherwise true if the servlet does implement SingleThreadModel and false if it does not.
  - isUnavailable
```
public boolean isUnavailable()
```
    Is this servlet currently unavailable?
    
    Specified by:
    
    isUnavailable in interface Wrapper
  - getServletMethods
```
public java.lang.String[] getServletMethods()
                                     throws ServletException
```
    Description copied from interface: Wrapper
    
    Gets the names of the methods supported by the underlying servlet. This is the same set of methods included in the Allow response header in response to an OPTIONS request method processed by the underlying servlet.
    
    Specified by:
    
    getServletMethods in interface Wrapper
    
    Returns:
    Array of names of the methods supported by the underlying servlet
    
    Throws:
    
    ServletException - If the target servlet can not be loaded
  - getServlet
```
public Servlet getServlet()
```
    Return the associated servlet instance.
    
    Specified by:
    
    getServlet in interface Wrapper
  - setServlet
```
public void setServlet(Servlet servlet)
```
    Set the associated servlet instance.
    
    Specified by:
    
    setServlet in interface Wrapper
  - setServletSecurityAnnotationScanRequired
```
public void setServletSecurityAnnotationScanRequired(boolean b)
```
    This method is no longer used. All implementations should be NO-OPs.
    
    Specified by:
    
    setServletSecurityAnnotationScanRequired in interface Wrapper
    
    Parameters:
    b - Unused.
  - backgroundProcess
```
public void backgroundProcess()
```
    Execute a periodic task, such as reloading, etc. This method will be invoked inside the classloading context of this container. Unexpected throwables will be caught and logged.
    
    Specified by:
    
    backgroundProcess in interface Container
    
    Overrides:
    
    backgroundProcess in class ContainerBase
  - getRootCause
```
public static java.lang.Throwable getRootCause(ServletException e)
```
    Extract the root cause from a servlet exception.
    
    Parameters:
    e - The servlet exception
  - addChild
```
public void addChild(Container child)
```
    Refuse to add a child Container, because Wrappers are the lowest level of the Container hierarchy.
    
    Specified by:
    
    addChild in interface Container
    
    Overrides:
    
    addChild in class ContainerBase
    
    Parameters:
    child - Child container to be added
  - addInitParameter
```
public void addInitParameter(java.lang.String name,
                    java.lang.String value)
```
    Add a new servlet initialization parameter for this servlet.
    
    Specified by:
    
    addInitParameter in interface Wrapper
    
    Parameters:
    name - Name of this initialization parameter to add
    value - Value of this initialization parameter to add
  - addInstanceListener
```
@Deprecated
public void addInstanceListener(InstanceListener listener)
```
    Deprecated. Will be removed in 8.5.x onwards
    
    Add a new listener interested in InstanceEvents.
    
    Specified by:
    
    addInstanceListener in interface Wrapper
    
    Parameters:
    listener - The new listener
  - addMapping
```
public void addMapping(java.lang.String mapping)
```
    Add a mapping associated with the Wrapper.
    
    Specified by:
    
    addMapping in interface Wrapper
    
    Parameters:
    mapping - The new wrapper mapping
  - addSecurityReference
```
public 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.
    
    Specified by:
    
    addSecurityReference in interface Wrapper
    
    Parameters:
    name - Role name used within this servlet
    link - Role name used within the web application
  - allocate
```
public Servlet allocate()
                 throws ServletException
```
    Allocate an initialized instance of this Servlet that is ready to have its 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().
    
    Specified by:
    
    allocate in interface Wrapper
    
    Throws:
    
    ServletException - if the servlet init() method threw an exception
    
    ServletException - if a loading error occurs
  - deallocate
```
public void deallocate(Servlet servlet)
                throws ServletException
```
    Return this previously allocated servlet to the pool of available instances. If this servlet class does not implement SingleThreadModel, no action is actually required.
    
    Specified by:
    
    deallocate in interface Wrapper
    
    Parameters:
    servlet - The servlet to be returned
    
    Throws:
    
    ServletException - if a deallocation error occurs
  - findInitParameter
```
public java.lang.String findInitParameter(java.lang.String name)
```
    Return the value for the specified initialization parameter name, if any; otherwise return null.
    
    Specified by:
    
    findInitParameter in interface Wrapper
    
    Parameters:
    name - Name of the requested initialization parameter
  - findInitParameters
```
public java.lang.String[] findInitParameters()
```
    Return the names of all defined initialization parameters for this servlet.
    
    Specified by:
    
    findInitParameters in interface Wrapper
  - findMappings
```
public java.lang.String[] findMappings()
```
    Return the mappings associated with this wrapper.
    
    Specified by:
    
    findMappings in interface Wrapper
  - findSecurityReference
```
public 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.
    
    Specified by:
    
    findSecurityReference in interface Wrapper
    
    Parameters:
    name - Security role reference used within this servlet
  - findSecurityReferences
```
public java.lang.String[] findSecurityReferences()
```
    Return the set of security role reference names associated with this servlet, if any; otherwise return a zero-length array.
    
    Specified by:
    
    findSecurityReferences in interface Wrapper
  - load
```
public void load()
          throws ServletException
```
    Load and initialize an instance of this servlet, if there is not already at least one initialized instance. This can be used, for example, to load servlets that are marked in the deployment descriptor to be loaded at server startup time.
    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.
    
    Specified by:
    
    load in interface Wrapper
    
    Throws:
    
    ServletException - if the servlet init() method threw an exception
    
    ServletException - if some other loading problem occurs
  - loadServlet
```
public Servlet loadServlet()
                    throws ServletException
```
    Load and initialize an instance of this servlet, if there is not already at least one initialized instance. This can be used, for example, to load servlets that are marked in the deployment descriptor to be loaded at server startup time.
    
    Throws:
    
    ServletException
  - servletSecurityAnnotationScan
```
public void servletSecurityAnnotationScan()
                                   throws ServletException
```
    This method is no longer used. All implementations should be NO-OPs.
    
    Specified by:
    
    servletSecurityAnnotationScan in interface Wrapper
    
    Throws:
    
    ServletException - Never thrown
  - removeInitParameter
```
public void removeInitParameter(java.lang.String name)
```
    Remove the specified initialization parameter from this servlet.
    
    Specified by:
    
    removeInitParameter in interface Wrapper
    
    Parameters:
    name - Name of the initialization parameter to remove
  - removeInstanceListener
```
@Deprecated
public void removeInstanceListener(InstanceListener listener)
```
    Deprecated. Will be removed in 8.5.x onwards
    
    Remove a listener no longer interested in InstanceEvents.
    
    Specified by:
    
    removeInstanceListener in interface Wrapper
    
    Parameters:
    listener - The listener to remove
  - removeMapping
```
public void removeMapping(java.lang.String mapping)
```
    Remove a mapping associated with the wrapper.
    
    Specified by:
    
    removeMapping in interface Wrapper
    
    Parameters:
    mapping - The pattern to remove
  - removeSecurityReference
```
public void removeSecurityReference(java.lang.String name)
```
    Remove any security role reference for the specified role name.
    
    Specified by:
    
    removeSecurityReference in interface Wrapper
    
    Parameters:
    name - Security role used within this servlet to be removed
  - toString
```
public java.lang.String toString()
```
    Return a String representation of this component.
    
    Overrides:
    
    toString in class java.lang.Object
  - unavailable
```
public void unavailable(UnavailableException unavailable)
```
    Process an UnavailableException, marking this servlet as unavailable for the specified amount of time.
    
    Specified by:
    
    unavailable in interface Wrapper
    
    Parameters:
    unavailable - The exception that occurred, or null to mark this servlet as permanently unavailable
  - unload
```
public void unload()
            throws ServletException
```
    Unload all initialized instances of this servlet, after calling the 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.
    
    Specified by:
    
    unload in interface Wrapper
    
    Throws:
    
    ServletException - if an exception is thrown by the destroy() method
  - getInitParameter
```
public java.lang.String getInitParameter(java.lang.String name)
```
    Return the initialization parameter value for the specified name, if any; otherwise return null.
    
    Specified by:
    
    getInitParameter in interface ServletConfig
    
    Parameters:
    name - Name of the initialization parameter to retrieve
    
    Returns:
    a String containing the value of the initialization parameter
  - getInitParameterNames
```
public java.util.Enumeration<java.lang.String> getInitParameterNames()
```
    Return the set of initialization parameter names defined for this servlet. If none are defined, an empty Enumeration is returned.
    
    Specified by:
    
    getInitParameterNames in interface ServletConfig
    
    Returns:
    an Enumeration of String objects containing the names of the servlet's initialization parameters
  - getServletContext
```
public ServletContext getServletContext()
```
    Return the servlet context with which this servlet is associated.
    
    Specified by:
    
    getServletContext in interface ServletConfig
    
    Returns:
    a ServletContext object, used by the caller to interact with its servlet container
    See Also:
    ServletContext
  - getServletName
```
public java.lang.String getServletName()
```
    Return the name of this servlet.
    
    Specified by:
    
    getServletName in interface ServletConfig
    
    Returns:
    the name of the servlet instance
  - getProcessingTime
```
public long getProcessingTime()
```
  - getMaxTime
```
public long getMaxTime()
```
  - getMinTime
```
public long getMinTime()
```
  - getRequestCount
```
public int getRequestCount()
```
  - getErrorCount
```
public int getErrorCount()
```
  - incrementErrorCount
```
public void incrementErrorCount()
```
    Increment the error count used for monitoring.
    
    Specified by:
    
    incrementErrorCount in interface Wrapper
  - getLoadTime
```
public long getLoadTime()
```
  - getClassLoadTime
```
public int getClassLoadTime()
```
  - getMultipartConfigElement
```
public MultipartConfigElement getMultipartConfigElement()
```
    Description copied from interface: Wrapper
    
    Get the multi-part configuration for the associated servlet. If no multi-part configuration has been defined, then null will be returned.
    
    Specified by:
    
    getMultipartConfigElement in interface Wrapper
  - setMultipartConfigElement
```
public void setMultipartConfigElement(MultipartConfigElement multipartConfigElement)
```
    Description copied from interface: Wrapper
    
    Set the multi-part configuration for the associated servlet. To clear the multi-part configuration specify null as the new value.
    
    Specified by:
    
    setMultipartConfigElement in interface Wrapper
  - isAsyncSupported
```
public boolean isAsyncSupported()
```
    Description copied from interface: Wrapper
    
    Does the associated Servlet support async processing? Defaults to false.
    
    Specified by:
    
    isAsyncSupported in interface Wrapper
  - setAsyncSupported
```
public void setAsyncSupported(boolean asyncSupported)
```
    Description copied from interface: Wrapper
    
    Set the async support for the associated servlet.
    
    Specified by:
    
    setAsyncSupported in interface Wrapper
  - isEnabled
```
public boolean isEnabled()
```
    Description copied from interface: Wrapper
    
    Is the associated Servlet enabled? Defaults to true.
    
    Specified by:
    
    isEnabled in interface Wrapper
  - setEnabled
```
public void setEnabled(boolean enabled)
```
    Description copied from interface: Wrapper
    
    Sets the enabled attribute for the associated servlet.
    
    Specified by:
    
    setEnabled in interface Wrapper
  - isContainerProvidedServlet
```
protected boolean isContainerProvidedServlet(java.lang.String classname)
```
    Return true if the specified class name represents a container provided servlet class that should be loaded by the server class loader.
    
    Parameters:
    classname - Name of the class to be checked
  - getAllDeclaredMethods
```
protected java.lang.reflect.Method[] getAllDeclaredMethods(java.lang.Class<?> c)
```
  - startInternal
```
protected void startInternal()
                      throws LifecycleException
```
    Start this component and implement the requirements of LifecycleBase.startInternal().
    
    Overrides:
    
    startInternal in class ContainerBase
    
    Throws:
    
    LifecycleException - if this component detects a fatal error that prevents this component from being used
  - stopInternal
```
protected void stopInternal()
                     throws LifecycleException
```
    Stop this component and implement the requirements of LifecycleBase.stopInternal().
    
    Overrides:
    
    stopInternal in class ContainerBase
    
    Throws:
    
    LifecycleException - if this component detects a fatal error that prevents this component from being used
  - getObjectNameKeyProperties
```
protected java.lang.String getObjectNameKeyProperties()
```
    Description copied from class: LifecycleMBeanBase
    
    Allow sub-classes to specify the key properties component of the ObjectName that will be used to register this component.
    
    Specified by:
    
    getObjectNameKeyProperties in class LifecycleMBeanBase
    
    Returns:
    The string representation of the key properties component of the desired ObjectName
  - isStateManageable
```
@Deprecated
public boolean isStateManageable()
```
    Deprecated. The JSR-77 implementation is incomplete and will be removed in 8.5.x
    
    JSR 77. Always return false.
  - removeNotificationListener
```
public void removeNotificationListener(javax.management.NotificationListener listener,
                              javax.management.NotificationFilter filter,
                              java.lang.Object object)
                                throws javax.management.ListenerNotFoundException
```
    Specified by:
    
    removeNotificationListener in interface javax.management.NotificationEmitter
    
    Throws:
    
    javax.management.ListenerNotFoundException
  - getNotificationInfo
```
public javax.management.MBeanNotificationInfo[] getNotificationInfo()
```
    Specified by:
    
    getNotificationInfo in interface javax.management.NotificationBroadcaster
  - addNotificationListener
```
public void addNotificationListener(javax.management.NotificationListener listener,
                           javax.management.NotificationFilter filter,
                           java.lang.Object object)
                             throws java.lang.IllegalArgumentException
```
    Specified by:
    
    addNotificationListener in interface javax.management.NotificationBroadcaster
    
    Throws:
    
    java.lang.IllegalArgumentException
  - removeNotificationListener
```
public void removeNotificationListener(javax.management.NotificationListener listener)
                                throws javax.management.ListenerNotFoundException
```
    Remove a JMX-NotificationListener
    
    Specified by:
    
    removeNotificationListener in interface javax.management.NotificationBroadcaster
    
    Throws:
    
    javax.management.ListenerNotFoundException
    See Also:
    NotificationBroadcaster.removeNotificationListener(javax.management.NotificationListener)

Class StandardWrapper

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.catalina.core.ContainerBase

Nested classes/interfaces inherited from interface org.apache.catalina.Lifecycle

Field Summary

Fields inherited from class org.apache.catalina.core.ContainerBase

Fields inherited from class org.apache.catalina.util.LifecycleMBeanBase

Fields inherited from interface org.apache.catalina.Wrapper

Fields inherited from interface org.apache.catalina.Container

Fields inherited from interface org.apache.catalina.Lifecycle

Constructor Summary

Method Summary

Methods inherited from class org.apache.catalina.core.ContainerBase

Methods inherited from class org.apache.catalina.util.LifecycleMBeanBase

Methods inherited from class org.apache.catalina.util.LifecycleBase

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.catalina.Container

Methods inherited from interface org.apache.catalina.Lifecycle

Field Detail

DEFAULT_SERVLET_METHODS

available

broadcaster

countAllocated

facade

instance

instanceInitialized

instanceSupport

loadOnStartup

mappings

parameters

references

runAs

sequenceNumber

servletClass

singleThreadModel

unloading

maxInstances

nInstances

instancePool

unloadDelay

isJspServlet

jspMonitorON

swallowOutput

swValve

loadTime

classLoadTime

multipartConfigElement

asyncSupported

enabled

classType

notificationInfo

Constructor Detail

StandardWrapper

Method Detail

isOverridable

setOverridable

getAvailable

setAvailable

getCountAllocated

getInstanceSupport

getLoadOnStartup

setLoadOnStartup

setLoadOnStartupString

getLoadOnStartupString

getMaxInstances

setMaxInstances

setParent

getRunAs

setRunAs

getServletClass

setServletClass

setServletName

isSingleThreadModel

isUnavailable

getServletMethods

getServlet

setServlet

setServletSecurityAnnotationScanRequired

backgroundProcess

getRootCause