Package org.apache.catalina
Interface Wrapper
- All Known Implementing Classes:
- StandardWrapper,- Tomcat.ExistingStandardWrapper
A Wrapper is a Container that represents an individual servlet
 definition from the deployment descriptor of the web application.  It
 provides a convenient mechanism to use Interceptors that see every single
 request to the servlet represented by this definition.
 
Implementations of Wrapper are responsible for managing the servlet life cycle for their underlying servlet class, including calling init() and destroy() at appropriate times.
The parent Container attached to a Wrapper will generally be an implementation of Context, representing the servlet context (and therefore the web application) within which this servlet executes.
 Child Containers are not allowed on Wrapper implementations, so the
 addChild() method should throw an
 IllegalArgumentException.
- Author:
- Craig R. McClanahan
- 
Nested Class SummaryNested classes/interfaces inherited from interface org.apache.catalina.LifecycleLifecycle.SingleUse
- 
Field SummaryFieldsModifier and TypeFieldDescriptionstatic final StringContainer event for adding a wrapper.static final StringContainer event for removing a wrapper.Fields inherited from interface org.apache.catalina.ContainerADD_CHILD_EVENT, ADD_VALVE_EVENT, REMOVE_CHILD_EVENT, REMOVE_VALVE_EVENTFields inherited from interface org.apache.catalina.LifecycleAFTER_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
- 
Method SummaryModifier and TypeMethodDescriptionvoidaddInitParameter(String name, String value) Add a new servlet initialization parameter for this servlet.voidaddMapping(String mapping) Add a mapping associated with the Wrapper.voidaddSecurityReference(String name, String link) Add a new security role reference record to the set of records for this servlet.allocate()Allocate an initialized instance of this Servlet that is ready to have itsservice()method called.voiddeallocate(Servlet servlet) Decrement the allocation count for the servlet instance.findInitParameter(String name) String[]String[]findSecurityReference(String name) String[]longintgetRunAs()String[]Gets the names of the methods supported by the underlying servlet.voidIncrement the error count value used when monitoring.booleanDoes the associated Servlet support async processing?booleanIs the associated Servlet enabled?booleanIs the Servlet overridable by a ServletContainerInitializer?booleanvoidload()Load and initialize an instance of this Servlet, if there is not already at least one initialized instance.voidremoveInitParameter(String name) Remove the specified initialization parameter from this Servlet.voidremoveMapping(String mapping) Remove a mapping associated with the wrapper.voidRemove any security role reference for the specified role name.voidsetAsyncSupported(boolean asyncSupport) Set the async support for the associated Servlet.voidsetAvailable(long available) Set the available date/time for this servlet, in milliseconds since the epoch.voidsetEnabled(boolean enabled) Sets the enabled attribute for the associated servlet.voidsetLoadOnStartup(int value) Set the load-on-startup order value (negative value means load on first call).voidsetMultipartConfigElement(MultipartConfigElement multipartConfig) Set the multi-part configuration for the associated Servlet.voidsetOverridable(boolean overridable) Sets the overridable attribute for this Servlet.voidSet the run-as identity for this servlet.voidsetServlet(Servlet servlet) Set the associated Servlet instancevoidsetServletClass(String servletClass) Set the fully qualified servlet class name for this servlet.voidunavailable(UnavailableException unavailable) Process an UnavailableException, marking this Servlet as unavailable for the specified amount of time.voidunload()Unload all initialized instances of this servlet, after calling thedestroy()method for each instance.Methods inherited from interface org.apache.catalina.ContaineraddChild, addContainerListener, addPropertyChangeListener, backgroundProcess, findChild, findChildren, findContainerListeners, fireContainerEvent, getAccessLog, getBackgroundProcessorDelay, getCatalinaBase, getCatalinaHome, getCluster, getDomain, getLogger, getLogName, getMBeanKeyProperties, getName, getObjectName, getParent, getParentClassLoader, getPipeline, getRealm, getStartStopThreads, logAccess, removeChild, removeContainerListener, removePropertyChangeListener, setBackgroundProcessorDelay, setCluster, setName, setParent, setParentClassLoader, setRealm, setStartStopThreadsMethods inherited from interface org.apache.catalina.LifecycleaddLifecycleListener, destroy, findLifecycleListeners, getState, getStateName, init, removeLifecycleListener, start, stop
- 
Field Details- 
ADD_MAPPING_EVENTContainer event for adding a wrapper.- See Also:
 
- 
REMOVE_MAPPING_EVENTContainer event for removing a wrapper.- See Also:
 
 
- 
- 
Method Details- 
getAvailablelong getAvailable()- Returns:
- the available date/time for this servlet, in milliseconds since the epoch. 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. A value equal to Long.MAX_VALUE is considered to mean that unavailability is permanent.
 
- 
setAvailablevoid setAvailable(long available) Set the available date/time for this servlet, in milliseconds since the epoch. If this date/time is in the future, any request for this servlet will return an SC_SERVICE_UNAVAILABLE error. A value equal to Long.MAX_VALUE is considered to mean that unavailability is permanent.- Parameters:
- available- The new available date/time
 
- 
getLoadOnStartupint getLoadOnStartup()- Returns:
- the load-on-startup order value (negative value means load on first call).
 
- 
setLoadOnStartupvoid setLoadOnStartup(int value) Set the load-on-startup order value (negative value means load on first call).- Parameters:
- value- New load-on-startup value
 
- 
getRunAsString getRunAs()- Returns:
- the run-as identity for this servlet.
 
- 
setRunAsSet the run-as identity for this servlet.- Parameters:
- runAs- New run-as identity value
 
- 
getServletClassString getServletClass()- Returns:
- the fully qualified servlet class name for this servlet.
 
- 
setServletClassSet the fully qualified servlet class name for this servlet.- Parameters:
- servletClass- Servlet class name
 
- 
getServletMethodsGets 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.- Returns:
- Array of names of the methods supported by the underlying servlet
- Throws:
- ServletException- If the target servlet cannot be loaded
 
- 
getServletServlet getServlet()- Returns:
- the associated Servlet instance.
 
- 
setServletSet the associated Servlet instance- Parameters:
- servlet- The associated Servlet
 
- 
addInitParameterAdd a new servlet initialization parameter for this servlet.- Parameters:
- name- Name of this initialization parameter to add
- value- Value of this initialization parameter to add
 
- 
addMappingAdd a mapping associated with the Wrapper.- Parameters:
- mapping- The new wrapper mapping
 
- 
addSecurityReferenceAdd a new security role reference record to the set of records for this servlet.- Parameters:
- name- Role name used within this servlet
- link- Role name used within the web application
 
- 
allocateAllocate an initialized instance of this Servlet that is ready to have itsservice()method called. The previously initialized instance may be returned immediately.- Returns:
- a new Servlet instance
- Throws:
- ServletException- if the Servlet init() method threw an exception
- ServletException- if a loading error occurs
 
- 
deallocateDecrement the allocation count for the servlet instance.- Parameters:
- servlet- The servlet to be returned
- Throws:
- ServletException- if a deallocation error occurs
 
- 
findInitParameter- Parameters:
- name- Name of the requested initialization parameter
- Returns:
- the value for the specified initialization parameter name,
 if any; otherwise return null.
 
- 
findInitParametersString[] findInitParameters()- Returns:
- the names of all defined initialization parameters for this servlet.
 
- 
findMappingsString[] findMappings()- Returns:
- the mappings associated with this wrapper.
 
- 
findSecurityReference- Parameters:
- name- Security role reference used within this servlet
- Returns:
- the security role link for the specified security role
 reference name, if any; otherwise return null.
 
- 
findSecurityReferencesString[] findSecurityReferences()- Returns:
- the set of security role reference names associated with this servlet, if any; otherwise return a zero-length array.
 
- 
incrementErrorCountvoid incrementErrorCount()Increment the error count value used when monitoring.
- 
loadLoad 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- if the Servlet init() method threw an exception or if some other loading problem occurs
 
- 
removeInitParameterRemove the specified initialization parameter from this Servlet.- Parameters:
- name- Name of the initialization parameter to remove
 
- 
removeMappingRemove a mapping associated with the wrapper.- Parameters:
- mapping- The pattern to remove
 
- 
removeSecurityReferenceRemove any security role reference for the specified role name.- Parameters:
- name- Security role used within this servlet to be removed
 
- 
unloadUnload all initialized instances of this servlet, after calling thedestroy()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.- Throws:
- ServletException- if an unload error occurs
 
- 
getMultipartConfigElementMultipartConfigElement getMultipartConfigElement()- Returns:
- the multi-part configuration for the associated Servlet. If no
 multi-part configuration has been defined, then nullwill be returned.
 
- 
setMultipartConfigElementSet the multi-part configuration for the associated Servlet. To clear the multi-part configuration specifynullas the new value.- Parameters:
- multipartConfig- The configuration associated with the Servlet
 
- 
isAsyncSupportedboolean isAsyncSupported()Does the associated Servlet support async processing? Defaults tofalse.- Returns:
- trueif the Servlet supports async
 
- 
setAsyncSupportedvoid setAsyncSupported(boolean asyncSupport) Set the async support for the associated Servlet.- Parameters:
- asyncSupport- the new value
 
- 
isEnabledboolean isEnabled()Is the associated Servlet enabled? Defaults totrue.- Returns:
- trueif the Servlet is enabled
 
- 
setEnabledvoid setEnabled(boolean enabled) Sets the enabled attribute for the associated servlet.- Parameters:
- enabled- the new value
 
- 
isOverridableboolean isOverridable()Is the Servlet overridable by a ServletContainerInitializer?- Returns:
- trueif the Servlet can be overridden in a ServletContainerInitializer
 
- 
setOverridablevoid setOverridable(boolean overridable) Sets the overridable attribute for this Servlet.- Parameters:
- overridable- the new value
 
 
-