This is an automated email from the ASF dual-hosted git repository.
git-site-role pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/struts-site.git
commit cfc58ece6e8aeaad59e18d312834c916bd01411c
Author: jenkins <bui...@apache.org>
AuthorDate: Sat Sep 23 06:54:58 2017 +0000
Updates production by Jenkins
---
content/core-developers/chain-result.html | 57 ++++++++++++++++------
content/core-developers/dispatcher-result.html | 47 +++++++++++++------
content/core-developers/freemarker-result.html | 65 ++++++--------------------
content/core-developers/httpheader-result.html | 49 +++++++++++++------
content/core-developers/result-types.html | 2 +-
5 files changed, 126 insertions(+), 94 deletions(-)
diff --git a/content/core-developers/chain-result.html
b/content/core-developers/chain-result.html
index 41a7d67..0313204 100644
--- a/content/core-developers/chain-result.html
+++ b/content/core-developers/chain-result.html
@@ -129,23 +129,50 @@
<a class="edit-on-gh"
href="https://github.com/apache/struts-site/edit/master/source/core-developers/chain-result.md";
title="Edit this page on GitHub">Edit on GitHub</a>
<h1 id="chain-result">Chain Result</h1>
-<div class="highlighter-rouge"><pre class="highlight"><code><span
class="p">{</span><span
class="err">snippet:id=description|javadoc=true|url=com.opensymphony.xwork2.ActionChainResult</span><span
class="p">}</span><span class="w">
-</span></code></pre>
+<p>This result invokes an entire other action, complete with it’s own
interceptor stack and result.</p>
+
+<h3 id="parameters">Parameters</h3>
+
+<ul>
+ <li>
+ <p><code class="highlighter-rouge">actionName</code> (default) - the name
of the action that will be chained to.</p>
+ </li>
+ <li>
+ <p><code class="highlighter-rouge">namespace</code> - used to determine
which namespace the Action is in that we’re chaining. If namespace is null,
this defaults to the current namespace.</p>
+ </li>
+ <li>
+ <p><code class="highlighter-rouge">method</code> - used to specify another
method on target action to be invoked. If null, this defaults to execute
method.</p>
+ </li>
+ <li>
+ <p><code class="highlighter-rouge">skipActions</code> - (optional) the
list of comma separated action names for the actions that could be chained
to.</p>
+ </li>
+</ul>
+
+<h3 id="examples">Examples</h3>
+
+<div class="highlighter-rouge"><pre class="highlight"><code><package
name="public" extends="struts-default">
+ <!-- Chain creatAccount to login, using the default parameter -->
+ <action name="createAccount" class="...">
+ <result type="chain">login</result>
+ </action>
+
+ <action name="login" class="...">
+ <!-- Chain to another namespace -->
+ <result type="chain">
+ <param name="actionName">dashboard</param>
+ <param name="namespace">/secure</param>
+ </result>
+ </action>
+</package>
+
+<package name="secure" extends="struts-default" namespace="/secure">
+ <action name="dashboard" class="...">
+ <result>dashboard.jsp</result>
+ </action>
+</package>
+</code></pre>
</div>
-<p>####Parameters####</p>
-
-<div class="highlighter-rouge"><pre class="highlight"><code><span
class="p">{</span><span
class="err">snippet:id=params|javadoc=true|url=com.opensymphony.xwork2.ActionChainResult</span><span
class="p">}</span><span class="w">
-</span></code></pre>
-</div>
-
-<p>####Examples####</p>
-
-<div class="highlighter-rouge"><pre class="highlight"><code><span
class="p">{</span><span
class="err">snippet:id=example|lang=xml|javadoc=true|url=com.opensymphony.xwork2.ActionChainResult</span><span
class="p">}</span><span class="w">
-</span></code></pre>
-</div>
-
-
</section>
</article>
diff --git a/content/core-developers/dispatcher-result.html
b/content/core-developers/dispatcher-result.html
index 4062faa..1578cce 100644
--- a/content/core-developers/dispatcher-result.html
+++ b/content/core-developers/dispatcher-result.html
@@ -129,20 +129,39 @@
<a class="edit-on-gh"
href="https://github.com/apache/struts-site/edit/master/source/core-developers/dispatcher-result.md";
title="Edit this page on GitHub">Edit on GitHub</a>
<h1 id="dispatcher-result">Dispatcher Result</h1>
-<div class="highlighter-rouge"><pre class="highlight"><code><span
class="p">{</span><span
class="err">snippet:id=description|javadoc=true|url=org.apache.struts2.result.ServletDispatcherResult</span><span
class="p">}</span><span class="w">
-</span></code></pre>
-</div>
-
-<p>#####Parameters#####</p>
-
-<div class="highlighter-rouge"><pre class="highlight"><code><span
class="p">{</span><span
class="err">snippet:id=params|javadoc=true|url=org.apache.struts2.result.ServletDispatcherResult</span><span
class="p">}</span><span class="w">
-</span></code></pre>
-</div>
-
-<p>#####Examples#####</p>
-
-<div class="highlighter-rouge"><pre class="highlight"><code><span
class="p">{</span><span
class="err">snippet:id=example|lang=xml|javadoc=true|url=org.apache.struts2.result.ServletDispatcherResult</span><span
class="p">}</span><span class="w">
-</span></code></pre>
+<p>Includes or forwards to a view (usually a jsp). Behind the scenes Struts
will use a <code class="highlighter-rouge">RequestDispatcher</code>, where the
target servlet/JSP receives the same request/response objects as the original
servlet/JSP. Therefore, you can pass data between them using <code
class="highlighter-rouge">request.setAttribute()</code> - the Struts action is
available.</p>
+
+<p>There are three possible ways the result can be executed:</p>
+
+<ul>
+ <li>
+ <p>If we are in the scope of a JSP (a PageContext is available),
PageContext’s <code class="highlighter-rouge"><span class="p">{</span><span
class="err">@link</span><span class="w"> </span><span
class="err">PageContext#include(String)</span><span class="w"> </span><span
class="err">include</span><span class="p">}</span></code> method is called.</p>
+ </li>
+ <li>
+ <p>If there is no PageContext and we’re not in any sort of include (there
is no “javax.servlet.include.servlet_path” in the request attributes), then a
call to <code class="highlighter-rouge"><span class="p">{</span><span
class="err">@link</span><span class="w"> </span><span
class="err">RequestDispatcher#forward(javax.servlet.ServletRequest,</span><span
class="w"> </span><span class="err">javax.servlet.ServletResponse)</span><span
class="w"> </span><span class="err">forward</span><sp [...]
+ </li>
+ <li>
+ <p>Otherwise, <code class="highlighter-rouge"><span
class="p">{</span><span class="err">@link</span><span class="w"> </span><span
class="err">RequestDispatcher#include(javax.servlet.ServletRequest,</span><span
class="w"> </span><span class="err">javax.servlet.ServletResponse)</span><span
class="w"> </span><span class="err">include</span><span
class="p">}</span></code> is called.</p>
+ </li>
+</ul>
+
+<h4 id="parameters">Parameters</h4>
+
+<ul>
+ <li>
+ <p><code class="highlighter-rouge">location</code> (default) - the
location to go to after execution (ex. jsp).</p>
+ </li>
+ <li>
+ <p><code class="highlighter-rouge">parse</code> - true by default. If set
to false, the location param will not be parsed for OGNL expressions.</p>
+ </li>
+</ul>
+
+<h4 id="examples">Examples</h4>
+
+<div class="highlighter-rouge"><pre class="highlight"><code><result
name="success" type="dispatcher">
+ <param name="location">foo.jsp</param>
+</result>
+</code></pre>
</div>
</section>
diff --git a/content/core-developers/freemarker-result.html
b/content/core-developers/freemarker-result.html
index 0f8f3e2..563cc56 100644
--- a/content/core-developers/freemarker-result.html
+++ b/content/core-developers/freemarker-result.html
@@ -129,72 +129,37 @@
<a class="edit-on-gh"
href="https://github.com/apache/struts-site/edit/master/source/core-developers/freemarker-result.md";
title="Edit this page on GitHub">Edit on GitHub</a>
<h1 id="freemarker-result">FreeMarker Result</h1>
-<p>Renders a view using the Freemarker template engine. The</p>
-
-<div class="highlighter-rouge"><pre class="highlight"><code>FreemarkarManager
-</code></pre>
-</div>
-<p> class configures the template loaders so that the template location can be
either</p>
-
-<ul>
- <li>relative to the web root folder, e.g.: </li>
-</ul>
-
-<div class="highlighter-rouge"><pre
class="highlight"><code>/WEB-INF/views/home.ftl
-</code></pre>
-</div>
+<p>Renders a view using the Freemarker template engine. The <code
class="highlighter-rouge">FreemarkarManager</code> class configures the
template loaders so that the template location can be either</p>
<ul>
- <li>a classpath resource, e.g.:</li>
+ <li>
+ <p>relative to the web root folder, e.g.: <code
class="highlighter-rouge">/WEB-INF/views/home.ftl</code></p>
+ </li>
+ <li>
+ <p>a classpath resource, e.g.: <code
class="highlighter-rouge">/com/company/web/views/home.ftl</code></p>
+ </li>
</ul>
-<div class="highlighter-rouge"><pre
class="highlight"><code>/com/company/web/views/home.ftl
-</code></pre>
-</div>
-
-<p> </p>
-
<p>Also see <a href="freemarker-support.html">Freemarker Support</a>.</p>
-<p>#####Parameters#####</p>
+<h4 id="parameters">Parameters</h4>
<ul>
<li>
- <p><strong>location</strong> (default) - the location of the template to
process.</p>
+ <p><code class="highlighter-rouge">location</code> (default) - the
location of the template to process.</p>
</li>
<li>
- <p><strong>parse </strong>- true by default. If set to false, the location
param will not be parsed for expressions.</p>
+ <p><code class="highlighter-rouge">parse</code>- true by default. If set
to false, the location param will not be parsed for expressions.</p>
</li>
<li>
- <p><strong>contentType</strong> - defaults to</p>
+ <p><code class="highlighter-rouge">contentType</code> - defaults to <code
class="highlighter-rouge">text/html</code> unless specified.</p>
+ </li>
+ <li>
+ <p><code class="highlighter-rouge">writeIfCompleted</code> - <code
class="highlighter-rouge">false</code> by default, write to stream only if
there isn’t any error processing the template. Setting <code
class="highlighter-rouge">template_exception_handler=rethrow</code> in <code
class="highlighter-rouge">freemarker.properties</code> will have the same
effect.</p>
</li>
</ul>
-<div class="highlighter-rouge"><pre class="highlight"><code>text/html
-</code></pre>
-</div>
-<p> unless specified.</p>
-
-<ul>
- <li><strong>writeIfCompleted</strong> -</li>
-</ul>
-
-<div class="highlighter-rouge"><pre class="highlight"><code>false
-</code></pre>
-</div>
-<p> by default, write to stream only if there isn’t any error processing the
template. Setting</p>
-
-<div class="highlighter-rouge"><pre
class="highlight"><code>template_exception_handler=rethrow
-</code></pre>
-</div>
-<p> in</p>
-
-<div class="highlighter-rouge"><pre
class="highlight"><code>freemarker.properties
-</code></pre>
-</div>
-<p> will have the same effect.</p>
-
-<p>#####Examples#####</p>
+<h4 id="examples">Examples</h4>
<div class="highlighter-rouge"><pre class="highlight"><code><result
name="success" type="freemarker">foo.ftl</result>
</code></pre>
diff --git a/content/core-developers/httpheader-result.html
b/content/core-developers/httpheader-result.html
index 0a4133c..efdae21 100644
--- a/content/core-developers/httpheader-result.html
+++ b/content/core-developers/httpheader-result.html
@@ -129,20 +129,41 @@
<a class="edit-on-gh"
href="https://github.com/apache/struts-site/edit/master/source/core-developers/httpheader-result.md";
title="Edit this page on GitHub">Edit on GitHub</a>
<h1 id="httpheader-result">HttpHeader Result</h1>
-<div class="highlighter-rouge"><pre class="highlight"><code><span
class="p">{</span><span
class="err">snippet:id=description|javadoc=true|url=org.apache.struts2.result.HttpHeaderResult</span><span
class="p">}</span><span class="w">
-</span></code></pre>
-</div>
-
-<p>####Parameters####</p>
-
-<div class="highlighter-rouge"><pre class="highlight"><code><span
class="p">{</span><span
class="err">snippet:id=params|javadoc=true|url=org.apache.struts2.result.HttpHeaderResult</span><span
class="p">}</span><span class="w">
-</span></code></pre>
-</div>
-
-<p>####Examples####</p>
-
-<div class="highlighter-rouge"><pre class="highlight"><code><span
class="p">{</span><span
class="err">snippet:id=example|lang=xml|javadoc=true|url=org.apache.struts2.result.HttpHeaderResult</span><span
class="p">}</span><span class="w">
-</span></code></pre>
+<p>A custom Result type for setting HTTP headers and status by optionally
evaluating against the ValueStack. This result can also be used to send an
error to the client. All the parameters can be evaluated against the
ValueStack.</p>
+
+<h3 id="parameters">Parameters</h3>
+
+<ul>
+ <li>
+ <p><code class="highlighter-rouge">status</code> - the http servlet
response status code that should be set on a response.</p>
+ </li>
+ <li>
+ <p><code class="highlighter-rouge">parse</code> - true by default. If set
to false, the headers param will not be parsed for Ognl expressions.</p>
+ </li>
+ <li>
+ <p><code class="highlighter-rouge">headers</code> - header values.</p>
+ </li>
+ <li>
+ <p><code class="highlighter-rouge">error</code> - the http servlet
response error code that should be set on a response.</p>
+ </li>
+ <li>
+ <p><code class="highlighter-rouge">errorMessage</code> - error message to
be set on response if ‘error’ is set.</p>
+ </li>
+</ul>
+
+<h3 id="examples">Examples</h3>
+
+<div class="highlighter-rouge"><pre class="highlight"><code><result
name="success" type="httpheader">
+ <param name="status">204</param>
+ <param name="headers.a">a custom header value</param>
+ <param name="headers.b">another custom header value</param>
+</result>
+
+<result name="proxyRequired" type="httpheader">
+ <param name="error">305</param>
+ <param name="errorMessage">this action must be accessed through a
proxy</param>
+</result>
+</code></pre>
</div>
</section>
diff --git a/content/core-developers/result-types.html
b/content/core-developers/result-types.html
index a1d9819..6e28c5f 100644
--- a/content/core-developers/result-types.html
+++ b/content/core-developers/result-types.html
@@ -145,7 +145,7 @@ own applications.</p>
<td>Used for <a href="action-chaining.html">Action Chaining</a></td>
</tr>
<tr>
- <td><a href="dispatcher-reult.html">Dispatcher Result</a></td>
+ <td><a href="dispatcher-result.html">Dispatcher Result</a></td>
<td>Used for web resource integration, including <em>JSP</em>
integration</td>
</tr>
<tr>
--
To stop receiving notification emails like this one, please contact
"commits@struts.apache.org" <commits@struts.apache.org>.
