Prev Class | Next Class | Frames | No Frames |
Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
public interface Wrapper
extends Container
addChild()
method should throw an
IllegalArgumentException
.
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 |
|
void |
|
void |
|
void |
|
Servlet |
|
void |
|
String |
|
String[] |
|
String[] |
|
String |
|
String[] |
|
long |
|
String |
|
int |
|
String |
|
String |
|
void |
|
boolean |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
Methods inherited from interface org.apache.catalina.Container | |
addChild , addContainerListener , addPropertyChangeListener , backgroundProcess , findChild , findChildren , findContainerListeners , getBackgroundProcessorDelay , getCluster , getInfo , getLoader , getLogger , getManager , getMappingObject , getName , getParent , getParentClassLoader , getPipeline , getRealm , getResources , invoke , removeChild , removeContainerListener , removePropertyChangeListener , setBackgroundProcessorDelay , setCluster , setLoader , setLogger , setManager , setName , setParent , setParentClassLoader , setRealm , setResources |
public void addInitParameter(String name, String value)
Add a new servlet initialization parameter for this servlet.
- Parameters:
name
- Name of this initialization parameter to addvalue
- Value of this initialization parameter to add
public void addInstanceListener(InstanceListener listener)
Add a new listener interested in InstanceEvents.
- Parameters:
listener
- The new listener
public void addMapping(String mapping)
Add a mapping associated with the Wrapper.
- Parameters:
mapping
- The new wrapper mapping
public void addSecurityReference(String name, String link)
Add a new security role reference record to the set of records for this servlet.
- Parameters:
name
- Role name used within this servletlink
- Role name used within the web application
public Servlet allocate() throws ServletException
Allocate an initialized instance of this Servlet that is ready to have itsservice()
method called. If the servlet class does not implementSingleThreadModel
, the (only) initialized instance may be returned immediately. If the servlet class implementsSingleThreadModel
, the Wrapper implementation must ensure that this instance is not allocated again until it is deallocated by a call todeallocate()
.
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.
- Parameters:
servlet
- The servlet to be returned
public String findInitParameter(String name)
Return the value for the specified initialization parameter name, if any; otherwise returnnull
.
- Parameters:
name
- Name of the requested initialization parameter
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 returnnull
.
- Parameters:
name
- Security role reference used within this servlet
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 String getServletClass()
Return the fully qualified servlet class name for this 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.
- Parameters:
name
- Name of the initialization parameter to remove
public void removeInstanceListener(InstanceListener listener)
Remove a listener no longer interested in InstanceEvents.
- Parameters:
listener
- The listener to remove
public void removeMapping(String mapping)
Remove a mapping associated with the wrapper.
- Parameters:
mapping
- The pattern to remove
public void removeSecurityReference(String name)
Remove any security role reference for the specified role name.
- Parameters:
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.
- Parameters:
available
- The new available date/time
public void setJspFile(String jspFile)
Set the context-relative URI of the JSP file for this servlet.
- Parameters:
jspFile
- JSP file URI
public void setLoadOnStartup(int value)
Set the load-on-startup order value (negative value means load on first call).
- Parameters:
value
- New load-on-startup value
public void setRunAs(String runAs)
Set the run-as identity for this servlet.
- Parameters:
runAs
- New run-as identity value
public void setServletClass(String servletClass)
Set the fully qualified servlet class name for this servlet.
- Parameters:
servletClass
- Servlet class name
public void unavailable(UnavailableException unavailable)
Process an UnavailableException, marking this servlet as unavailable for the specified amount of time.
- Parameters:
unavailable
- The exception that occurred, ornull
to mark this servlet as permanently unavailable
public void unload() throws ServletException
Unload all initialized instances of this servlet, after calling thedestroy()
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.