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

[sk...@apache.org]

Author: skitching
Date: Thu Oct  4 14:13:46 2007
New Revision: 582013

URL: http://svn.apache.org/viewvc?rev=582013&view=rev
Log:
Comment/javadoc changes 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=582013&r1=582012&r2=582013&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 Thu Oct  4 14:13:46 2007
@@ -50,6 +50,9 @@
 
 	private static final Iterator EMPTY_ITERATOR = Collections.EMPTY_LIST.iterator();
 
+	// TODO: consider whether a static value is the best way to generate context ids; they
+	// only need to be unique within a user session. And why is this variable in upper case;
+	// it isn't a constant...
 	private static long NEXT_CONVERSATION_CONTEXT = 1;
 
 	private final Log log = LogFactory.getLog(ConversationManager.class);
@@ -63,8 +66,6 @@
 	// are no thread-safety issues with accessing this member.
 	private ConversationMessager conversationMessager;
 
-	// private Set managedScopes;
-
 	protected ConversationManager()
 	{
 	}
@@ -116,9 +117,12 @@
 	}
 
 	/**
-	 * Get the current, or create a new unique conversationContextId.<br />
-	 * The current conversationContextId will retrieved from the request parameters, if we cant find it there
-	 * a new one will be created. In either case the result will be stored within the request for faster lookup.
+	 * Get the current, or create a new unique conversationContextId.
+	 * <p>
+	 * The current conversationContextId will retrieved from the request parameters. If no such parameter is
+	 * present then a new id will be allocated and a new ConversationContext created.
+	 * <p>
+	 * In either case the result will be stored within the request for faster lookup.
 	 * <p>
 	 * Note that there is no security flaw regarding injection of fake context ids; the id must match one already
 	 * in the session and there is no security problem with two windows in the same session exchanging ids.
@@ -210,7 +214,7 @@
 	}
 
 	/**
-	 * Start a conversation
+	 * Start a conversation.
 	 *
 	 * @see ConversationContext#startConversation(String, ConversationFactory)
 	 */
@@ -223,7 +227,7 @@
 
 	/**
 	 * Remove a conversation
-	 * <p/>
+	 *
 	 * <p>Notice: Its assumed that the conversation has already been invalidated</p>
 	 *
 	 * @see ConversationContext#removeConversation(String)