svn commit: r358045 - in /beehive/trunk/netui/src: compiler-core/org/apache/beehive/netui/compiler/ pageflow/org/apache/beehive/netui/pageflow/ pageflow/org/apache/beehive/netui/pageflow/internal/

[ri...@apache.org]

Author: rich
Date: Tue Dec 20 09:22:38 2005
New Revision: 358045

URL: http://svn.apache.org/viewcvs?rev=358045&view=rev
Log:
JavaDoc and code commenting.


Modified:
    beehive/trunk/netui/src/compiler-core/org/apache/beehive/netui/compiler/diagnostics.properties
    beehive/trunk/netui/src/pageflow/org/apache/beehive/netui/pageflow/PageFlowPageFilter.java
    beehive/trunk/netui/src/pageflow/org/apache/beehive/netui/pageflow/PageFlowRequestProcessor.java
    beehive/trunk/netui/src/pageflow/org/apache/beehive/netui/pageflow/internal/FlowControllerAction.java
    beehive/trunk/netui/src/pageflow/org/apache/beehive/netui/pageflow/internal/PageFlowRequestWrapper.java

Modified: beehive/trunk/netui/src/compiler-core/org/apache/beehive/netui/compiler/diagnostics.properties
URL: http://svn.apache.org/viewcvs/beehive/trunk/netui/src/compiler-core/org/apache/beehive/netui/compiler/diagnostics.properties?rev=358045&r1=358044&r2=358045&view=diff
==============================================================================
--- beehive/trunk/netui/src/compiler-core/org/apache/beehive/netui/compiler/diagnostics.properties (original)
+++ beehive/trunk/netui/src/compiler-core/org/apache/beehive/netui/compiler/diagnostics.properties Tue Dec 20 09:22:38 2005
@@ -214,7 +214,6 @@
 Field {0} is of a type that extends {1}, but it has no @{2} annotation.  It will not be initialized automatically.
 
 error.missing-option = The "{0}" option is required.  It is specified by passing "{0}{1}<value>" as an option to apt.
-warning.could-not-read-web-xml = Could not find/read web.xml.
 
 error.only-valid-on-pageflow = The "{0}" attribute may only be used on a class that extends {1}.
 warning.formdata-override-validate = \

Modified: beehive/trunk/netui/src/pageflow/org/apache/beehive/netui/pageflow/PageFlowPageFilter.java
URL: http://svn.apache.org/viewcvs/beehive/trunk/netui/src/pageflow/org/apache/beehive/netui/pageflow/PageFlowPageFilter.java?rev=358045&r1=358044&r2=358045&view=diff
==============================================================================
--- beehive/trunk/netui/src/pageflow/org/apache/beehive/netui/pageflow/PageFlowPageFilter.java (original)
+++ beehive/trunk/netui/src/pageflow/org/apache/beehive/netui/pageflow/PageFlowPageFilter.java Tue Dec 20 09:22:38 2005
@@ -268,7 +268,7 @@
         if ( curJpf != null )
         {
             //
-            // We're going to bail out if there are too many concurrent requests for the same JPF.
+            // We're going to bail out if there are too many concurrent requests for the same page flow.
             // This prevents an attack that takes advantage of the fact that we synchronize requests
             // to the same pageflow.
             //

Modified: beehive/trunk/netui/src/pageflow/org/apache/beehive/netui/pageflow/PageFlowRequestProcessor.java
URL: http://svn.apache.org/viewcvs/beehive/trunk/netui/src/pageflow/org/apache/beehive/netui/pageflow/PageFlowRequestProcessor.java?rev=358045&r1=358044&r2=358045&view=diff
==============================================================================
--- beehive/trunk/netui/src/pageflow/org/apache/beehive/netui/pageflow/PageFlowRequestProcessor.java (original)
+++ beehive/trunk/netui/src/pageflow/org/apache/beehive/netui/pageflow/PageFlowRequestProcessor.java Tue Dec 20 09:22:38 2005
@@ -141,6 +141,11 @@
         return super.processActionCreate( request, response, actionMapping );
     }
 
+    /**
+     * See if this action mapping is our custom config type, and if so, see if the action should use a member variable
+     * in the page flow controller as its form bean (the <code>useFormBean</code> attribute on
+     * <code>&#64;Jpf.Action</code>).  If so, return the appropriate Field in the controller class.
+     */
     private Field getPageFlowScopedFormMember( ActionMapping mapping, HttpServletRequest request )
     {
         if ( mapping instanceof PageFlowActionMapping )
@@ -475,7 +480,7 @@
         }
 
         //
-        // Create the appropriate SharedFlowController if it doesn't exist.
+        // Look up or create the appropriate SharedFlowControllers if they doesn't exist.
         //
         if ( _log.isInfoEnabled() )
         {
@@ -797,7 +802,7 @@
         InternalUtils.setServletContext( request, servletContext );
 
         //
-        // Callback to the server adapter.
+        // Callback to the servlet container adapter.
         //
         PageFlowEventReporter er = _servletContainerAdapter.getEventReporter();
         _servletContainerAdapter.beginRequest( request, response );

Modified: beehive/trunk/netui/src/pageflow/org/apache/beehive/netui/pageflow/internal/FlowControllerAction.java
URL: http://svn.apache.org/viewcvs/beehive/trunk/netui/src/pageflow/org/apache/beehive/netui/pageflow/internal/FlowControllerAction.java?rev=358045&r1=358044&r2=358045&view=diff
==============================================================================
--- beehive/trunk/netui/src/pageflow/org/apache/beehive/netui/pageflow/internal/FlowControllerAction.java (original)
+++ beehive/trunk/netui/src/pageflow/org/apache/beehive/netui/pageflow/internal/FlowControllerAction.java Tue Dec 20 09:22:38 2005
@@ -26,6 +26,9 @@
 import javax.servlet.http.HttpServletRequest;
 import javax.servlet.http.HttpServletResponse;
 
+/**
+ * Simple Struts action that delegates to a page flow controller.
+ */
 public class FlowControllerAction
         extends Action
 {

Modified: beehive/trunk/netui/src/pageflow/org/apache/beehive/netui/pageflow/internal/PageFlowRequestWrapper.java
URL: http://svn.apache.org/viewcvs/beehive/trunk/netui/src/pageflow/org/apache/beehive/netui/pageflow/internal/PageFlowRequestWrapper.java?rev=358045&r1=358044&r2=358045&view=diff
==============================================================================
--- beehive/trunk/netui/src/pageflow/org/apache/beehive/netui/pageflow/internal/PageFlowRequestWrapper.java (original)
+++ beehive/trunk/netui/src/pageflow/org/apache/beehive/netui/pageflow/internal/PageFlowRequestWrapper.java Tue Dec 20 09:22:38 2005
@@ -26,6 +26,10 @@
 import javax.servlet.ServletRequest;
 import javax.servlet.ServletRequestWrapper;
 
+/**
+ * Request wrapper that contains request-scoped values that our runtime uses.  This is faster than sticking everything
+ * into attributes on the request.
+ */
 public final class PageFlowRequestWrapper
         extends HttpServletRequestWrapper
 {