You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@beehive.apache.org by ek...@apache.org on 2006/04/07 00:29:12 UTC

svn commit: r392098 - in /beehive/trunk/netui/src/pageflow/org/apache/beehive/netui/pageflow: GlobalApp.java PageFlowControlContainerImpl.java PageFlowStack.java internal/DeferredSessionStorageHandler.java internal/PageFlowBeanContext.java

Author: ekoneil
Date: Thu Apr  6 15:29:08 2006
New Revision: 392098

URL: http://svn.apache.org/viewcvs?rev=392098&view=rev
Log:
Doc tweaks made during code review.

BB: self
Test: NetUI pass


Modified:
    beehive/trunk/netui/src/pageflow/org/apache/beehive/netui/pageflow/GlobalApp.java
    beehive/trunk/netui/src/pageflow/org/apache/beehive/netui/pageflow/PageFlowControlContainerImpl.java
    beehive/trunk/netui/src/pageflow/org/apache/beehive/netui/pageflow/PageFlowStack.java
    beehive/trunk/netui/src/pageflow/org/apache/beehive/netui/pageflow/internal/DeferredSessionStorageHandler.java
    beehive/trunk/netui/src/pageflow/org/apache/beehive/netui/pageflow/internal/PageFlowBeanContext.java

Modified: beehive/trunk/netui/src/pageflow/org/apache/beehive/netui/pageflow/GlobalApp.java
URL: http://svn.apache.org/viewcvs/beehive/trunk/netui/src/pageflow/org/apache/beehive/netui/pageflow/GlobalApp.java?rev=392098&r1=392097&r2=392098&view=diff
==============================================================================
--- beehive/trunk/netui/src/pageflow/org/apache/beehive/netui/pageflow/GlobalApp.java (original)
+++ beehive/trunk/netui/src/pageflow/org/apache/beehive/netui/pageflow/GlobalApp.java Thu Apr  6 15:29:08 2006
@@ -77,4 +77,4 @@
         // Do nothing here -- Global.app actions do not 'count' as actions in the current page flow, unlike shared
         // flow actions.  This is basically deprecated behavior.
     }
-}
+}
\ No newline at end of file

Modified: beehive/trunk/netui/src/pageflow/org/apache/beehive/netui/pageflow/PageFlowControlContainerImpl.java
URL: http://svn.apache.org/viewcvs/beehive/trunk/netui/src/pageflow/org/apache/beehive/netui/pageflow/PageFlowControlContainerImpl.java?rev=392098&r1=392097&r2=392098&view=diff
==============================================================================
--- beehive/trunk/netui/src/pageflow/org/apache/beehive/netui/pageflow/PageFlowControlContainerImpl.java (original)
+++ beehive/trunk/netui/src/pageflow/org/apache/beehive/netui/pageflow/PageFlowControlContainerImpl.java Thu Apr  6 15:29:08 2006
@@ -42,9 +42,9 @@
 
     public ControlContainerContext getControlContainerContext(PageFlowManagedObject pfmo)
     {
-        // Based upon the type of controller return the bean context
-        // For PageFlowController and FacesBackingBean the control is in the object
-        // For SharedFlowController there is a shared object
+        // Based upon the type of controller find and return the appropriate ControlContainerContext (CCC)
+        // For PageFlowController and FacesBackingBean the CCC is obtained from the object directly
+        // For SharedFlowController there is a shared object maintained here
         if (pfmo instanceof SharedFlowController)
             return _sharedContext;
         if (pfmo instanceof PageFlowController)
@@ -52,7 +52,7 @@
         if (pfmo instanceof FacesBackingBean)
             return ((FacesBackingBean) pfmo)._beanContext;
 
-        // This is an unknown type.  Assert this, log it and then return null
+        // Found an unknown type of PageFlowManagedObject.  Assert this, log it, and then return null
         _log.error("Unknown FlowController ControlBeanContenxt:" + pfmo.getClass().getName());
         assert(false) : "Unknown FlowController ControlBeanContenxt:" + pfmo.getClass().getName();
         return null;
@@ -95,20 +95,20 @@
         if (pfmo instanceof SharedFlowController) {
             if (_sharedContext == null) {
                 _sharedContext = (ControlContainerContext)
-                        AdapterManager.getServletContainerAdapter(servletContext).createControlBeanContext( request, response );
+                    AdapterManager.getServletContainerAdapter(servletContext).createControlBeanContext( request, response );
                 _sharedLock = new ReentrantLock();
             }
         }
         else if (pfmo instanceof PageFlowController) {
             if (((PageFlowController) pfmo)._beanContext == null) {
                 ((PageFlowController) pfmo)._beanContext = (ControlContainerContext)
-                        AdapterManager.getServletContainerAdapter(servletContext).createControlBeanContext( request, response );
+                    AdapterManager.getServletContainerAdapter(servletContext).createControlBeanContext( request, response );
             }
         }
         else if (pfmo instanceof FacesBackingBean) {
             if (((FacesBackingBean) pfmo)._beanContext == null) {
                 ((FacesBackingBean) pfmo)._beanContext = (ControlContainerContext)
-                        AdapterManager.getServletContainerAdapter(servletContext).createControlBeanContext( request, response );
+                    AdapterManager.getServletContainerAdapter(servletContext).createControlBeanContext( request, response );
             }
         }
         else {
@@ -121,7 +121,6 @@
 
     public void endContextOnPageFlow(PageFlowManagedObject flowController)
     {
-
         // You must reverse the order of the begin because the low level stuff uses a stack for
         // this.  We also do this with a try/finally so that we make sure to free up the lock.
         try {

Modified: beehive/trunk/netui/src/pageflow/org/apache/beehive/netui/pageflow/PageFlowStack.java
URL: http://svn.apache.org/viewcvs/beehive/trunk/netui/src/pageflow/org/apache/beehive/netui/pageflow/PageFlowStack.java?rev=392098&r1=392097&r2=392098&view=diff
==============================================================================
--- beehive/trunk/netui/src/pageflow/org/apache/beehive/netui/pageflow/PageFlowStack.java (original)
+++ beehive/trunk/netui/src/pageflow/org/apache/beehive/netui/pageflow/PageFlowStack.java Thu Apr  6 15:29:08 2006
@@ -37,10 +37,17 @@
 import java.util.Stack;
 import java.io.Serializable;
 
-
 /**
+ * <p>
  * Stack for keeping track of a series of nested page flows.  When a nested page flow is entered,
  * the previous page flow is pushed onto this stack, which is kept in the user session.
+ * </p>
+ * <p>
+ * This Stack implements the {@link HttpSessionBindingListener} which will receive a callback when
+ * this is removed from the {@link HttpSession}.  At this time, any PageFlowController instances stored
+ * on the stack will be destroyed using the {@link PageFlowManagedObject#destroy(javax.servlet.http.HttpSession)}
+ * lifecycle method.
+ * </p>
  */ 
 public class PageFlowStack
         implements HttpSessionBindingListener, Serializable
@@ -341,14 +348,14 @@
     }
     
     /**
-     * Callback for HttpSessionBindingListener -- should not be invoked directly.
+     * Callback for {@link HttpSessionBindingListener} -- should not be invoked directly.
      */
     public void valueBound( HttpSessionBindingEvent event )
     {
     }
 
     /**
-     * Callback for HttpSessionBindingListener -- should not be invoked directly.
+     * Callback for {@link HttpSessionBindingListener} -- should not be invoked directly.
      */
     public void valueUnbound( HttpSessionBindingEvent event )
     {

Modified: beehive/trunk/netui/src/pageflow/org/apache/beehive/netui/pageflow/internal/DeferredSessionStorageHandler.java
URL: http://svn.apache.org/viewcvs/beehive/trunk/netui/src/pageflow/org/apache/beehive/netui/pageflow/internal/DeferredSessionStorageHandler.java?rev=392098&r1=392097&r2=392098&view=diff
==============================================================================
--- beehive/trunk/netui/src/pageflow/org/apache/beehive/netui/pageflow/internal/DeferredSessionStorageHandler.java (original)
+++ beehive/trunk/netui/src/pageflow/org/apache/beehive/netui/pageflow/internal/DeferredSessionStorageHandler.java Thu Apr  6 15:29:08 2006
@@ -231,7 +231,8 @@
                         
                     //
                     // This ThreadLocal value allows others (e.g., an HttpSessionBindingListener like
-                    // PageFlowManagedObject) that we're in the middle of committing changes to the session.
+                    // PageFlowManagedObject) to query whether the Framework is in the middle of committing
+                    // changes to the session
                     //
                     _isCommittingChanges.set( Boolean.TRUE );
 

Modified: beehive/trunk/netui/src/pageflow/org/apache/beehive/netui/pageflow/internal/PageFlowBeanContext.java
URL: http://svn.apache.org/viewcvs/beehive/trunk/netui/src/pageflow/org/apache/beehive/netui/pageflow/internal/PageFlowBeanContext.java?rev=392098&r1=392097&r2=392098&view=diff
==============================================================================
--- beehive/trunk/netui/src/pageflow/org/apache/beehive/netui/pageflow/internal/PageFlowBeanContext.java (original)
+++ beehive/trunk/netui/src/pageflow/org/apache/beehive/netui/pageflow/internal/PageFlowBeanContext.java Thu Apr  6 15:29:08 2006
@@ -17,6 +17,8 @@
  */
 package org.apache.beehive.netui.pageflow.internal;
 
+import javax.servlet.ServletRequest;
+
 import org.apache.beehive.controls.runtime.servlet. ServletBeanContext;
 import org.apache.beehive.netui.pageflow.PageFlowController;
 
@@ -34,6 +36,7 @@
       */
      public void initialize()
      {
+         // todo: this should move to a single point _outside_ of the initialize method 
          super.initialize();
          addService( PageFlowController.class, PageFlowServiceProvider.getProvider() );
      }