svn commit: r582233 - /myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/conversation/ConversationMessager.java

[sk...@apache.org]

Author: skitching
Date: Fri Oct  5 05:50:37 2007
New Revision: 582233

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

Modified:
    myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/conversation/ConversationMessager.java

Modified: myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/conversation/ConversationMessager.java
URL: http://svn.apache.org/viewvc/myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/conversation/ConversationMessager.java?rev=582233&r1=582232&r2=582233&view=diff
==============================================================================
--- myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/conversation/ConversationMessager.java (original)
+++ myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/conversation/ConversationMessager.java Fri Oct  5 05:50:37 2007
@@ -28,6 +28,13 @@
  * problems in different ways; the concrete ConversationManager object used is therefore configurable.
  * <p>
  * All methods on this class must be implemented in a thread-safe manner.
+ * <p>
+ * The instance to use can be configured by defining a bean in the IOC configuration
+ * with the name org.apache.orchestra.conversation.ConversationMessager. This should
+ * be a "prototype" object, ie one that returns a new instance on each lookup. 
+ * <p>
+ * Alternatively the class to use can be configured in your web.xml using a servlet
+ * config init parameter named <code>org.apache.myfaces.conversation.MESSAGER</code>.
  */
 public abstract class ConversationMessager
 {
@@ -37,7 +44,6 @@
 	public void setConversationException(Throwable t)
 	{
 	}
-
 
 	/**
 	 * Display message about a not active conversation (close before the redirect).