svn commit: r567266 - /myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/conversation/jsf/filter/OrchestraServletFilter.java

[sk...@apache.org]

Author: skitching
Date: Sat Aug 18 06:07:12 2007
New Revision: 567266

URL: http://svn.apache.org/viewvc?view=rev&rev=567266
Log:
Add javadoc only.

Modified:
    myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/conversation/jsf/filter/OrchestraServletFilter.java

Modified: myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/conversation/jsf/filter/OrchestraServletFilter.java
URL: http://svn.apache.org/viewvc/myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/conversation/jsf/filter/OrchestraServletFilter.java?view=diff&rev=567266&r1=567265&r2=567266
==============================================================================
--- myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/conversation/jsf/filter/OrchestraServletFilter.java (original)
+++ myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/conversation/jsf/filter/OrchestraServletFilter.java Sat Aug 18 06:07:12 2007
@@ -34,8 +34,13 @@
 import java.io.IOException;
 
 /**
- * Ensures that only one request per conversationContext can be processed at a time,
- * and also ensure all JDBC connections are returned to the pool.
+ * Perform a number of useful per-request tasks.
+ * <p>
+ * <h2>Make request/response objects accessible</h2>
+ * The request and response objects for the current request are stored in thread-local
+ * variables for the duration of this request. This makes it possible for any code to
+ * retrieve them via static methods on this class. This is required by at least
+ * the JsfFrameworkAdapter class, ie required when using Orchestra with JSF.
  * <p>
  * <h2>Request Synchronization</h2>
  * It is possible for multiple requests associated with the same http session to be