Home » apache-tomcat-6.0.26-src » org.apache » catalina » [javadoc | source]
org.apache.catalina
public interface: Wrapper [javadoc | source]

All Implemented Interfaces:
    Container

All Known Implementing Classes:
    ExistingStandardWrapper, StandardWrapper

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, as well as respecting the existence of the SingleThreadModel declaration on the servlet class itself.

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.

Method from org.apache.catalina.Wrapper Summary:
addInitParameter,   addInstanceListener,   addMapping,   addSecurityReference,   allocate,   deallocate,   findInitParameter,   findInitParameters,   findMappings,   findSecurityReference,   findSecurityReferences,   getAvailable,   getJspFile,   getLoadOnStartup,   getRunAs,   getServlet,   getServletClass,   getServletMethods,   incrementErrorCount,   isUnavailable,   load,   removeInitParameter,   removeInstanceListener,   removeMapping,   removeSecurityReference,   setAvailable,   setJspFile,   setLoadOnStartup,   setRunAs,   setServletClass,   unavailable,   unload
Method from org.apache.catalina.Wrapper Detail:
 public  void addInitParameter(String name,
    String value)
    Add a new servlet initialization parameter for this servlet.
 public  void addInstanceListener(InstanceListener listener)
    Add a new listener interested in InstanceEvents.
 public  void addMapping(String mapping)
    Add a mapping associated with the Wrapper.
 public  void addSecurityReference(String name,
    String link)
    Add a new security role reference record to the set of records for this servlet.
 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().
 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.
 public String findInitParameter(String name)
    Return the value for the specified initialization parameter name, if any; otherwise return null.
 public String[] findInitParameters()
    Return the names of all defined initialization parameters for this servlet.
 public String[] findMappings()
    Return the mappings associated with this wrapper.
 public String findSecurityReference(String name)
    Return the security role link for the specified security role reference name, if any; otherwise return null.
 public String[] findSecurityReferences()
    Return the set of security role reference names associated with this servlet, if any; otherwise return a zero-length array.
 public long getAvailable()
    Return 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.
 public String getJspFile()
    Return the context-relative URI of the JSP file for this servlet.
 public int getLoadOnStartup()
    Return the load-on-startup order value (negative value means load on first call).
 public String getRunAs()
    Return the run-as identity for this servlet.
 public Servlet getServlet()
    Return the associated servlet instance.
 public String getServletClass()
    Return the fully qualified servlet class name for this servlet.
 public String[] getServletMethods() throws ServletException
    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.
 public  void incrementErrorCount()
    Increment the error count value used when monitoring.
 public boolean isUnavailable()
    Is this servlet currently unavailable?
 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.
 public  void removeInitParameter(String name)
    Remove the specified initialization parameter from this servlet.
 public  void removeInstanceListener(InstanceListener listener)
    Remove a listener no longer interested in InstanceEvents.
 public  void removeMapping(String mapping)
    Remove a mapping associated with the wrapper.
 public  void removeSecurityReference(String name)
    Remove any security role reference for the specified role name.
 public  void 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.
 public  void setJspFile(String jspFile)
    Set the context-relative URI of the JSP file for this servlet.
 public  void setLoadOnStartup(int value)
    Set the load-on-startup order value (negative value means load on first call).
 public  void setRunAs(String runAs)
    Set the run-as identity for this servlet.
 public  void setServletClass(String servletClass)
    Set the fully qualified servlet class name for this servlet.
 public  void unavailable(UnavailableException unavailable)
    Process an UnavailableException, marking this servlet as unavailable for the specified amount of time.
 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.