|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Wrapper
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
.
Field Summary |
---|
Fields inherited from interface org.apache.catalina.Container |
---|
ADD_CHILD_EVENT, ADD_MAPPER_EVENT, ADD_VALVE_EVENT, REMOVE_CHILD_EVENT, REMOVE_MAPPER_EVENT, REMOVE_VALVE_EVENT |
Method Summary | |
---|---|
void |
addInitParameter(java.lang.String name,
java.lang.String value)
Add a new servlet initialization parameter for this servlet. |
void |
addInstanceListener(InstanceListener listener)
Add a new listener interested in InstanceEvents. |
void |
addMapping(java.lang.String mapping)
Add a mapping associated with the Wrapper. |
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. |
javax.servlet.Servlet |
allocate()
Allocate an initialized instance of this Servlet that is ready to have its service() method called. |
void |
deallocate(javax.servlet.Servlet servlet)
Return this previously allocated servlet to the pool of available instances. |
java.lang.String |
findInitParameter(java.lang.String name)
Return the value for the specified initialization parameter name, if any; otherwise return null . |
java.lang.String[] |
findInitParameters()
Return the names of all defined initialization parameters for this servlet. |
java.lang.String[] |
findMappings()
Return the mappings associated with this wrapper. |
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 . |
java.lang.String[] |
findSecurityReferences()
Return the set of security role reference names associated with this servlet, if any; otherwise return a zero-length array. |
boolean |
getAsyncSupported()
Return the async supported value. |
long |
getAvailable()
Return the available date/time for this servlet, in milliseconds since the epoch. |
java.lang.String |
getDescription()
Return the Servlet description. |
boolean |
getEnabled()
Return the enabled value. |
javax.servlet.ServletRegistration |
getFacade()
Get the facade ServletRegistration. |
InstanceSupport |
getInstanceSupport()
Return the InstanceSupport object for this Wrapper instance. |
java.lang.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). |
Multipart |
getMultipartConfig()
Multipart configuration for this Servlet. |
java.lang.String |
getRunAs()
Return the run-as identity for this servlet. |
javax.servlet.Servlet |
getServlet()
Return the associated servlet instance. |
java.lang.String |
getServletClass()
Return the fully qualified servlet class name for this servlet. |
java.lang.String[] |
getServletMethods()
Gets the names of the methods supported by the underlying servlet. |
javax.servlet.ServletSecurityElement |
getServletSecurity()
Get an associated ServletSecurity, if any. |
void |
incrementErrorCount()
Increment the error count value used when monitoring. |
boolean |
isDynamic()
Get the flag that indicates if the wrapper was added programmatically. |
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(java.lang.String name)
Remove the specified initialization parameter from this servlet. |
void |
removeInstanceListener(InstanceListener listener)
Remove a listener no longer interested in InstanceEvents. |
void |
removeMapping(java.lang.String mapping)
Remove a mapping associated with the wrapper. |
void |
removeSecurityReference(java.lang.String name)
Remove any security role reference for the specified role name. |
void |
setAsyncSupported(boolean asyncSupported)
Set the async supported value. |
void |
setAvailable(long available)
Set the available date/time for this servlet, in milliseconds since the epoch. |
void |
setDescription(java.lang.String description)
Set the description. |
void |
setDynamic(boolean dynamic)
Set a flag that indicates if the wrapper was added programmatically. |
void |
setEnabled(boolean enabled)
Set the enabled value. |
void |
setJspFile(java.lang.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 |
setMultipartConfig(Multipart multipartConfig)
Set the multipart configuration for this Servlet. |
void |
setRunAs(java.lang.String runAs)
Set the run-as identity for this servlet. |
void |
setServlet(javax.servlet.Servlet servlet)
Set the associated servlet instance. |
void |
setServletClass(java.lang.String servletClass)
Set the fully qualified servlet class name for this servlet. |
java.util.Set<java.lang.String> |
setServletSecurity(javax.servlet.ServletSecurityElement servletSecurity)
Set an associated ServletSecurity. |
void |
unavailable(javax.servlet.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. |
Method Detail |
---|
boolean getAsyncSupported()
void setAsyncSupported(boolean asyncSupported)
value
- New async supported valuelong getAvailable()
void setAvailable(long available)
available
- The new available date/timejava.lang.String getDescription()
void setDescription(java.lang.String description)
boolean isDynamic()
void setDynamic(boolean dynamic)
value
- New async supported valueboolean getEnabled()
void setEnabled(boolean enabled)
value
- New async supported valueInstanceSupport getInstanceSupport()
java.lang.String getJspFile()
void setJspFile(java.lang.String jspFile)
jspFile
- JSP file URIint getLoadOnStartup()
void setLoadOnStartup(int value)
value
- New load-on-startup valueMultipart getMultipartConfig()
void setMultipartConfig(Multipart multipartConfig)
java.lang.String getRunAs()
void setRunAs(java.lang.String runAs)
runAs
- New run-as identity valuejava.lang.String getServletClass()
void setServletClass(java.lang.String servletClass)
servletClass
- Servlet class namejava.lang.String[] getServletMethods() throws javax.servlet.ServletException
javax.servlet.ServletException
boolean isUnavailable()
void addInitParameter(java.lang.String name, java.lang.String value)
name
- Name of this initialization parameter to addvalue
- Value of this initialization parameter to addvoid addInstanceListener(InstanceListener listener)
listener
- The new listenervoid addMapping(java.lang.String mapping)
mapping
- The new wrapper mappingvoid addSecurityReference(java.lang.String name, java.lang.String link)
name
- Role name used within this servletlink
- Role name used within the web applicationjavax.servlet.Servlet allocate() throws javax.servlet.ServletException
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()
.
javax.servlet.ServletException
- if the servlet init() method threw
an exception
javax.servlet.ServletException
- if a loading error occursvoid deallocate(javax.servlet.Servlet servlet) throws javax.servlet.ServletException
servlet
- The servlet to be returned
javax.servlet.ServletException
- if a deallocation error occursjavax.servlet.ServletRegistration getFacade()
javax.servlet.Servlet getServlet()
void setServlet(javax.servlet.Servlet servlet)
java.lang.String findInitParameter(java.lang.String name)
null
.
name
- Name of the requested initialization parameterjava.lang.String[] findInitParameters()
java.lang.String[] findMappings()
java.lang.String findSecurityReference(java.lang.String name)
null
.
name
- Security role reference used within this servletjava.lang.String[] findSecurityReferences()
void incrementErrorCount()
void load() throws javax.servlet.ServletException
javax.servlet.ServletException
- if the servlet init() method threw
an exception
javax.servlet.ServletException
- if some other loading problem occursvoid removeInitParameter(java.lang.String name)
name
- Name of the initialization parameter to removevoid removeInstanceListener(InstanceListener listener)
listener
- The listener to removevoid removeMapping(java.lang.String mapping)
mapping
- The pattern to removevoid removeSecurityReference(java.lang.String name)
name
- Security role used within this servlet to be removedvoid unavailable(javax.servlet.UnavailableException unavailable)
unavailable
- The exception that occurred, or null
to mark this servlet as permanently unavailablevoid unload() throws javax.servlet.ServletException
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.
javax.servlet.ServletException
- if an unload error occursjava.util.Set<java.lang.String> setServletSecurity(javax.servlet.ServletSecurityElement servletSecurity)
javax.servlet.ServletSecurityElement getServletSecurity()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |