| org.apache.catalina.Wrapper
All known Subclasses: org.apache.catalina.core.StandardWrapper,
| Wrapper | | public interface Wrapper extends Container(Code) | | 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.
author:
Craig R. McClanahan
version:
$Revision: 1.5 $ $Date: 2001/07/22 20:13:30 $ |
| Method Summary | |
| 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 | addSecurityReference(String name, String link)
Add a new security role reference record to the set of records for
this servlet. | | public Servlet | allocate()
Allocate an initialized instance of this Servlet that is ready to have
its service() method called. | | public void | deallocate(Servlet servlet)
Return this previously allocated servlet to the pool of available
instances. | | 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 | 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. | | 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 String | getServletClass()
Return the fully qualified servlet class name for this servlet. | | public boolean | isUnavailable()
| | public void | load()
Load and initialize an instance of this servlet, if there is not already
at least one initialized instance. | | 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 | 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. | | 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()
Unload all initialized instances of this servlet, after calling the
destroy() method for each instance. |
| addInitParameter | | public void addInitParameter(String name, String value)(Code) | | Add a new servlet initialization parameter for this servlet.
Parameters:
name - Name of this initialization parameter to add
Parameters:
value - Value of this initialization parameter to add |
| addInstanceListener | | public void addInstanceListener(InstanceListener listener)(Code) | | Add a new listener interested in InstanceEvents.
Parameters:
listener - The new listener |
| addSecurityReference | | public void addSecurityReference(String name, String link)(Code) | | Add a new security role reference record to the set of records for
this servlet.
Parameters:
name - Role name used within this servlet
Parameters:
link - Role name used within the web application
Parameters:
description - Description of this security role reference |
| allocate | | public Servlet allocate() throws ServletException(Code) | | 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().
exception:
ServletException - if the servlet init() method threwan exception
exception:
ServletException - if a loading error occurs |
| deallocate | | public void deallocate(Servlet servlet) throws ServletException(Code) | | Return this previously allocated servlet to the pool of available
instances. If this servlet class does not implement SingleThreadModel,
no action is actually required.
Parameters:
servlet - The servlet to be returned
exception:
ServletException - if a deallocation error occurs |
| findInitParameter | | public String findInitParameter(String name)(Code) | | Return the value for the specified initialization parameter name,
if any; otherwise return null.
Parameters:
name - Name of the requested initialization parameter |
| findInitParameters | | public String[] findInitParameters()(Code) | | Return the names of all defined initialization parameters for this
servlet.
|
| findSecurityReference | | public String findSecurityReference(String name)(Code) | | Return the security role link for the specified security role
reference name, if any; otherwise return null.
Parameters:
name - Security role reference used within this servlet |
| findSecurityReferences | | public String[] findSecurityReferences()(Code) | | Return the set of security role reference names associated with
this servlet, if any; otherwise return a zero-length array.
|
| getAvailable | | public long getAvailable()(Code) | | 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.
|
| getJspFile | | public String getJspFile()(Code) | | Return the context-relative URI of the JSP file for this servlet.
|
| getLoadOnStartup | | public int getLoadOnStartup()(Code) | | Return the load-on-startup order value (negative value means
load on first call).
|
| getRunAs | | public String getRunAs()(Code) | | Return the run-as identity for this servlet.
|
| getServletClass | | public String getServletClass()(Code) | | Return the fully qualified servlet class name for this servlet.
|
| isUnavailable | | public boolean isUnavailable()(Code) | | Is this servlet currently unavailable?
|
| load | | public void load() throws ServletException(Code) | | 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.
exception:
ServletException - if the servlet init() method threwan exception
exception:
ServletException - if some other loading problem occurs |
| removeInitParameter | | public void removeInitParameter(String name)(Code) | | Remove the specified initialization parameter from this servlet.
Parameters:
name - Name of the initialization parameter to remove |
| removeInstanceListener | | public void removeInstanceListener(InstanceListener listener)(Code) | | Remove a listener no longer interested in InstanceEvents.
Parameters:
listener - The listener to remove |
| removeSecurityReference | | public void removeSecurityReference(String name)(Code) | | Remove any security role reference for the specified role name.
Parameters:
name - Security role used within this servlet to be removed |
| setAvailable | | public void setAvailable(long available)(Code) | | 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 |
| setJspFile | | public void setJspFile(String jspFile)(Code) | | Set the context-relative URI of the JSP file for this servlet.
Parameters:
jspFile - JSP file URI |
| setLoadOnStartup | | public void setLoadOnStartup(int value)(Code) | | Set the load-on-startup order value (negative value means
load on first call).
Parameters:
value - New load-on-startup value |
| setRunAs | | public void setRunAs(String runAs)(Code) | | Set the run-as identity for this servlet.
Parameters:
value - New run-as identity value |
| setServletClass | | public void setServletClass(String servletClass)(Code) | | Set the fully qualified servlet class name for this servlet.
Parameters:
servletClass - Servlet class name |
| unavailable | | public void unavailable(UnavailableException unavailable)(Code) | | Process an UnavailableException, marking this servlet as unavailable
for the specified amount of time.
Parameters:
unavailable - The exception that occurred, or nullto mark this servlet as permanently unavailable |
| unload | | public void unload() throws ServletException(Code) | | 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.
exception:
ServletException - if an unload error occurs |
|
|