svn commit: r424149 - in /tapestry/tapestry4/trunk/tapestry-framework/src: descriptor/META-INF/ java/org/apache/tapestry/services/ java/org/apache/tapestry/services/impl/

[jk...@apache.org]

Author: jkuhnert
Date: Thu Jul 20 17:37:58 2006
New Revision: 424149

URL: http://svn.apache.org/viewvc?rev=424149&view=rev
Log:
Documentation fixes for new ResponseBuilder interfaces/impls

Modified:
    tapestry/tapestry4/trunk/tapestry-framework/src/descriptor/META-INF/tapestry.services.xml
    tapestry/tapestry4/trunk/tapestry-framework/src/java/org/apache/tapestry/services/ResponseBuilder.java
    tapestry/tapestry4/trunk/tapestry-framework/src/java/org/apache/tapestry/services/impl/DefaultResponseBuilder.java
    tapestry/tapestry4/trunk/tapestry-framework/src/java/org/apache/tapestry/services/impl/DefaultResponseContributorImpl.java
    tapestry/tapestry4/trunk/tapestry-framework/src/java/org/apache/tapestry/services/impl/DojoAjaxResponseBuilder.java

Modified: tapestry/tapestry4/trunk/tapestry-framework/src/descriptor/META-INF/tapestry.services.xml
URL: http://svn.apache.org/viewvc/tapestry/tapestry4/trunk/tapestry-framework/src/descriptor/META-INF/tapestry.services.xml?rev=424149&r1=424148&r2=424149&view=diff
==============================================================================
--- tapestry/tapestry4/trunk/tapestry-framework/src/descriptor/META-INF/tapestry.services.xml (original)
+++ tapestry/tapestry4/trunk/tapestry-framework/src/descriptor/META-INF/tapestry.services.xml Thu Jul 20 17:37:58 2006
@@ -243,7 +243,8 @@
     
     <service-point id="DefaultResponseContributor" interface="org.apache.tapestry.services.ResponseContributor">
         Defines the factory service that is responsible for determining if a particular request is
-        one that should recieve a JSON response.
+        one that should recieve a normal Html response. This will probably be the one chosen in
+        the majority of cases.
         <invoke-factory>
             <construct class="org.apache.tapestry.services.impl.DefaultResponseContributorImpl" >
                 <set-service property="localeManager" service-id="tapestry.request.RequestLocaleManager"/>

Modified: tapestry/tapestry4/trunk/tapestry-framework/src/java/org/apache/tapestry/services/ResponseBuilder.java
URL: http://svn.apache.org/viewvc/tapestry/tapestry4/trunk/tapestry-framework/src/java/org/apache/tapestry/services/ResponseBuilder.java?rev=424149&r1=424148&r2=424149&view=diff
==============================================================================
--- tapestry/tapestry4/trunk/tapestry-framework/src/java/org/apache/tapestry/services/ResponseBuilder.java (original)
+++ tapestry/tapestry4/trunk/tapestry-framework/src/java/org/apache/tapestry/services/ResponseBuilder.java Thu Jul 20 17:37:58 2006
@@ -22,8 +22,29 @@
 
 
 /**
- * Represents the class responsible for interacting
- * with components for an ajax request library version and type.
+ * Represents the service responsible for managing all content output that is sent
+ * to the client. In the case of normal http responses this management would inlude 
+ * handing out {@link IMarkupWriter} instances to render components with, as well as 
+ * managing any javascript written to the output using Script templates.
+ *
+ * <p>
+ *  This is a major internal change in terms of the way tapestry renders pages/components.
+ *  Traditionally a response has been rendered via:
+ *  <em>
+ *  IPage.render(writer, cycle);
+ *  </em>
+ *  The logic has now changed somewhat, while the IPage.render(writer, cycle) does still happen, this
+ *  service is the primary invoker of all renders, even nested component bodies. That means that in the majority
+ *  of cases the ResponseBuilder service is used to invoke IComponent.render() throught the entire render
+ *  cycle, creating a great deal of flexibility in terms of what can be done to control the output of a given
+ *  response.
+ * </p>
+ *
+ * <p>
+ * This service was primarily created to help bolster support for more dynamic content responses, such 
+ * as XHR/JSON/etc - where controlling individual component output (and javascript) becomes very important
+ * when managaing client side browser state. 
+ * </p>
  *
  * @author jkuhnert
  * @since 4.1

Modified: tapestry/tapestry4/trunk/tapestry-framework/src/java/org/apache/tapestry/services/impl/DefaultResponseBuilder.java
URL: http://svn.apache.org/viewvc/tapestry/tapestry4/trunk/tapestry-framework/src/java/org/apache/tapestry/services/impl/DefaultResponseBuilder.java?rev=424149&r1=424148&r2=424149&view=diff
==============================================================================
--- tapestry/tapestry4/trunk/tapestry-framework/src/java/org/apache/tapestry/services/impl/DefaultResponseBuilder.java (original)
+++ tapestry/tapestry4/trunk/tapestry-framework/src/java/org/apache/tapestry/services/impl/DefaultResponseBuilder.java Thu Jul 20 17:37:58 2006
@@ -30,9 +30,8 @@
 
 
 /**
- * Class that implements JSON responses in tapestry.
+ * Manages normal html responses for tapestry request/response cycles.
  * 
- * @see <a href="http://json.org">json.org</a>
  * @author jkuhnert
  */
 public class DefaultResponseBuilder implements ResponseBuilder

Modified: tapestry/tapestry4/trunk/tapestry-framework/src/java/org/apache/tapestry/services/impl/DefaultResponseContributorImpl.java
URL: http://svn.apache.org/viewvc/tapestry/tapestry4/trunk/tapestry-framework/src/java/org/apache/tapestry/services/impl/DefaultResponseContributorImpl.java?rev=424149&r1=424148&r2=424149&view=diff
==============================================================================
--- tapestry/tapestry4/trunk/tapestry-framework/src/java/org/apache/tapestry/services/impl/DefaultResponseContributorImpl.java (original)
+++ tapestry/tapestry4/trunk/tapestry-framework/src/java/org/apache/tapestry/services/impl/DefaultResponseContributorImpl.java Thu Jul 20 17:37:58 2006
@@ -23,8 +23,10 @@
 import org.apache.tapestry.web.WebResponse;
 
 /**
- * Determines if incoming request is a valid dojo request via the javascript
- * added parameter of "dojoRequest" = "true".
+ * Factory that is used if no other has been chosen, handles normal html
+ * responses.
+ * 
+ * TODO: Should probably implement this as a hivemind pipeline.
  * 
  * @author jkuhnert
  */

Modified: tapestry/tapestry4/trunk/tapestry-framework/src/java/org/apache/tapestry/services/impl/DojoAjaxResponseBuilder.java
URL: http://svn.apache.org/viewvc/tapestry/tapestry4/trunk/tapestry-framework/src/java/org/apache/tapestry/services/impl/DojoAjaxResponseBuilder.java?rev=424149&r1=424148&r2=424149&view=diff
==============================================================================
--- tapestry/tapestry4/trunk/tapestry-framework/src/java/org/apache/tapestry/services/impl/DojoAjaxResponseBuilder.java (original)
+++ tapestry/tapestry4/trunk/tapestry-framework/src/java/org/apache/tapestry/services/impl/DojoAjaxResponseBuilder.java Thu Jul 20 17:37:58 2006
@@ -41,7 +41,10 @@
 
 
 /**
- * Main class that handles dojo based ajax responses.
+ * Main class that handles dojo based ajax responses. These responses are wrapped
+ * by an xml document format that segments off invididual component/javascript response
+ * types into easy to manage xml elements that can then be interpreted and managed by 
+ * running client-side javascript.
  * 
  * @author jkuhnert
  */