Java Doc for StandardPipeline.java in  » Sevlet-Container » tomcat-catalina » 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 » Sevlet Container » tomcat catalina » org.apache.catalina.core 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.apache.catalina.core.StandardPipeline

StandardPipeline
public class StandardPipeline implements Pipeline,Contained,Lifecycle(Code)
Standard implementation of a processing Pipeline that will invoke a series of Valves that have been configured to be called in order. This implementation can be used for any type of Container. IMPLEMENTATION WARNING - This implementation assumes that no calls to addValve() or removeValve are allowed while a request is currently being processed. Otherwise, the mechanism by which per-thread state is maintained will need to be modified.
author:
   Craig R. McClanahan


Field Summary
protected  Valvebasic
     The basic Valve (if any) associated with this Pipeline.
protected  Containercontainer
     The Container with which this Pipeline is associated.
protected  intdebug
     The debugging detail level for this component.
protected  Stringinfo
     Descriptive information about this implementation.
protected  LifecycleSupportlifecycle
     The lifecycle event support for this component.
protected static  StringManagersm
     The string manager for this package.
protected  booleanstarted
    
protected  Valvevalves
     The set of Valves (not including the Basic one, if any) associated with this Pipeline.

Constructor Summary
public  StandardPipeline()
     Construct a new StandardPipeline instance with no associated Container.
public  StandardPipeline(Container container)
     Construct a new StandardPipeline instance that is associated with the specified Container.

Method Summary
public  voidaddLifecycleListener(LifecycleListener listener)
     Add a lifecycle event listener to this component.
public  voidaddValve(Valve valve)
    

Add a new Valve to the end of the pipeline associated with this Container.

public  LifecycleListener[]findLifecycleListeners()
     Get the lifecycle listeners associated with this lifecycle.
public  ValvegetBasic()
    

Return the Valve instance that has been distinguished as the basic Valve for this Pipeline (if any).

public  ContainergetContainer()
     Return the Container with which this Pipeline is associated.
public  StringgetInfo()
     Return descriptive information about this implementation class.
public  ObjectName[]getValveObjectNames()
    
public  Valve[]getValves()
     Return the set of Valves in the pipeline associated with this Container, including the basic Valve (if any).
public  voidinvoke(Request request, Response response)
     Cause the specified request and response to be processed by the Valves associated with this pipeline, until one of these valves causes the response to be created and returned.
protected  voidlog(String message)
     Log a message on the Logger associated with our Container (if any).
protected  voidlog(String message, Throwable throwable)
     Log a message on the Logger associated with our Container (if any).
public  voidremoveLifecycleListener(LifecycleListener listener)
     Remove a lifecycle event listener from this component.
public  voidremoveValve(Valve valve)
     Remove the specified Valve from the pipeline associated with this Container, if it is found; otherwise, do nothing.
public  voidsetBasic(Valve valve)
    

Set the Valve instance that has been distinguished as the basic Valve for this Pipeline (if any).

public  voidsetContainer(Container container)
     Set the Container with which this Pipeline is associated.
public synchronized  voidstart()
     Prepare for active use of the public methods of this Component.
public synchronized  voidstop()
     Gracefully shut down active use of the public methods of this Component.

Field Detail
basic
protected Valve basic(Code)
The basic Valve (if any) associated with this Pipeline.



container
protected Container container(Code)
The Container with which this Pipeline is associated.



debug
protected int debug(Code)
The debugging detail level for this component.



info
protected String info(Code)
Descriptive information about this implementation.



lifecycle
protected LifecycleSupport lifecycle(Code)
The lifecycle event support for this component.



sm
protected static StringManager sm(Code)
The string manager for this package.



started
protected boolean started(Code)
Has this component been started yet?



valves
protected Valve valves(Code)
The set of Valves (not including the Basic one, if any) associated with this Pipeline.




Constructor Detail
StandardPipeline
public StandardPipeline()(Code)
Construct a new StandardPipeline instance with no associated Container.



StandardPipeline
public StandardPipeline(Container container)(Code)
Construct a new StandardPipeline instance that is associated with the specified Container.
Parameters:
  container - The container we should be associated with




Method Detail
addLifecycleListener
public void addLifecycleListener(LifecycleListener listener)(Code)
Add a lifecycle event listener to this component.
Parameters:
  listener - The listener to add



addValve
public void addValve(Valve valve)(Code)

Add a new Valve to the end of the pipeline associated with this Container. Prior to adding the Valve, the Valve's setContainer() method will be called, if it implements Contained, with the owning Container as an argument. The method may throw an IllegalArgumentException if this Valve chooses not to be associated with this Container, or IllegalStateException if it is already associated with a different Container.


Parameters:
  valve - Valve to be added
exception:
  IllegalArgumentException - if this Container refused toaccept the specified Valve
exception:
  IllegalArgumentException - if the specifie Valve refuses to beassociated with this Container
exception:
  IllegalStateException - if the specified Valve is alreadyassociated with a different Container



findLifecycleListeners
public LifecycleListener[] findLifecycleListeners()(Code)
Get the lifecycle listeners associated with this lifecycle. If this Lifecycle has no listeners registered, a zero-length array is returned.



getBasic
public Valve getBasic()(Code)

Return the Valve instance that has been distinguished as the basic Valve for this Pipeline (if any).




getContainer
public Container getContainer()(Code)
Return the Container with which this Pipeline is associated.



getInfo
public String getInfo()(Code)
Return descriptive information about this implementation class.



getValveObjectNames
public ObjectName[] getValveObjectNames()(Code)



getValves
public Valve[] getValves()(Code)
Return the set of Valves in the pipeline associated with this Container, including the basic Valve (if any). If there are no such Valves, a zero-length array is returned.



invoke
public void invoke(Request request, Response response) throws IOException, ServletException(Code)
Cause the specified request and response to be processed by the Valves associated with this pipeline, until one of these valves causes the response to be created and returned. The implementation must ensure that multiple simultaneous requests (on different threads) can be processed through the same Pipeline without interfering with each other's control flow.
Parameters:
  request - The servlet request we are processing
Parameters:
  response - The servlet response we are creating
exception:
  IOException - if an input/output error occurs
exception:
  ServletException - if a servlet exception is thrown



log
protected void log(String message)(Code)
Log a message on the Logger associated with our Container (if any).
Parameters:
  message - Message to be logged



log
protected void log(String message, Throwable throwable)(Code)
Log a message on the Logger associated with our Container (if any).
Parameters:
  message - Message to be logged
Parameters:
  throwable - Associated exception



removeLifecycleListener
public void removeLifecycleListener(LifecycleListener listener)(Code)
Remove a lifecycle event listener from this component.
Parameters:
  listener - The listener to remove



removeValve
public void removeValve(Valve valve)(Code)
Remove the specified Valve from the pipeline associated with this Container, if it is found; otherwise, do nothing. If the Valve is found and removed, the Valve's setContainer(null) method will be called if it implements Contained.
Parameters:
  valve - Valve to be removed



setBasic
public void setBasic(Valve valve)(Code)

Set the Valve instance that has been distinguished as the basic Valve for this Pipeline (if any). Prioer to setting the basic Valve, the Valve's setContainer() will be called, if it implements Contained, with the owning Container as an argument. The method may throw an IllegalArgumentException if this Valve chooses not to be associated with this Container, or IllegalStateException if it is already associated with a different Container.


Parameters:
  valve - Valve to be distinguished as the basic Valve



setContainer
public void setContainer(Container container)(Code)
Set the Container with which this Pipeline is associated.
Parameters:
  container - The new associated container



start
public synchronized void start() throws LifecycleException(Code)
Prepare for active use of the public methods of this Component.
exception:
  LifecycleException - if this component detects a fatal errorthat prevents it from being started



stop
public synchronized void stop() throws LifecycleException(Code)
Gracefully shut down active use of the public methods of this Component.
exception:
  LifecycleException - if this component detects a fatal errorthat needs to be reported



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.