svn commit: r582671 - in /myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra: filter/ frameworkAdapter/ frameworkAdapter/local/

[sk...@apache.org]

Author: skitching
Date: Sun Oct  7 12:46:48 2007
New Revision: 582671

URL: http://svn.apache.org/viewvc?rev=582671&view=rev
Log:
Minor javadoc updates only.

Modified:
    myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/filter/OrchestraServletFilter.java
    myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/frameworkAdapter/FrameworkAdapter.java
    myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/frameworkAdapter/FrameworkAdapterInterface.java
    myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/frameworkAdapter/local/LocalFrameworkAdapter.java

Modified: myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/filter/OrchestraServletFilter.java
URL: http://svn.apache.org/viewvc/myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/filter/OrchestraServletFilter.java?rev=582671&r1=582670&r2=582671&view=diff
==============================================================================
--- myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/filter/OrchestraServletFilter.java (original)
+++ myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/filter/OrchestraServletFilter.java Sun Oct  7 12:46:48 2007
@@ -41,11 +41,12 @@
  * Note that it is necessary to define a filter that initialises the Orchestra
  * framework; this can be done either via a standalone filter such as
  * JsfFrameworkAdapterFilter, or via a filter that combines framework initialisation
- * with the functionality of this class, such as JsfOrchestraServletFilter.
+ * with the functionality of this class, such as 
+ * {@link org.apache.myfaces.orchestra.conversation.jsf.filter.OrchestraServletFilter}.
  * <p>
  * <h2>Request Serialization</h2>
  * It is possible for multiple requests associated with the same http session to be
- * received concurrently. In particular, ajax pages can cause this.
+ * received concurrently.
  * <p> 
  * By default, the servlet engine simply processes all requests concurrently
  * in different threads. However that can cause all sorts of unexpected problems with 

Modified: myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/frameworkAdapter/FrameworkAdapter.java
URL: http://svn.apache.org/viewvc/myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/frameworkAdapter/FrameworkAdapter.java?rev=582671&r1=582670&r2=582671&view=diff
==============================================================================
--- myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/frameworkAdapter/FrameworkAdapter.java (original)
+++ myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/frameworkAdapter/FrameworkAdapter.java Sun Oct  7 12:46:48 2007
@@ -23,11 +23,16 @@
 package org.apache.myfaces.orchestra.frameworkAdapter;
 
 /**
- * Provides a static method for returning the singleton FrameworkAdapterInterface, which allows Orchestra to
- * support MVC frameworks other than JSF.
+ * Provides a static method for returning the singleton FrameworkAdapterInterface that is
+ * appropriate for the current request.
+ * <p>
+ * This allows Orchestra to support MVC frameworks other than JSF. It also allows applications
+ * that use different presentation technologies (eg JSF and plain JSP) for different request
+ * urls to share the same conversational data.
  * <p>
  * A request filter must be configured which calls setInstance at the start of each request, and
- * setInstance(null) at the end of each request.
+ * setInstance(null) at the end of each request, passing the appropriate FrameworkAdapter
+ * class for the type of request received.
  */
 public final class FrameworkAdapter
 {

Modified: myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/frameworkAdapter/FrameworkAdapterInterface.java
URL: http://svn.apache.org/viewvc/myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/frameworkAdapter/FrameworkAdapterInterface.java?rev=582671&r1=582670&r2=582671&view=diff
==============================================================================
--- myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/frameworkAdapter/FrameworkAdapterInterface.java (original)
+++ myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/frameworkAdapter/FrameworkAdapterInterface.java Sun Oct  7 12:46:48 2007
@@ -26,7 +26,8 @@
 
 /**
  * An interface that provides access to all the data necessary for Orchestra to work while isolating Orchestra
- * from the actual MVC system being used. This allows Orchestra to support frameworks other than JSF.
+ * from the actual MVC system being used. This allows Orchestra to support multiple presentation
+ * frameworks, such as JSF and plain JSP.
  * <p>
  * Orchestra locates a concrete implementation of this class by using the FrameworkAdapter class, which supports
  * configuration of the actual underlying object returned.

Modified: myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/frameworkAdapter/local/LocalFrameworkAdapter.java
URL: http://svn.apache.org/viewvc/myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/frameworkAdapter/local/LocalFrameworkAdapter.java?rev=582671&r1=582670&r2=582671&view=diff
==============================================================================
--- myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/frameworkAdapter/local/LocalFrameworkAdapter.java (original)
+++ myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/frameworkAdapter/local/LocalFrameworkAdapter.java Sun Oct  7 12:46:48 2007
@@ -38,7 +38,17 @@
  * This is intended when Orchestra functionality is desired outside of any real
  * request/response type system. One example is where a job scheduler (eg quartz)
  * is used to execute background threads that want to execute the same beans that
- * can also be used.
+ * can also be used. In this case:
+ * <ol>
+ * <li>Create a new Thread object
+ * <li>Create a new LocalFrameworkAdapter instance
+ * <li>Within the new thread, call FrameworkAdapter.setInstance.
+ * </ol>
+ * When Orchestra methods are invoked from within the new thread, calls made to the
+ * framework adapter will be handled by the created LocalFrameworkAdapter instance,
+ * and will not interact with the user session, the original request or response.
+ * Because the session is new, no conversations will be inherited from the environment
+ * in which that new thread was created.
  * <p>
  * This class is not expected to be used very often.
  * <p>