File	Doc	Category	Size	Date	Package
Wrapper.java	API Doc	Glassfish v2 API	11422	Fri May 04 22:31:52 BST 2007	org.apache.catalina

Wrapper

Fields Summary

Constructors Summary

Methods Summary
public void	addInitParameter(java.lang.String name, java.lang.String value) Add a new servlet initialization parameter for this servlet. param name Name of this initialization parameter to add param value Value of this initialization parameter to add
public void	addInstanceListener(InstanceListener listener) Add a new listener interested in InstanceEvents. param listener The new listener
public void	addMapping(java.lang.String mapping) Add a mapping associated with the Wrapper. param pattern The new wrapper mapping
public void	addSecurityReference(java.lang.String name, java.lang.String link) Add a new security role reference record to the set of records for this servlet. param name Role name used within this servlet param link Role name used within the web application param description Description of this security role reference
public javax.servlet.Servlet	allocate() 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 threw an exception exception ServletException if a loading error occurs
public void	deallocate(javax.servlet.Servlet servlet) Return this previously allocated servlet to the pool of available instances. If this servlet class does not implement SingleThreadModel, no action is actually required. param servlet The servlet to be returned exception ServletException if a deallocation error occurs
public java.lang.String	findInitParameter(java.lang.String name) Return the value for the specified initialization parameter name, if any; otherwise return null. param name Name of the requested initialization parameter
public java.lang.String[]	findInitParameters() Return the names of all defined initialization parameters for this servlet.
public java.lang.String[]	findMappings() Return the mappings associated with this wrapper.
public java.lang.String	findSecurityReference(java.lang.String name) Return the security role link for the specified security role reference name, if any; otherwise return null. param name Security role reference used within this servlet
public java.lang.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 java.lang.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 java.lang.String	getRunAs() Return the run-as identity for this servlet.
public java.lang.String	getServletClass() Return the fully qualified servlet class name for this servlet.
public java.lang.String[]	getServletMethods() 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. return Array of names of the methods supported 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() 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 threw an exception exception ServletException if some other loading problem occurs
public void	removeInitParameter(java.lang.String name) Remove the specified initialization parameter from this servlet. param name Name of the initialization parameter to remove
public void	removeInstanceListener(InstanceListener listener) Remove a listener no longer interested in InstanceEvents. param listener The listener to remove
public void	removeMapping(java.lang.String mapping) Remove a mapping associated with the wrapper. param mapping The pattern to remove
public void	removeSecurityReference(java.lang.String name) Remove any security role reference for the specified role name. param name Security role used within this servlet to be removed
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. param available The new available date/time
public void	setJspFile(java.lang.String jspFile) Set the context-relative URI of the JSP file for this servlet. param jspFile JSP file URI
public void	setLoadOnStartup(int value) Set the load-on-startup order value (negative value means load on first call). param value New load-on-startup value
public void	setRunAs(java.lang.String runAs) Set the run-as identity for this servlet. param value New run-as identity value
public void	setServletClass(java.lang.String servletClass) Set the fully qualified servlet class name for this servlet. param servletClass Servlet class name
public void	unavailable(javax.servlet.UnavailableException unavailable) Process an UnavailableException, marking this servlet as unavailable for the specified amount of time. param unavailable The exception that occurred, or null to mark this servlet as permanently unavailable
public void	unload() 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