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

[sk...@apache.org]

Author: skitching
Date: Fri Oct  5 05:59:14 2007
New Revision: 582240

URL: http://svn.apache.org/viewvc?rev=582240&view=rev
Log:
Javadoc updates only.

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

Modified: myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/conversation/ConversationManager.java
URL: http://svn.apache.org/viewvc/myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/conversation/ConversationManager.java?rev=582240&r1=582239&r2=582240&view=diff
==============================================================================
--- myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/conversation/ConversationManager.java (original)
+++ myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/conversation/ConversationManager.java Fri Oct  5 05:59:14 2007
@@ -38,6 +38,12 @@
 /**
  * The manager will deal with the various contexts in the current session.
  * A new context will be created if the current window has none associated.
+ * <p>
+ * At the current time, this object does not serialize well. Any attempt to serialize
+ * this object (including any serialization of the user session) will just cause it
+ * to be discarded.
+ * <p>
+ * TODO: fix serialization issues.
  */
 public class ConversationManager implements Serializable
 {
@@ -305,9 +311,14 @@
 	}
 
 	/**
-	 * Get the Messager used to inform the user about anomalies.<br />
-	 * The factory can be configured in your web.xml using the init parameter named
-	 * <code>org.apache.myfaces.conversation.MESSAGER</code>
+	 * Get the Messager used to inform the user about anomalies.
+	 * <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 ConversationMessager getMessager()
 	{
@@ -317,12 +328,7 @@
 	/**
 	 * Create the Messager used to inform the user about anomalies.
 	 * <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>.
+	 * See {@link #getMessager()} for further details.
 	 */
 	private static ConversationMessager createMessager()
 	{
@@ -399,7 +405,7 @@
 		}
 	}
 
-	/**
+	/*
 	 * check if a bean with the given name will be managed by the conversationManager.
 	public boolean isManagedBean(String beanName)
 	{