org.apache.catalina
public interface Wrapper extends Container
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
.
Version: $Revision: 467222 $ $Date: 2006-10-24 05:17:11 +0200 (Tue, 24 Oct 2006) $
Method Summary | |
---|---|
void | addInitParameter(String name, String value)
Add a new servlet initialization parameter for this servlet.
|
void | addInstanceListener(InstanceListener listener)
Add a new listener interested in InstanceEvents.
|
void | addMapping(String mapping)
Add a mapping associated with the Wrapper.
|
void | addSecurityReference(String name, 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 | deallocate(Servlet servlet)
Return this previously allocated servlet to the pool of available
instances. |
String | findInitParameter(String name)
Return the value for the specified initialization parameter name,
if any; otherwise return null .
|
String[] | findInitParameters()
Return the names of all defined initialization parameters for this
servlet. |
String[] | findMappings()
Return the mappings associated with this wrapper. |
String | findSecurityReference(String name)
Return the security role link for the specified security role
reference name, if any; otherwise return null .
|
String[] | findSecurityReferences()
Return the set of security role reference names associated with
this servlet, if any; otherwise return a zero-length array. |
long | getAvailable()
Return the available date/time for this servlet, in milliseconds since
the epoch. |
String | getJspFile()
Return the context-relative URI of the JSP file for this servlet. |
int | getLoadOnStartup()
Return the load-on-startup order value (negative value means
load on first call). |
String | getRunAs()
Return the run-as identity for this servlet. |
Servlet | getServlet()
Return the associated servlet instance. |
String | getServletClass()
Return the fully qualified servlet class name for this servlet. |
String[] | getServletMethods()
Gets the names of the methods supported by the underlying servlet.
|
void | incrementErrorCount()
Increment the error count value used when monitoring. |
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. |
void | removeInitParameter(String name)
Remove the specified initialization parameter from this servlet.
|
void | removeInstanceListener(InstanceListener listener)
Remove a listener no longer interested in InstanceEvents.
|
void | removeMapping(String mapping)
Remove a mapping associated with the wrapper.
|
void | removeSecurityReference(String name)
Remove any security role reference for the specified role name.
|
void | setAvailable(long available)
Set the available date/time for this servlet, in milliseconds since the
epoch. |
void | setJspFile(String jspFile)
Set the context-relative URI of the JSP file for this servlet.
|
void | setLoadOnStartup(int value)
Set the load-on-startup order value (negative value means
load on first call).
|
void | setRunAs(String runAs)
Set the run-as identity for this servlet.
|
void | setServletClass(String servletClass)
Set the fully qualified servlet class name for this servlet.
|
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. |
Parameters: name Name of this initialization parameter to add value Value of this initialization parameter to add
Parameters: listener The new listener
Parameters: mapping The new wrapper mapping
Parameters: name Role name used within this servlet link Role name used within the web application
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()
.
Throws: ServletException if the servlet init() method threw an exception ServletException if a loading error occurs
Parameters: servlet The servlet to be returned
Throws: ServletException if a deallocation error occurs
null
.
Parameters: name Name of the requested initialization parameter
null
.
Parameters: name Security role reference used within this servlet
Returns: Array of names of the methods supported by the underlying servlet
Throws: ServletException if the servlet init() method threw an exception ServletException if some other loading problem occurs
Parameters: name Name of the initialization parameter to remove
Parameters: listener The listener to remove
Parameters: mapping The pattern to remove
Parameters: name Security role used within this servlet to be removed
Parameters: available The new available date/time
Parameters: jspFile JSP file URI
Parameters: value New load-on-startup value
Parameters: runAs New run-as identity value
Parameters: servletClass Servlet class name
Parameters: unavailable The exception that occurred, or null
to mark this servlet as permanently unavailable
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.
Throws: ServletException if an unload error occurs