svn commit: r566993 - /myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/conversation/jsf/ConversationPhaseListener.java

[sk...@apache.org]

Author: skitching
Date: Fri Aug 17 02:55:49 2007
New Revision: 566993

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

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

Modified: myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/conversation/jsf/ConversationPhaseListener.java
URL: http://svn.apache.org/viewvc/myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/conversation/jsf/ConversationPhaseListener.java?view=diff&rev=566993&r1=566992&r2=566993
==============================================================================
--- myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/conversation/jsf/ConversationPhaseListener.java (original)
+++ myfaces/orchestra/trunk/core/src/main/java/org/apache/myfaces/orchestra/conversation/jsf/ConversationPhaseListener.java Fri Aug 17 02:55:49 2007
@@ -31,9 +31,13 @@
 import java.util.Iterator;
 
 /**
- * <p/>
- * Initializes the Conversation system
- * </p>
+ * Ensure that Orchestra is initialised for the current user, and handle Flash conversations.
+ * <p>
+ * At start of request processing, if this is a new http session then initialise Orchestra
+ * for this session.
+ * <p>
+ * At the end of request processing, delete any flash-scope conversations for which no
+ * bean in that scope has been accessed during the request.
  */
 public class ConversationPhaseListener implements PhaseListener
 {