| 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 final NotificationBroadcasterSupport | broadcaster
The broadcaster that sends j2ee notifications. |
| protected int | |
| protected static Class | classType
Static class array used when the SecurityManager is turned on and |
| protected final AtomicInteger | countAllocated
The count of allocations that are currently active. |
| protected static final String[] | |
| protected boolean | enabled
Enabled |
| protected final StandardWrapperFacade | facade
The facade associated with this wrapper. |
| protected volatile Servlet | instance
The (single) possibly uninitialized instance of this servlet. |
| protected volatile boolean | instanceInitialized
Flag that indicates if this instance has been initialized |
| protected boolean | isJspServlet
True if this StandardWrapper is for the JspServlet |
| protected 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 | |
| private final Log | |
| protected final ArrayList | mappings
Mappings associated with the wrapper. |
| private final ReentrantReadWriteLock | |
| protected MultipartConfigElement | multipartConfigElement
Multipart config |
| protected MBeanNotificationInfo[] | |
| private boolean | |
| protected HashMap | parameters
The initialization parameters for this servlet, keyed by parameter name. |
| private final ReentrantReadWriteLock | |
| protected HashMap | references
The security role references for this servlet, keyed by role name used in the servlet. |
| private final ReentrantReadWriteLock | |
| protected String | runAs
The run-as identity for this servlet. |
| protected long | sequenceNumber
The notification sequence number. |
| protected String | servletClass
The fully qualified servlet class name for this servlet. |
| protected boolean | swallowOutput
Should we swallow System.out |
| protected StandardWrapperValve | |
| protected long | unloadDelay
Wait time for servlet unload in ms. |
| protected volatile boolean | unloading
Are we unloading our servlet instance at the moment? |
| Access | Constructor and Description |
|---|---|
| public |
| Modifier and Type | Method and Description |
|---|---|
| public void | addChild(Container
Child container to be added child)Overrides org. Implements org. Refuse to add a child Container, because Wrappers are the lowest level of the Container hierarchy. |
| public void | addInitParameter(String
Name of this initialization parameter to add name, String Value of this initialization parameter to add value)Implements org. Add a new servlet initialization parameter for this servlet. |
| public void | addMapping(String
The new wrapper mapping mapping)Implements org. Add a mapping associated with the Wrapper. |
| public void | addNotificationListener(NotificationListener
The listener object which will handle the
notifications emitted by the broadcaster. listener, NotificationFilter The filter object. If filter is null, no
filtering will be performed before handling notifications. filter, Object An opaque object to be sent back to the
listener when a notification is emitted. This object cannot be
used by the Notification broadcaster object. It should be
resent unchanged with the notification to the listener. object)Implements javax. Add a JMX-NotificationListener |
| public void | addSecurityReference(String
Role name used within this servlet name, String Role name used within the web application link)Implements org. Add a new security role reference record to the set of records for this servlet. |
| public Servlet | allocate()
Implements org. Allocate an initialized instance of this Servlet that is ready to have its |
| public synchronized void | backgroundProcess()
Overrides org. Implements org. Execute a periodic task, such as reloading, etc. This method will be invoked inside the classloading context of this container. |
| public void | deallocate(Servlet
The servlet to be returned servlet)Implements org. Decrement the allocation count for this servlet. |
| public String | findInitParameter(String
Name of the requested initialization parameter name)Implements org. Return the value for the specified initialization parameter name, if any; otherwise return |
| public String[] | findInitParameters()
Implements org. Return the names of all defined initialization parameters for this servlet. |
| public String[] | findMappings()
Implements org. Return the mappings associated with this wrapper. |
| public String | findSecurityReference(String
Security role reference used within this servlet name)Implements org. Return the security role link for the specified security role reference name, if any; otherwise return
|
| public String[] | findSecurityReferences()
Implements org. Return the set of security role reference names associated with this servlet, if any; otherwise return a zero-length array. |
| protected Method[] | |
| public long | getAvailable()
Implements org. Return the available date/time for this servlet, in milliseconds since the epoch. |
| public int | |
| public int | |
| public int | Returns: the number of requests processed by the wrapper that resulted in an error.
Deprecated
The return type will change to long in Tomcat 11 onwards. Callers of this method should switch to
storing the result of calls to this method in a long value rather than an int.
Returns the number of requests processed by the wrapper that resulted in an error. |
| public String | Returns: the initialization parameter value for the specified name, if any; otherwise returnnull.Name of the initialization parameter to retrieve name)Implements jakarta. Returns a |
| public Enumeration | Returns: the set of initialization parameter names defined for this servlet. If none are defined, an empty Enumeration is returned.Implements jakarta. Returns the names of the servlet's initialization parameters as an |
| private String | |
| public int | Returns: the load-on-startup order value (negative value means load on first call).Implements org.
|
| public String | |
| public long | |
| public long | |
| public long | |
| public MultipartConfigElement | |
| public MBeanNotificationInfo[] | getNotificationInfo()
Implements javax. Get JMX Broadcaster Info |
| protected String | getObjectNameKeyProperties()
Implements abstract org. Allow sub-classes to specify the key properties component of the
|
| public long | |
| public int | Returns: the number of requests processed by the wrapper.
Deprecated
The return type will change to long in Tomcat 11 onwards. Callers of this method should switch to
storing the result of calls to this method in a long value rather than an int.
Returns the number of requests processed by the wrapper. |
| public static Throwable | Returns: the root cause of the Servlet exceptionThe servlet exception e)Extract the root cause from a servlet exception. |
| public String | Returns: the run-as identity for this servlet.Implements org.
|
| public Servlet | Returns: the associated servlet instance.Implements org.
|
| public String | Returns: the fully qualified servlet class name for this servlet.Implements org.
|
| public ServletContext | Returns: the servlet context with which this servlet is associated.Implements jakarta. Returns a reference to the |
| public String[] | getServletMethods()
Implements org. Gets the names of the methods supported by the underlying servlet. |
| public String | Returns: the name of this servlet.Implements jakarta. Returns the name of this servlet instance. |
| private String | |
| public void | incrementErrorCount()
Implements org. Increment the error count used for monitoring. |
| private synchronized void | |
| public boolean | isAsyncSupported()
Implements org. Does the associated Servlet support async processing? |
| public boolean | |
| public boolean | isOverridable()
Implements org. Is the Servlet overridable by a ServletContainerInitializer? |
| public boolean | Returns: true if the Servlet has been marked unavailable.Implements org.
|
| public synchronized void | load()
Implements org. Load and initialize an instance of this servlet, if there is not already at least one initialized instance. |
| public synchronized Servlet | Returns: the loaded Servlet instanceLoad and initialize an instance of this servlet, if there is not already an initialized instance. |
| public void | removeInitParameter(String
Name of the initialization parameter to remove name)Implements org. Remove the specified initialization parameter from this servlet. |
| public void | removeMapping(String
The pattern to remove mapping)Implements org. Remove a mapping associated with the wrapper. |
| public void | removeNotificationListener(NotificationListener
A listener that was previously added to this
MBean. listener, NotificationFilter The filter that was specified when the listener
was added. filter, Object The handback that was specified when the listener was
added. object)Implements javax. Remove a JMX notificationListener |
| public void | removeNotificationListener(NotificationListener
A listener that was previously added to this
MBean. listener)Implements javax. Remove a JMX-NotificationListener |
| public void | removeSecurityReference(String
Security role used within this servlet to be removed name)Implements org. Remove any security role reference for the specified role name. |
| public void | setAsyncSupported(boolean
the new value asyncSupported)Implements org. Set the async support for the associated Servlet. |
| public void | setAvailable(long
The new available date/time available)Implements org. Set the available date/time for this servlet, in milliseconds since the epoch. |
| public void | setEnabled(boolean
the new value enabled)Implements org. Sets the enabled attribute for the associated servlet. |
| public void | setLoadOnStartup(int
New load-on-startup value value)Implements org. Set the load-on-startup order value (negative value means load on first call). |
| public void | setLoadOnStartupString(String
New load-on-startup value value)Set the load-on-startup order value from a (possibly null) string. |
| public void | setMultipartConfigElement(MultipartConfigElement
The configuration associated with the Servlet multipartConfigElement)Implements org. Set the multi-part configuration for the associated Servlet. |
| public void | setOverridable(boolean
the new value overridable)Implements org. Sets the overridable attribute for this Servlet. |
| public void | setParent(Container
Proposed parent Container container)Overrides org. Implements org. Set the parent Container of this Wrapper, but only if it is a Context. |
| public void | setRunAs(String
New run-as identity value runAs)Implements org. Set the run-as identity for this servlet. |
| public void | setServlet(Servlet
The associated Servlet servlet)Implements org. Set the associated servlet instance. |
| public void | setServletClass(String
Servlet class name servletClass)Implements org. Set the fully qualified servlet class name for this servlet. |
| public void | |
| protected void | startInternal()
Overrides org. Start this component and implement the requirements of
|
| protected void | stopInternal()
Overrides org. Stop this component and implement the requirements of
|
| public void | unavailable(UnavailableException
The exception that occurred, or unavailable)null to mark this servlet as permanently
unavailableImplements org. Process an UnavailableException, marking this servlet as unavailable for the specified amount of time. |
| public synchronized void | unload()
Implements org. Unload all initialized instances of this servlet, after calling the |