Java Doc for Wrapper.java in » Sevlet-Container » tomcat-catalina » org » apache » catalina » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation

1.	6.0 JDK Core
2.	6.0 JDK Modules
3.	6.0 JDK Modules com.sun
4.	6.0 JDK Modules com.sun.java
5.	6.0 JDK Modules sun
6.	6.0 JDK Platform
7.	Ajax
8.	Apache Harmony Java SE
9.	Aspect oriented
10.	Authentication Authorization
11.	Blogger System
12.	Build
13.	Byte Code
14.	Cache
15.	Chart
16.	Chat
17.	Code Analyzer
18.	Collaboration
19.	Content Management System
20.	Database Client
21.	Database DBMS
22.	Database JDBC Connection Pool
23.	Database ORM
24.	Development
25.	EJB Server geronimo
26.	EJB Server GlassFish
27.	EJB Server JBoss 4.2.1
28.	EJB Server resin 3.1.5
29.	ERP CRM Financial
30.	ESB
31.	Forum
32.	GIS
33.	Graphic Library
34.	Groupware
35.	HTML Parser
36.	IDE
37.	IDE Eclipse
38.	IDE Netbeans
39.	Installer
40.	Internationalization Localization
41.	Inversion of Control
42.	Issue Tracking
43.	J2EE
44.	JBoss
45.	JMS
46.	JMX
47.	Library
48.	Mail Clients
49.	Net
50.	Parser
51.	PDF
52.	Portal
53.	Profiler
54.	Project Management
55.	Report
56.	RSS RDF
57.	Rule Engine
58.	Science
59.	Scripting
60.	Search Engine
61.	Security
62.	Sevlet Container
63.	Source Control
64.	Swing Library
65.	Template Engine
66.	Test Coverage
67.	Testing
68.	UML
69.	Web Crawler
70.	Web Framework
71.	Web Mail
72.	Web Server
73.	Web Services
74.	Web Services apache cxf 2.0.1
75.	Web Services AXIS2
76.	Wiki Engine
77.	Workflow Engines
78.	XML
79.	XML UI

Java

Java Tutorial

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL Tutorial

Flash / Flex / ActionScript

VBA / Excel / Access / Word

XML

XML Tutorial

Microsoft Office PowerPoint 2007 Tutorial

Microsoft Office Excel 2007 Tutorial

Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » Sevlet Container » tomcat catalina » org.apache.catalina

Source Cross Reference Class Diagram Java Document (Java Doc)

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: 2004/05/26 15:28:42 $

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 addMapping(String mapping)
     Add a mapping associated with the Wrapper.
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[] 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 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 void incrementErrorCount()
     Increment the error count value used when monitoring.
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 removeMapping(String mapping)
     Remove a mapping associated with the wrapper.
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.

Method Detail
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

addMapping
public void addMapping(String mapping)(Code)
Add a mapping associated with the Wrapper.
Parameters:
  mapping - The new wrapper mapping

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

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.

findMappings
public String[] findMappings()(Code)
Return the mappings associated with this wrapper.

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.

incrementErrorCount
public void incrementErrorCount()(Code)
Increment the error count value used when monitoring.

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

removeMapping
public void removeMapping(String mapping)(Code)
Remove a mapping associated with the wrapper.
Parameters:
  mapping - The pattern 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:
  runAs - 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

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.