svn commit: r1801827 - /turbine/core/trunk/src/java/org/apache/turbine/modules/layouts/VelocityCachedLayout.java

[gk...@apache.org]

Author: gk
Date: Thu Jul 13 10:56:47 2017
New Revision: 1801827

URL: http://svn.apache.org/viewvc?rev=1801827&view=rev
Log:
- explain more concisely behaviour of VelocityCachedLayout

Modified:
    turbine/core/trunk/src/java/org/apache/turbine/modules/layouts/VelocityCachedLayout.java

Modified: turbine/core/trunk/src/java/org/apache/turbine/modules/layouts/VelocityCachedLayout.java
URL: http://svn.apache.org/viewvc/turbine/core/trunk/src/java/org/apache/turbine/modules/layouts/VelocityCachedLayout.java?rev=1801827&r1=1801826&r2=1801827&view=diff
==============================================================================
--- turbine/core/trunk/src/java/org/apache/turbine/modules/layouts/VelocityCachedLayout.java (original)
+++ turbine/core/trunk/src/java/org/apache/turbine/modules/layouts/VelocityCachedLayout.java Thu Jul 13 10:56:47 2017
@@ -24,6 +24,7 @@ import org.apache.commons.logging.LogFac
 import org.apache.turbine.TurbineConstants;
 import org.apache.turbine.annotation.TurbineService;
 import org.apache.turbine.modules.Layout;
+import org.apache.turbine.modules.pages.DefaultPage;
 import org.apache.turbine.pipeline.PipelineData;
 import org.apache.turbine.services.velocity.VelocityService;
 import org.apache.turbine.util.RunData;
@@ -34,6 +35,11 @@ import org.apache.velocity.context.Conte
 /**
  * This Layout module is Turbine 2.3.3 VelocityDirectLayout (same package)
  * with methods added for {@link PipelineData}. It is used in Jetspeed-1 portal.
+ * 
+ * By using this layout any view write will immediately call the provided print writer {@link RunData#getOut()} and 
+ * the HTTP servlet response will be flushed and set the committed flag. This means of course
+ * no change to the HTTP response header will be possible afterwards. By setting the {@link RunData#setAction(String)} in the request 
+ * (not only the model, but also) additional response headers could be set, cft. {@link DefaultPage#doBuild(PipelineData)}.
  *
  * @author <a href="mailto:raphael@apache.org">Raphaël Luta</a>
  * @author <a href="mailto:john.mcnally@clearink.com">John D. McNally</a>