svn commit: r582100 - /myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/frameworkAdapter/local/LocalFrameworkAdapter.java

[sk...@apache.org]

Author: skitching
Date: Fri Oct  5 00:20:22 2007
New Revision: 582100

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

Modified:
    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/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=582100&r1=582099&r2=582100&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 Fri Oct  5 00:20:22 2007
@@ -33,13 +33,20 @@
 import java.util.Map;
 
 /**
+ * A FrameworkAdapter which uses local maps to simulate a servlet environment.
  * <p>
- * A FrameworkAdapter which uses local maps to simulate a real framework.
- * </p>
+ * 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.
  * <p>
- * This adapter sill relies on Spring and thus you have to ensure to call {@link #setApplicationContext}
- * on it.
- * </p> 
+ * This class is not expected to be used very often.
+ * <p>
+ * Note that this adapter relies on Spring and thus you have to ensure
+ * {@link #setApplicationContext} is called.
+ * <p>
+ * Note also that because this is intended for use only without a real request
+ * and response, there is no corresponding Filter class.
  */
 public class LocalFrameworkAdapter implements FrameworkAdapterInterface, ApplicationContextAware
 {