Java Doc for StandardWrapper.java in  » Web-Server » Rimfaxe-Web-Server » org » apache » catalina » core » 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
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net 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 » Web Server » Rimfaxe Web Server » org.apache.catalina.core 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.apache.catalina.core.ContainerBase
      org.apache.catalina.core.StandardWrapper

StandardWrapper
final public class StandardWrapper extends ContainerBase implements ServletConfig,Wrapper(Code)
Standard implementation of the Wrapper interface that represents an individual servlet definition. No child Containers are allowed, and the parent Container must be a Context.
author:
   Craig R. McClanahan
author:
   Remy Maucherat
version:
   $Revision: 1.39 $ $Date: 2002/06/26 13:41:12 $



Constructor Summary
public  StandardWrapper()
     Create a new StandardWrapper component with the default basic Valve.

Method Summary
public  voidaddChild(Container child)
     Refuse to add a child Container, because Wrappers are the lowest level of the Container hierarchy.
protected  voidaddDefaultMapper(String mapperClass)
     Add a default Mapper implementation if none have been configured explicitly.
public  voidaddInitParameter(String name, String value)
     Add a new servlet initialization parameter for this servlet.
public  voidaddInstanceListener(InstanceListener listener)
     Add a new listener interested in InstanceEvents.
public  voidaddSecurityReference(String name, String link)
     Add a new security role reference record to the set of records for this servlet.
public  Servletallocate()
     Allocate an initialized instance of this Servlet that is ready to have its service() method called.
public  voiddeallocate(Servlet servlet)
     Return this previously allocated servlet to the pool of available instances.
public  StringfindInitParameter(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  StringfindSecurityReference(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  longgetAvailable()
     Return the available date/time for this servlet, in milliseconds since the epoch.
public  intgetCountAllocated()
     Return the number of active allocations of this servlet, even if they are all for the same instance (as will be true for servlets that do not implement SingleThreadModel.
public  intgetDebug()
     Return the debugging detail level for this component.
public  StringgetInfo()
     Return descriptive information about this Container implementation and the corresponding version number, in the format <description>/<version>.
public  StringgetInitParameter(String name)
     Return the initialization parameter value for the specified name, if any; otherwise return null.
public  EnumerationgetInitParameterNames()
     Return the set of initialization parameter names defined for this servlet.
public  InstanceSupportgetInstanceSupport()
     Return the InstanceSupport object for this Wrapper instance.
public  StringgetJspFile()
     Return the context-relative URI of the JSP file for this servlet.
public  intgetLoadOnStartup()
     Return the load-on-startup order value (negative value means load on first call).
public  intgetMaxInstances()
     Return maximum number of instances that will be allocated when a single thread model servlet is used.
public  StringgetRunAs()
     Return the run-as identity for this servlet.
public  StringgetServletClass()
     Return the fully qualified servlet class name for this servlet.
public  ServletContextgetServletContext()
     Return the servlet context with which this servlet is associated.
public  StringgetServletName()
     Return the name of this servlet.
public  booleanisSingleThreadModel()
     Return true if the servlet class represented by this component implements the SingleThreadModel interface.
public  booleanisUnavailable()
    
public synchronized  voidload()
     Load and initialize an instance of this servlet, if there is not already at least one initialized instance.
public synchronized  ServletloadServlet()
     Load and initialize an instance of this servlet, if there is not already at least one initialized instance.
protected  StringlogName()
     Log the abbreviated name of this Container for logging messages.
public  voidremoveInitParameter(String name)
     Remove the specified initialization parameter from this servlet.
public  voidremoveInstanceListener(InstanceListener listener)
     Remove a listener no longer interested in InstanceEvents.
public  voidremoveSecurityReference(String name)
     Remove any security role reference for the specified role name.
public  voidsetAvailable(long available)
     Set the available date/time for this servlet, in milliseconds since the epoch.
public  voidsetDebug(int debug)
     Set the debugging detail level for this component.
public  voidsetJspFile(String jspFile)
     Set the context-relative URI of the JSP file for this servlet.
public  voidsetLoadOnStartup(int value)
     Set the load-on-startup order value (negative value means load on first call).
public  voidsetLoadOnStartupString(String value)
     Set the load-on-startup order value from a (possibly null) string.
public  voidsetMaxInstances(int maxInstances)
     Set the maximum number of instances that will be allocated when a single thread model servlet is used.
public  voidsetParent(Container container)
     Set the parent Container of this Wrapper, but only if it is a Context.
public  voidsetRunAs(String runAs)
     Set the run-as identity for this servlet.
public  voidsetServletClass(String servletClass)
     Set the fully qualified servlet class name for this servlet.
public  voidsetServletName(String name)
     Set the name of this servlet.
public  voidstart()
     Start this component, pre-loading the servlet if the load-on-startup value is set appropriately.
public  voidstop()
     Stop this component, gracefully shutting down the servlet if it has been initialized.
public  StringtoString()
     Return a String representation of this component.
public  voidunavailable(UnavailableException unavailable)
     Process an UnavailableException, marking this servlet as unavailable for the specified amount of time.
public synchronized  voidunload()
     Unload all initialized instances of this servlet, after calling the destroy() method for each instance.


Constructor Detail
StandardWrapper
public StandardWrapper()(Code)
Create a new StandardWrapper component with the default basic Valve.




Method Detail
addChild
public void addChild(Container child)(Code)
Refuse to add a child Container, because Wrappers are the lowest level of the Container hierarchy.
Parameters:
  child - Child container to be added



addDefaultMapper
protected void addDefaultMapper(String mapperClass)(Code)
Add a default Mapper implementation if none have been configured explicitly.
Parameters:
  mapperClass - Java class name of the default Mapper



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



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.



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.



getCountAllocated
public int getCountAllocated()(Code)
Return the number of active allocations of this servlet, even if they are all for the same instance (as will be true for servlets that do not implement SingleThreadModel.



getDebug
public int getDebug()(Code)
Return the debugging detail level for this component.



getInfo
public String getInfo()(Code)
Return descriptive information about this Container implementation and the corresponding version number, in the format <description>/<version>.



getInitParameter
public String getInitParameter(String name)(Code)
Return the initialization parameter value for the specified name, if any; otherwise return null.
Parameters:
  name - Name of the initialization parameter to retrieve



getInitParameterNames
public Enumeration getInitParameterNames()(Code)
Return the set of initialization parameter names defined for this servlet. If none are defined, an empty Enumeration is returned.



getInstanceSupport
public InstanceSupport getInstanceSupport()(Code)
Return the InstanceSupport object for this Wrapper instance.



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).



getMaxInstances
public int getMaxInstances()(Code)
Return maximum number of instances that will be allocated when a single thread model servlet is used.



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.



getServletContext
public ServletContext getServletContext()(Code)
Return the servlet context with which this servlet is associated.



getServletName
public String getServletName()(Code)
Return the name of this servlet.



isSingleThreadModel
public boolean isSingleThreadModel()(Code)
Return true if the servlet class represented by this component implements the SingleThreadModel interface.



isUnavailable
public boolean isUnavailable()(Code)
Is this servlet currently unavailable?



load
public synchronized 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.

IMPLEMENTATION NOTE: Servlets whose classnames begin with org.apache.catalina. (so-called "container" servlets) are loaded by the same classloader that loaded this class, rather than the classloader for the current web application. This gives such classes access to Catalina internals, which are prevented for classes loaded for web applications.
exception:
  ServletException - if the servlet init() method threwan exception
exception:
  ServletException - if some other loading problem occurs




loadServlet
public synchronized Servlet loadServlet() 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.



logName
protected String logName()(Code)
Log the abbreviated name of this Container for logging messages.



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



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.
Parameters:
  available - The new available date/time



setDebug
public void setDebug(int debug)(Code)
Set the debugging detail level for this component.
Parameters:
  debug - The new debugging detail level



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



setLoadOnStartupString
public void setLoadOnStartupString(String value)(Code)
Set the load-on-startup order value from a (possibly null) string. Per the specification, any missing or non-numeric value is converted to a zero, so that this servlet will still be loaded at startup time, but in an arbitrary order.
Parameters:
  value - New load-on-startup value



setMaxInstances
public void setMaxInstances(int maxInstances)(Code)
Set the maximum number of instances that will be allocated when a single thread model servlet is used.
Parameters:
  maxInstnces - New value of maxInstances



setParent
public void setParent(Container container)(Code)
Set the parent Container of this Wrapper, but only if it is a Context.
Parameters:
  container - Proposed parent Container



setRunAs
public void setRunAs(String runAs)(Code)
Set the run-as identity for this servlet.
Parameters:
  value - 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



setServletName
public void setServletName(String name)(Code)
Set the name of this servlet. This is an alias for the normal Container.setName() method, and complements the getServletName() method required by the ServletConfig interface.
Parameters:
  name - The new name of this servlet



start
public void start() throws LifecycleException(Code)
Start this component, pre-loading the servlet if the load-on-startup value is set appropriately.
exception:
  LifecycleException - if a fatal error occurs during startup



stop
public void stop() throws LifecycleException(Code)
Stop this component, gracefully shutting down the servlet if it has been initialized.
exception:
  LifecycleException - if a fatal error occurs during shutdown



toString
public String toString()(Code)
Return a String representation of this component.



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 synchronized 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 exception is thrown by thedestroy() method



Fields inherited from org.apache.catalina.core.ContainerBase
protected HashMap children(Code)(Java Doc)
protected Cluster cluster(Code)(Java Doc)
protected int debug(Code)(Java Doc)
protected LifecycleSupport lifecycle(Code)(Java Doc)
protected ArrayList listeners(Code)(Java Doc)
protected Loader loader(Code)(Java Doc)
protected Logger logger(Code)(Java Doc)
protected Manager manager(Code)(Java Doc)
protected Mapper mapper(Code)(Java Doc)
protected String mapperClass(Code)(Java Doc)
protected HashMap mappers(Code)(Java Doc)
protected String name(Code)(Java Doc)
protected Container parent(Code)(Java Doc)
protected ClassLoader parentClassLoader(Code)(Java Doc)
protected Pipeline pipeline(Code)(Java Doc)
protected Realm realm(Code)(Java Doc)
protected DirContext resources(Code)(Java Doc)
protected static StringManager sm(Code)(Java Doc)
protected boolean started(Code)(Java Doc)
protected PropertyChangeSupport support(Code)(Java Doc)

Methods inherited from org.apache.catalina.core.ContainerBase
public void addChild(Container child)(Code)(Java Doc)
public void addContainerListener(ContainerListener listener)(Code)(Java Doc)
protected void addDefaultMapper(String mapperClass)(Code)(Java Doc)
public void addLifecycleListener(LifecycleListener listener)(Code)(Java Doc)
public void addMapper(Mapper mapper)(Code)(Java Doc)
public void addPropertyChangeListener(PropertyChangeListener listener)(Code)(Java Doc)
public synchronized void addValve(Valve valve)(Code)(Java Doc)
public Container findChild(String name)(Code)(Java Doc)
public Container[] findChildren()(Code)(Java Doc)
public ContainerListener[] findContainerListeners()(Code)(Java Doc)
public LifecycleListener[] findLifecycleListeners()(Code)(Java Doc)
public Mapper findMapper(String protocol)(Code)(Java Doc)
public Mapper[] findMappers()(Code)(Java Doc)
public void fireContainerEvent(String type, Object data)(Code)(Java Doc)
public Valve getBasic()(Code)(Java Doc)
public Cluster getCluster()(Code)(Java Doc)
public int getDebug()(Code)(Java Doc)
abstract public String getInfo()(Code)(Java Doc)
public Loader getLoader()(Code)(Java Doc)
public Logger getLogger()(Code)(Java Doc)
public Manager getManager()(Code)(Java Doc)
public String getName()(Code)(Java Doc)
public Container getParent()(Code)(Java Doc)
public ClassLoader getParentClassLoader()(Code)(Java Doc)
public Pipeline getPipeline()(Code)(Java Doc)
public Realm getRealm()(Code)(Java Doc)
public DirContext getResources()(Code)(Java Doc)
public Valve[] getValves()(Code)(Java Doc)
public void invoke(Request request, Response response) throws IOException, ServletException(Code)(Java Doc)
protected void log(String message)(Code)(Java Doc)
protected void log(String message, Throwable throwable)(Code)(Java Doc)
protected String logName()(Code)(Java Doc)
public Container map(Request request, boolean update)(Code)(Java Doc)
public void removeChild(Container child)(Code)(Java Doc)
public void removeContainerListener(ContainerListener listener)(Code)(Java Doc)
public void removeLifecycleListener(LifecycleListener listener)(Code)(Java Doc)
public void removeMapper(Mapper mapper)(Code)(Java Doc)
public void removePropertyChangeListener(PropertyChangeListener listener)(Code)(Java Doc)
public synchronized void removeValve(Valve valve)(Code)(Java Doc)
public void setBasic(Valve valve)(Code)(Java Doc)
public synchronized void setCluster(Cluster cluster)(Code)(Java Doc)
public void setDebug(int debug)(Code)(Java Doc)
public synchronized void setLoader(Loader loader)(Code)(Java Doc)
public synchronized void setLogger(Logger logger)(Code)(Java Doc)
public synchronized void setManager(Manager manager)(Code)(Java Doc)
public void setName(String name)(Code)(Java Doc)
public void setParent(Container container)(Code)(Java Doc)
public void setParentClassLoader(ClassLoader parent)(Code)(Java Doc)
public synchronized void setRealm(Realm realm)(Code)(Java Doc)
public synchronized void setResources(DirContext resources)(Code)(Java Doc)
public synchronized void start() throws LifecycleException(Code)(Java Doc)
public synchronized void stop() throws LifecycleException(Code)(Java Doc)

Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.