Added: websites/production/struts/content/core-developers/fieldexpression-validator.html ============================================================================== --- websites/production/struts/content/core-developers/fieldexpression-validator.html (added) +++ websites/production/struts/content/core-developers/fieldexpression-validator.html Thu Jun 1 11:35:58 2017 @@ -0,0 +1,200 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="UTF-8"/> + <meta name="viewport" content="width=device-width, initial-scale=1.0"/> + <meta name="Date-Revision-yyyymmdd" content="20140918"/> + <meta http-equiv="Content-Language" content="en"/> + <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> + + <title>fieldexpression validator</title> + + <link href="//fonts.googleapis.com/css?family=Source+Sans+Pro:300,400,600,700,400italic,600italic,700italic" rel="stylesheet" type="text/css"> + <link href="//netdna.bootstrapcdn.com/font-awesome/4.0.3/css/font-awesome.css" rel="stylesheet"> + <link href="/css/main.css" rel="stylesheet"> + <link href="/css/custom.css" rel="stylesheet"> + <link href="/highlighter/github-theme.css" rel="stylesheet"> + + <script src="//ajax.googleapis.com/ajax/libs/jquery/1.11.0/jquery.min.js"></script> + <script type="text/javascript" src="/bootstrap/js/bootstrap.js"></script> + <script type="text/javascript" src="/js/community.js"></script> +</head> +<body> + +<a href="http://github.com/apache/struts"; class="github-ribbon"> + <img style="position: absolute; right: 0; border: 0;" src="https://s3.amazonaws.com/github/ribbons/forkme_right_red_aa0000.png"; alt="Fork me on GitHub"> +</a> + +<header> + <nav> + <div role="navigation" class="navbar navbar-default navbar-fixed-top"> + <div class="container"> + <div class="navbar-header"> + <button type="button" data-toggle="collapse" data-target="#struts-menu" class="navbar-toggle"> + Menu + <span class="sr-only">Toggle navigation</span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + </button> + <a href="/index.html" class="navbar-brand logo"><img src="/img/struts-logo.svg"></a> + </div> + <div id="struts-menu" class="navbar-collapse collapse"> + <ul class="nav navbar-nav"> + <li class="dropdown"> + <a data-toggle="dropdown" href="#" class="dropdown-toggle"> + Home<b class="caret"></b> + </a> + <ul class="dropdown-menu"> + <li><a href="/index.html">Welcome</a></li> + <li><a href="/downloads.html">Downloads</a></li> + <li><a href="/announce.html">Announcements</a></li> + <li><a href="http://www.apache.org/licenses/";>License</a></li> + <li><a href="http://apache.org/foundation/thanks.html";>Thanks!</a></li> + <li><a href="http://apache.org/foundation/sponsorship.html";>Sponsorship</a></li> + </ul> + </li> + <li class="dropdown"> + <a data-toggle="dropdown" href="#" class="dropdown-toggle"> + Support<b class="caret"></b> + </a> + <ul class="dropdown-menu"> + <li><a href="/mail.html">User Mailing List</a></li> + <li><a href="https://issues.apache.org/jira/browse/WW";>Issue Tracker</a></li> + <li><a href="/security.html">Reporting Security Issues</a></li> + <li class="divider"></li> + <li><a href="/maven/project-info.html">Project info</a></li> + <li><a href="/maven/struts2-core/dependencies.html">Struts Core dependencies</a></li> + <li><a href="/maven/struts2-plugins/modules.html">Plugin dependencies</a></li> + </ul> + </li> + <li class="dropdown"> + <a data-toggle="dropdown" href="#" class="dropdown-toggle"> + Documentation<b class="caret"></b> + </a> + <ul class="dropdown-menu"> + <li><a href="/birdseye.html">Birds Eye</a></li> + <li><a href="/primer.html">Key Technologies</a></li> + <li><a href="/kickstart.html">Kickstart FAQ</a></li> + <li><a href="https://cwiki.apache.org/confluence/display/WW/Home";>Wiki</a></li> + <li class="divider"></li> + <li><a href="/getting-started/">Getting Started</a></li> + <li><a href="/docs/tutorials.html">Tutorials</a></li> + <li><a href="/docs/faqs.html">FAQs</a></li> + <li><a href="/docs/guides.html">Guides</a></li> + <li class="divider"></li> + <li><a href="/maven/struts2-core/apidocs/index.html">Struts Core API</a></li> + <li><a href="/docs/plugins.html">Plugin APIs</a></li> + <li><a href="/docs/tag-reference.html">Tag reference</a></li> + <li><a href="http://cwiki.apache.org/S2PLUGINS/home.html";>Plugin registry</a></li> + <li class="divider"></li> + <li><a href="/security/">Security Guide (WIP)</a></li> + <li><a href="/core-developers/">Core Developers Guide (WIP)</a></li> + </ul> + </li> + <li class="dropdown"> + <a data-toggle="dropdown" href="#" class="dropdown-toggle"> + Contributing<b class="caret"></b> + </a> + <ul class="dropdown-menu"> + <li><a href="/youatstruts.html">You at Struts</a></li> + <li><a href="/helping.html">How to Help FAQ</a></li> + <li><a href="/dev-mail.html">Development Lists</a></li> + <li class="divider"></li> + <li><a href="/submitting-patches.html">Submitting patches</a></li> + <li><a href="/builds.html">Source Code</a></li> + <li><a href="/coding-standards.html">Coding standards</a></li> + <li class="divider"></li> + <li><a href="/releases.html">Release Guidelines</a></li> + <li><a href="/bylaws.html">PMC Charter</a></li> + <li><a href="/volunteers.html">Volunteers</a></li> + <li><a href="https://git-wip-us.apache.org/repos/asf?p=struts.git";>Source Repository</a></li> + </ul> + </li> + <li class="apache"><a href="http://www.apache.org/";><img src="/img/apache.png"></a></li> + </ul> + </div> + </div> + </div> + </nav> +</header> + + +<article class="container"> + <section class="col-md-12"> + <a href="index.html" title="back to Core Developers Guide"><< back to Core Developers Guide</a> + <h1 id="fieldexpression-validator">fieldexpression validator</h1> + +<p>####Description####</p> + +<div class="highlighter-rouge"><pre class="highlight"><code><span class="p">{</span><span class="err">snippet:id=javadoc|javadoc=true|url=com.opensymphony.xwork2.validator.validators.FieldExpressionValidator</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=parameters|javadoc=true|url=com.opensymphony.xwork2.validator.validators.FieldExpressionValidator</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|javadoc=true|lang=xml|url=com.opensymphony.xwork2.validator.validators.FieldExpressionValidator</span><span class="p">}</span><span class="w"> +</span></code></pre> +</div> + + </section> +</article> + + +<footer class="container"> + <div class="col-md-12"> + Copyright © 2000-2016 <a href="http://www.apache.org/";>The Apache Software Foundation </a>. + All Rights Reserved. + </div> + <div class="col-md-12"> + Apache Struts, Struts, Apache, the Apache feather logo, and the Apache Struts project logos are + trademarks of The Apache Software Foundation. + </div> + <div class="col-md-12">Logo and website design donated by <a href="https://softwaremill.com/";>SoftwareMill</a>.</div> +</footer> + +<script>!function (d, s, id) { + var js, fjs = d.getElementsByTagName(s)[0]; + if (!d.getElementById(id)) { + js = d.createElement(s); + js.id = id; + js.src = "//platform.twitter.com/widgets.js"; + fjs.parentNode.insertBefore(js, fjs); + } +}(document, "script", "twitter-wjs");</script> +<script src="https://apis.google.com/js/platform.js"; async="async" defer="defer"></script> + +<div id="fb-root"></div> + +<script>(function (d, s, id) { + var js, fjs = d.getElementsByTagName(s)[0]; + if (d.getElementById(id)) return; + js = d.createElement(s); + js.id = id; + js.src = "//connect.facebook.net/en_GB/all.js#xfbml=1"; + fjs.parentNode.insertBefore(js, fjs); +}(document, 'script', 'facebook-jssdk'));</script> + + +<script> +$(function() { + return $("h2, h3, h4, h5, h6").each(function(i, el) { + var $el, id; + $el = $(el); + id = $el.attr('id'); + if (id) { + $el.removeAttr('id'); + return $el.before($("<a />").addClass('anchor').attr('name', id)); + } + }); +}); +</script> + +</body> +</html>
Added: websites/production/struts/content/core-developers/file-upload-interceptor.html ============================================================================== --- websites/production/struts/content/core-developers/file-upload-interceptor.html (added) +++ websites/production/struts/content/core-developers/file-upload-interceptor.html Thu Jun 1 11:35:58 2017 @@ -0,0 +1,252 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="UTF-8"/> + <meta name="viewport" content="width=device-width, initial-scale=1.0"/> + <meta name="Date-Revision-yyyymmdd" content="20140918"/> + <meta http-equiv="Content-Language" content="en"/> + <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> + + <title>File Upload Interceptor</title> + + <link href="//fonts.googleapis.com/css?family=Source+Sans+Pro:300,400,600,700,400italic,600italic,700italic" rel="stylesheet" type="text/css"> + <link href="//netdna.bootstrapcdn.com/font-awesome/4.0.3/css/font-awesome.css" rel="stylesheet"> + <link href="/css/main.css" rel="stylesheet"> + <link href="/css/custom.css" rel="stylesheet"> + <link href="/highlighter/github-theme.css" rel="stylesheet"> + + <script src="//ajax.googleapis.com/ajax/libs/jquery/1.11.0/jquery.min.js"></script> + <script type="text/javascript" src="/bootstrap/js/bootstrap.js"></script> + <script type="text/javascript" src="/js/community.js"></script> +</head> +<body> + +<a href="http://github.com/apache/struts"; class="github-ribbon"> + <img style="position: absolute; right: 0; border: 0;" src="https://s3.amazonaws.com/github/ribbons/forkme_right_red_aa0000.png"; alt="Fork me on GitHub"> +</a> + +<header> + <nav> + <div role="navigation" class="navbar navbar-default navbar-fixed-top"> + <div class="container"> + <div class="navbar-header"> + <button type="button" data-toggle="collapse" data-target="#struts-menu" class="navbar-toggle"> + Menu + <span class="sr-only">Toggle navigation</span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + </button> + <a href="/index.html" class="navbar-brand logo"><img src="/img/struts-logo.svg"></a> + </div> + <div id="struts-menu" class="navbar-collapse collapse"> + <ul class="nav navbar-nav"> + <li class="dropdown"> + <a data-toggle="dropdown" href="#" class="dropdown-toggle"> + Home<b class="caret"></b> + </a> + <ul class="dropdown-menu"> + <li><a href="/index.html">Welcome</a></li> + <li><a href="/downloads.html">Downloads</a></li> + <li><a href="/announce.html">Announcements</a></li> + <li><a href="http://www.apache.org/licenses/";>License</a></li> + <li><a href="http://apache.org/foundation/thanks.html";>Thanks!</a></li> + <li><a href="http://apache.org/foundation/sponsorship.html";>Sponsorship</a></li> + </ul> + </li> + <li class="dropdown"> + <a data-toggle="dropdown" href="#" class="dropdown-toggle"> + Support<b class="caret"></b> + </a> + <ul class="dropdown-menu"> + <li><a href="/mail.html">User Mailing List</a></li> + <li><a href="https://issues.apache.org/jira/browse/WW";>Issue Tracker</a></li> + <li><a href="/security.html">Reporting Security Issues</a></li> + <li class="divider"></li> + <li><a href="/maven/project-info.html">Project info</a></li> + <li><a href="/maven/struts2-core/dependencies.html">Struts Core dependencies</a></li> + <li><a href="/maven/struts2-plugins/modules.html">Plugin dependencies</a></li> + </ul> + </li> + <li class="dropdown"> + <a data-toggle="dropdown" href="#" class="dropdown-toggle"> + Documentation<b class="caret"></b> + </a> + <ul class="dropdown-menu"> + <li><a href="/birdseye.html">Birds Eye</a></li> + <li><a href="/primer.html">Key Technologies</a></li> + <li><a href="/kickstart.html">Kickstart FAQ</a></li> + <li><a href="https://cwiki.apache.org/confluence/display/WW/Home";>Wiki</a></li> + <li class="divider"></li> + <li><a href="/getting-started/">Getting Started</a></li> + <li><a href="/docs/tutorials.html">Tutorials</a></li> + <li><a href="/docs/faqs.html">FAQs</a></li> + <li><a href="/docs/guides.html">Guides</a></li> + <li class="divider"></li> + <li><a href="/maven/struts2-core/apidocs/index.html">Struts Core API</a></li> + <li><a href="/docs/plugins.html">Plugin APIs</a></li> + <li><a href="/docs/tag-reference.html">Tag reference</a></li> + <li><a href="http://cwiki.apache.org/S2PLUGINS/home.html";>Plugin registry</a></li> + <li class="divider"></li> + <li><a href="/security/">Security Guide (WIP)</a></li> + <li><a href="/core-developers/">Core Developers Guide (WIP)</a></li> + </ul> + </li> + <li class="dropdown"> + <a data-toggle="dropdown" href="#" class="dropdown-toggle"> + Contributing<b class="caret"></b> + </a> + <ul class="dropdown-menu"> + <li><a href="/youatstruts.html">You at Struts</a></li> + <li><a href="/helping.html">How to Help FAQ</a></li> + <li><a href="/dev-mail.html">Development Lists</a></li> + <li class="divider"></li> + <li><a href="/submitting-patches.html">Submitting patches</a></li> + <li><a href="/builds.html">Source Code</a></li> + <li><a href="/coding-standards.html">Coding standards</a></li> + <li class="divider"></li> + <li><a href="/releases.html">Release Guidelines</a></li> + <li><a href="/bylaws.html">PMC Charter</a></li> + <li><a href="/volunteers.html">Volunteers</a></li> + <li><a href="https://git-wip-us.apache.org/repos/asf?p=struts.git";>Source Repository</a></li> + </ul> + </li> + <li class="apache"><a href="http://www.apache.org/";><img src="/img/apache.png"></a></li> + </ul> + </div> + </div> + </div> + </nav> +</header> + + +<article class="container"> + <section class="col-md-12"> + <a href="index.html" title="back to Core Developers Guide"><< back to Core Developers Guide</a> + <h1 id="file-upload-interceptor">File Upload Interceptor</h1> + +<p>See <a href="file-upload.html">this page</a> for more examples and advanced configuration</p> + +<table> + <tbody> + <tr> + </tr> + </tbody> +</table> + +<div class="highlighter-rouge"><pre class="highlight"><code><span class="p">{</span><span class="err">snippet:id=description|javadoc=true|url=org.apache.struts2.interceptor.FileUploadInterceptor</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=parameters|javadoc=true|url=org.apache.struts2.interceptor.FileUploadInterceptor</span><span class="p">}</span><span class="w"> +</span></code></pre> +</div> + +<p>#####Extending the Interceptor#####</p> + +<div class="highlighter-rouge"><pre class="highlight"><code><span class="p">{</span><span class="err">snippet:id=extending|javadoc=true|url=org.apache.struts2.interceptor.FileUploadInterceptor</span><span class="p">}</span><span class="w"> +</span></code></pre> +</div> + +<p>#####Examples#####</p> + +<p><strong>Example action mapping:</strong></p> + +<div class="highlighter-rouge"><pre class="highlight"><code><span class="p">{</span><span class="err">snippet:id=example-configuration|lang=xml|javadoc=true|url=org.apache.struts2.interceptor.FileUploadInterceptor</span><span class="p">}</span><span class="w"> +</span></code></pre> +</div> + +<p>Notice the interceptor configuration in the preceding example.</p> + +<p><strong>Example JSP form tags:</strong></p> + +<div class="highlighter-rouge"><pre class="highlight"><code><span class="p">{</span><span class="err">snippet:id=example-form|lang=xml|javadoc=true|url=org.apache.struts2.interceptor.FileUploadInterceptor</span><span class="p">}</span><span class="w"> +</span></code></pre> +</div> + +<div class="highlighter-rouge"><pre class="highlight"><code><span class="p">{</span><span class="err">snippet:id=multipart-note|javadoc=true|url=org.apache.struts2.interceptor.FileUploadInterceptor</span><span class="p">}</span><span class="w"> +</span></code></pre> +</div> + +<p><strong>Example Action class:</strong></p> + +<div class="highlighter-rouge"><pre class="highlight"><code><span class="p">{</span><span class="err">snippet:id=example-action|lang=java|javadoc=true|url=org.apache.struts2.interceptor.FileUploadInterceptor</span><span class="p">}</span><span class="w"> +</span></code></pre> +</div> + +<p><strong>Setting parameters example:</strong></p> + +<div class="highlighter-rouge"><pre class="highlight"><code> +<interceptor-ref name="fileUpload"> + <param name="allowedTypes"> + image/png,image/gif,image/jpeg + </param> +</interceptor-ref> + +</code></pre> +</div> + +<p>This part is optional and would be done in place of the</p> + +<div class="highlighter-rouge"><pre class="highlight"><code><interceptor-ref name="fileUpload"/> +</code></pre> +</div> +<p>line in the action mapping example above.</p> + + </section> +</article> + + +<footer class="container"> + <div class="col-md-12"> + Copyright © 2000-2016 <a href="http://www.apache.org/";>The Apache Software Foundation </a>. + All Rights Reserved. + </div> + <div class="col-md-12"> + Apache Struts, Struts, Apache, the Apache feather logo, and the Apache Struts project logos are + trademarks of The Apache Software Foundation. + </div> + <div class="col-md-12">Logo and website design donated by <a href="https://softwaremill.com/";>SoftwareMill</a>.</div> +</footer> + +<script>!function (d, s, id) { + var js, fjs = d.getElementsByTagName(s)[0]; + if (!d.getElementById(id)) { + js = d.createElement(s); + js.id = id; + js.src = "//platform.twitter.com/widgets.js"; + fjs.parentNode.insertBefore(js, fjs); + } +}(document, "script", "twitter-wjs");</script> +<script src="https://apis.google.com/js/platform.js"; async="async" defer="defer"></script> + +<div id="fb-root"></div> + +<script>(function (d, s, id) { + var js, fjs = d.getElementsByTagName(s)[0]; + if (d.getElementById(id)) return; + js = d.createElement(s); + js.id = id; + js.src = "//connect.facebook.net/en_GB/all.js#xfbml=1"; + fjs.parentNode.insertBefore(js, fjs); +}(document, 'script', 'facebook-jssdk'));</script> + + +<script> +$(function() { + return $("h2, h3, h4, h5, h6").each(function(i, el) { + var $el, id; + $el = $(el); + id = $el.attr('id'); + if (id) { + $el.removeAttr('id'); + return $el.before($("<a />").addClass('anchor').attr('name', id)); + } + }); +}); +</script> + +</body> +</html> Added: websites/production/struts/content/core-developers/file-upload.html ============================================================================== --- websites/production/struts/content/core-developers/file-upload.html (added) +++ websites/production/struts/content/core-developers/file-upload.html Thu Jun 1 11:35:58 2017 @@ -0,0 +1,773 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="UTF-8"/> + <meta name="viewport" content="width=device-width, initial-scale=1.0"/> + <meta name="Date-Revision-yyyymmdd" content="20140918"/> + <meta http-equiv="Content-Language" content="en"/> + <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> + + <title>File Upload</title> + + <link href="//fonts.googleapis.com/css?family=Source+Sans+Pro:300,400,600,700,400italic,600italic,700italic" rel="stylesheet" type="text/css"> + <link href="//netdna.bootstrapcdn.com/font-awesome/4.0.3/css/font-awesome.css" rel="stylesheet"> + <link href="/css/main.css" rel="stylesheet"> + <link href="/css/custom.css" rel="stylesheet"> + <link href="/highlighter/github-theme.css" rel="stylesheet"> + + <script src="//ajax.googleapis.com/ajax/libs/jquery/1.11.0/jquery.min.js"></script> + <script type="text/javascript" src="/bootstrap/js/bootstrap.js"></script> + <script type="text/javascript" src="/js/community.js"></script> +</head> +<body> + +<a href="http://github.com/apache/struts"; class="github-ribbon"> + <img style="position: absolute; right: 0; border: 0;" src="https://s3.amazonaws.com/github/ribbons/forkme_right_red_aa0000.png"; alt="Fork me on GitHub"> +</a> + +<header> + <nav> + <div role="navigation" class="navbar navbar-default navbar-fixed-top"> + <div class="container"> + <div class="navbar-header"> + <button type="button" data-toggle="collapse" data-target="#struts-menu" class="navbar-toggle"> + Menu + <span class="sr-only">Toggle navigation</span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + </button> + <a href="/index.html" class="navbar-brand logo"><img src="/img/struts-logo.svg"></a> + </div> + <div id="struts-menu" class="navbar-collapse collapse"> + <ul class="nav navbar-nav"> + <li class="dropdown"> + <a data-toggle="dropdown" href="#" class="dropdown-toggle"> + Home<b class="caret"></b> + </a> + <ul class="dropdown-menu"> + <li><a href="/index.html">Welcome</a></li> + <li><a href="/downloads.html">Downloads</a></li> + <li><a href="/announce.html">Announcements</a></li> + <li><a href="http://www.apache.org/licenses/";>License</a></li> + <li><a href="http://apache.org/foundation/thanks.html";>Thanks!</a></li> + <li><a href="http://apache.org/foundation/sponsorship.html";>Sponsorship</a></li> + </ul> + </li> + <li class="dropdown"> + <a data-toggle="dropdown" href="#" class="dropdown-toggle"> + Support<b class="caret"></b> + </a> + <ul class="dropdown-menu"> + <li><a href="/mail.html">User Mailing List</a></li> + <li><a href="https://issues.apache.org/jira/browse/WW";>Issue Tracker</a></li> + <li><a href="/security.html">Reporting Security Issues</a></li> + <li class="divider"></li> + <li><a href="/maven/project-info.html">Project info</a></li> + <li><a href="/maven/struts2-core/dependencies.html">Struts Core dependencies</a></li> + <li><a href="/maven/struts2-plugins/modules.html">Plugin dependencies</a></li> + </ul> + </li> + <li class="dropdown"> + <a data-toggle="dropdown" href="#" class="dropdown-toggle"> + Documentation<b class="caret"></b> + </a> + <ul class="dropdown-menu"> + <li><a href="/birdseye.html">Birds Eye</a></li> + <li><a href="/primer.html">Key Technologies</a></li> + <li><a href="/kickstart.html">Kickstart FAQ</a></li> + <li><a href="https://cwiki.apache.org/confluence/display/WW/Home";>Wiki</a></li> + <li class="divider"></li> + <li><a href="/getting-started/">Getting Started</a></li> + <li><a href="/docs/tutorials.html">Tutorials</a></li> + <li><a href="/docs/faqs.html">FAQs</a></li> + <li><a href="/docs/guides.html">Guides</a></li> + <li class="divider"></li> + <li><a href="/maven/struts2-core/apidocs/index.html">Struts Core API</a></li> + <li><a href="/docs/plugins.html">Plugin APIs</a></li> + <li><a href="/docs/tag-reference.html">Tag reference</a></li> + <li><a href="http://cwiki.apache.org/S2PLUGINS/home.html";>Plugin registry</a></li> + <li class="divider"></li> + <li><a href="/security/">Security Guide (WIP)</a></li> + <li><a href="/core-developers/">Core Developers Guide (WIP)</a></li> + </ul> + </li> + <li class="dropdown"> + <a data-toggle="dropdown" href="#" class="dropdown-toggle"> + Contributing<b class="caret"></b> + </a> + <ul class="dropdown-menu"> + <li><a href="/youatstruts.html">You at Struts</a></li> + <li><a href="/helping.html">How to Help FAQ</a></li> + <li><a href="/dev-mail.html">Development Lists</a></li> + <li class="divider"></li> + <li><a href="/submitting-patches.html">Submitting patches</a></li> + <li><a href="/builds.html">Source Code</a></li> + <li><a href="/coding-standards.html">Coding standards</a></li> + <li class="divider"></li> + <li><a href="/releases.html">Release Guidelines</a></li> + <li><a href="/bylaws.html">PMC Charter</a></li> + <li><a href="/volunteers.html">Volunteers</a></li> + <li><a href="https://git-wip-us.apache.org/repos/asf?p=struts.git";>Source Repository</a></li> + </ul> + </li> + <li class="apache"><a href="http://www.apache.org/";><img src="/img/apache.png"></a></li> + </ul> + </div> + </div> + </div> + </nav> +</header> + + +<article class="container"> + <section class="col-md-12"> + <a href="index.html" title="back to Core Developers Guide"><< back to Core Developers Guide</a> + <h1 id="PAGE_86602">File Upload</h1> + +<p>The Struts 2 framework provides built-in support for processing file uploads that conform to <a href="http://www\.ietf\.org/rfc/rfc1867\.txt";>RFC 1867</a>^[http://www.ietf.org/rfc/rfc1867.txt], âForm-based File Upload in HTMLâ. When correctly configured the framework will pass uploaded file(s) into your Action class. Support for individual and multiple file uploads are provided. When a file is uploaded it will typically be stored in a temporary directory. Uploaded files should be processed or moved by your Action class to ensure the data is not lost. Be aware that servers may have a security policy in place that prohibits you from writing to directories other than the temporary directory and the directories that belong to your web application.</p> + +<p>#####Dependencies#####</p> + +<p>The Struts 2 framework leverages add-on libraries to handle the parsing of uploaded files. These libraries are not included in the Struts distribution, you must add them into your project. The libraries needed are:</p> + +<table> + <thead> + <tr> + <th>Library</th> + <th>URL</th> + <th>Struts 2.0.x</th> + <th>Struts 2.1.x</th> + <th>Struts 2.5.x</th> + </tr> + </thead> + <tbody> + <tr> + <td>Commons-FileUpload</td> + <td><a href="http://commons\.apache\.org/fileupload/";>http://commons.apache.org/fileupload/</a></td> + <td>1.1.1</td> + <td>1.2.1</td> + <td>1.3.2</td> + </tr> + <tr> + <td>Commons-IO</td> + <td><a href="http://commons\.apache\.org/io/";>http://commons.apache.org/io/</a></td> + <td>1.0</td> + <td>1.3.2</td> + <td>2.4</td> + </tr> + </tbody> +</table> + +<p>If you are using Maven then you can add these libraries as dependencies in your projectâs pom.xml.</p> + +<p><strong>Struts 2.0.x File Upload Dependencies</strong></p> + +<div class="highlighter-rouge"><pre class="highlight"><code><dependency> + <groupId>commons-fileupload</groupId> + <artifactId>commons-fileupload</artifactId> + <version>1.1.1</version> +</dependency> +<dependency> + <groupId>commons-io</groupId> + <artifactId>commons-io</artifactId> + <version>1.0</version> +</dependency> + +</code></pre> +</div> + +<p><strong>Struts 2.1.x File Upload Dependencies</strong></p> + +<div class="highlighter-rouge"><pre class="highlight"><code><dependency> + <groupId>commons-fileupload</groupId> + <artifactId>commons-fileupload</artifactId> + <version>1.2.1</version> +</dependency> +<dependency> + <groupId>commons-io</groupId> + <artifactId>commons-io</artifactId> + <version>1.3.2</version> +</dependency> + +</code></pre> +</div> + +<p>#####Basic Usage#####</p> + +<p>The</p> + +<div class="highlighter-rouge"><pre class="highlight"><code>org.apache.struts2.interceptor.FileUploadInterceptor +</code></pre> +</div> +<p>class is included as part of the</p> + +<div class="highlighter-rouge"><pre class="highlight"><code>defaultStack +</code></pre> +</div> +<p>. As long as the required libraries are added to your project you will be able to take advantage of of the Struts 2 fileUpload capability. Configure an Action mapping for your Action class as you typically would.</p> + +<p><strong>Example action mapping:</strong></p> + +<div class="highlighter-rouge"><pre class="highlight"><code><action name="doUpload" class="com.example.UploadAction"> + <result name="success">good_result.jsp</result> +</action> + +</code></pre> +</div> + +<p>A form must be create with a form field of type file,</p> + +<div class="highlighter-rouge"><pre class="highlight"><code><INPUT type="file" name="upload"> +</code></pre> +</div> +<p>. The form used to upload the file must have its encoding type set to multipart/form-data,</p> + +<div class="highlighter-rouge"><pre class="highlight"><code><FORM action="doUpload" enctype="multipart/form-data" method="post"> +</code></pre> +</div> +<p>. The standard procedure for adding these elements is by using the Struts 2 tag libraries as shown in the following example:</p> + +<p><strong>Example JSP form tags:</strong></p> + +<div class="highlighter-rouge"><pre class="highlight"><code><span class="p">{</span><span class="err">snippet:id=example-form|lang=xml|javadoc=true|url=org.apache.struts2.interceptor.FileUploadInterceptor</span><span class="p">}</span><span class="w"> +</span></code></pre> +</div> +<p>The fileUpload interceptor will use setter injection to insert the uploaded file and related data into your Action class. For a form field named <strong>upload</strong> you would provide the three setter methods shown in the following example:</p> + +<p><strong>Example Action class:</strong></p> + +<div class="highlighter-rouge"><pre class="highlight"><code>package com.example; + + import java.io.File; + import com.opensymphony.xwork2.ActionSupport; + + public class UploadAction extends ActionSupport { + private File file; + private String contentType; + private String filename; + + public void setUpload(File file) { + this.file = file; + } + + public void setUploadContentType(String contentType) { + this.contentType = contentType; + } + + public void setUploadFileName(String filename) { + this.filename = filename; + } + + public String execute() { + //... + return SUCCESS; + } + } + +</code></pre> +</div> + +<p>The purpose of each one of these methods is described in the table below. Notice that if you have multiple file form elements with different names you would be required to have another corresponding set of these methods for each file uploaded.</p> + +<table> + <thead> + <tr> + <th>Method Signature</th> + <th>Description</th> + </tr> + </thead> + <tbody> + <tr> + <td>setX(File file)</td> + <td>The file that contains the content of the uploaded file. This is a temporary file and file.getName() will not return the original name of the file</td> + </tr> + <tr> + <td>setXContentType(String contentType)</td> + <td>The mime type of the uploaded file</td> + </tr> + <tr> + <td>setXFileName(String fileName)</td> + <td>The actual file name of the uploaded file (not the HTML name)</td> + </tr> + </tbody> +</table> + +<p>#####Uploading Multiple Files#####</p> + +<p>As mentioned in the previous section one technique for uploading multiple files would be to simply have multiple form input elements of type file all with different names. This would require a number of setter methods that was equal to 3 times the number of files being uploaded. Another option is to use Arrays or java.util.Lists. The following examples are taken from the Showcase example application that is part sample applications you can download at <a href="http://struts\.apache\.org/download\.cgi";>http://struts.apache.org/download.cgi</a>. For the Action mapping details see</p> + +<div class="highlighter-rouge"><pre class="highlight"><code>struts-fileupload.xml +</code></pre> +</div> +<p>in the sample application download.</p> + +<p><strong>Uploading Multiple Files using Arrays</strong></p> + +<p><strong>multipleUploadUsingArray.jsp</strong> Notice all file input types have the same name.</p> + +<div class="highlighter-rouge"><pre class="highlight"><code><s:form action="doMultipleUploadUsingArray" method="POST" enctype="multipart/form-data"> + <s:file label="File (1)" name="upload" /> + <s:file label="File (2)" name="upload" /> + <s:file label="FIle (3)" name="upload" /> + <s:submit cssClass="btn btn-primary"/> +</s:form> +</code></pre> +</div> + +<p><strong>MultipleFileUploadUsingArrayAction.java</strong></p> + +<p> </p> + +<p>** +**</p> + +<div class="highlighter-rouge"><pre class="highlight"><code>public class MultipleFileUploadUsingArrayAction extends ActionSupport { + private File[] uploads; + private String[] uploadFileNames; + private String[] uploadContentTypes; + + public String upload() throws Exception { + System.out.println("\n\n upload2"); + System.out.println("files:"); + for (File u : uploads) { + System.out.println("*** " + u + "\t" + u.length()); + } + System.out.println("filenames:"); + for (String n : uploadFileNames) { + System.out.println("*** " + n); + } + System.out.println("content types:"); + for (String c : uploadContentTypes) { + System.out.println("*** " + c); + } + System.out.println("\n\n"); + return SUCCESS; + } + public File[] getUpload() { + return this.uploads; + } + public void setUpload(File[] upload) { + this.uploads = upload; + } + public String[] getUploadFileName() { + return this.uploadFileNames; + } + public void setUploadFileName(String[] uploadFileName) { + this.uploadFileNames = uploadFileName; + } + public String[] getUploadContentType() { + return this.uploadContentTypes; + } + public void setUploadContentType(String[] uploadContentType) { + this.uploadContentTypes = uploadContentType; + } +} +</code></pre> +</div> + +<p> </p> + +<p><strong>Uploading Multiple Files using Lists</strong></p> + +<p><strong>multipleUploadUsingList.jsp</strong> Notice all file input types have the same name.</p> + +<div class="highlighter-rouge"><pre class="highlight"><code><s:form action="doMultipleUploadUsingList" method="POST" enctype="multipart/form-data"> + <s:file label="File (1)" name="upload" /> + <s:file label="File (2)" name="upload" /> + <s:file label="FIle (3)" name="upload" /> + <s:submit cssClass="btn btn-primary"/> +</s:form> +</code></pre> +</div> + +<p><strong>MultipleFileUploadUsingListAction.java</strong></p> + +<div class="highlighter-rouge"><pre class="highlight"><code>public class MultipleFileUploadUsingListAction extends ActionSupport { + private List<File> uploads = new ArrayList<File>(); + private List<String> uploadFileNames = new ArrayList<String>(); + private List<String> uploadContentTypes = new ArrayList<String>(); + + public List<File> getUpload() { + return this.uploads; + } + public void setUpload(List<File> uploads) { + this.uploads = uploads; + } + public List<String> getUploadFileName() { + return this.uploadFileNames; + } + public void setUploadFileName(List<String> uploadFileNames) { + this.uploadFileNames = uploadFileNames; + } + public List<String> getUploadContentType() { + return this.uploadContentTypes; + } + public void setUploadContentType(List<String> contentTypes) { + this.uploadContentTypes = contentTypes; + } + public String upload() throws Exception { + System.out.println("\n\n upload1"); + System.out.println("files:"); + for (File u : uploads) { + System.out.println("*** " + u + "\t" + u.length()); + } + System.out.println("filenames:"); + for (String n : uploadFileNames) { + System.out.println("*** " + n); + } + System.out.println("content types:"); + for (String c : uploadContentTypes) { + System.out.println("*** " + c); + } + System.out.println("\n\n"); + return SUCCESS; + } +} +</code></pre> +</div> + +<p>#####Advanced Configuration#####</p> + +<p>The Struts 2</p> + +<div class="highlighter-rouge"><pre class="highlight"><code>default.properties +</code></pre> +</div> +<p>file defines several settings that affect the behavior of file uploading. You may find in necessary to change these values. The names and default values are:</p> + +<div class="highlighter-rouge"><pre class="highlight"><code>struts.multipart.parser=jakarta +struts.multipart.saveDir= +struts.multipart.maxSize=2097152 + +</code></pre> +</div> + +<table> + <tbody> + <tr> + <td>Please remember that the <strong>struts.multipart.maxSize</strong> is the size limit of the whole request, which means when you uploading multiple files, the sum of their size must be below the <strong>struts.multipart.maxSize</strong>!</td> + </tr> + </tbody> +</table> + +<table> + <tbody> + <tr> + </tr> + </tbody> +</table> + +<p>In order to change theses settings you define a constant in your applications</p> + +<div class="highlighter-rouge"><pre class="highlight"><code>struts.xml +</code></pre> +</div> +<p>file like so:</p> + +<div class="highlighter-rouge"><pre class="highlight"><code><span class="cp"><?xml version="1.0" encoding="UTF-8"?></span> +<span class="cp"><!DOCTYPE struts PUBLIC + "-//Apache Software Foundation//DTD Struts Configuration 2.0//EN" + "http://struts.apache.org/dtds/struts-2.0.dtd"></span> +<span class="nt"><struts></span> + <span class="nt"><constant</span> <span class="na">name=</span><span class="s">"struts.multipart.maxSize"</span> <span class="na">value=</span><span class="s">"1000000"</span> <span class="nt">/></span> + ... +<span class="nt"></struts></span> + +</code></pre> +</div> + +<p>Additionally the</p> + +<div class="highlighter-rouge"><pre class="highlight"><code>fileUpload +</code></pre> +</div> +<p>interceptor has settings that can be put in place for individual action mappings by customizing your interceptor stack.</p> + +<div class="highlighter-rouge"><pre class="highlight"><code><action name="doUpload" class="com.example.UploadAction"> + <interceptor-ref name="basicStack"/> + <interceptor-ref name="fileUpload"> + <param name="allowedTypes">text/plain</param> + </interceptor-ref> + <interceptor-ref name="validation"/> + <interceptor-ref name="workflow"/> + + <result name="success">good_result.jsp</result> +</action> + +</code></pre> +</div> + +<p><strong>File Size Limits</strong></p> + +<p>There are two separate file size limits. First is</p> + +<div class="highlighter-rouge"><pre class="highlight"><code>struts.multipart.maxSize +</code></pre> +</div> +<p>which comes from the Struts 2</p> + +<div class="highlighter-rouge"><pre class="highlight"><code>default.properties +</code></pre> +</div> +<p>file. This setting exists for security reasons to prohibit a malicious user from uploading extremely large files to file up your servers disk space. This setting defaults to approximately 2 megabytes and should be adjusted to the maximum size file (2 gigs max) that your will need the framework to receive. If you are uploading more than one file on a form the</p> + +<div class="highlighter-rouge"><pre class="highlight"><code>struts.multipart.maxSize +</code></pre> +</div> +<p>applies to the combined total, not the individual file sizes. The other setting,</p> + +<div class="highlighter-rouge"><pre class="highlight"><code>maximumSize +</code></pre> +</div> +<p>, is an interceptor setting that is used to ensure a particular Action does not receive a file that is too large. Notice the locations of both settings in the following example:</p> + +<div class="highlighter-rouge"><pre class="highlight"><code><span class="cp"><?xml version="1.0" encoding="UTF-8"?></span> +<span class="cp"><!DOCTYPE struts PUBLIC + "-//Apache Software Foundation//DTD Struts Configuration 2.0//EN" + "http://struts.apache.org/dtds/struts-2.0.dtd"></span> +<span class="nt"><struts></span> + <span class="nt"><constant</span> <span class="na">name=</span><span class="s">"struts.multipart.maxSize"</span> <span class="na">value=</span><span class="s">"1000000"</span> <span class="nt">/></span> + + <span class="nt"><action</span> <span class="na">name=</span><span class="s">"doUpload"</span> <span class="na">class=</span><span class="s">"com.example.UploadAction"</span><span class="nt">></span> + <span class="nt"><interceptor-ref</span> <span class="na">name=</span><span class="s">"basicStack"</span><span class="nt">/></span> + <span class="nt"><interceptor-ref</span> <span class="na">name=</span><span class="s">"fileUpload"</span><span class="nt">></span> + <span class="nt"><param</span> <span class="na">name=</span><span class="s">"maximumSize"</span><span class="nt">></span>500000<span class="nt"></param></span> + <span class="nt"></interceptor-ref></span> + <span class="nt"><interceptor-ref</span> <span class="na">name=</span><span class="s">"validation"</span><span class="nt">/></span> + <span class="nt"><interceptor-ref</span> <span class="na">name=</span><span class="s">"workflow"</span><span class="nt">/></span> + + <span class="nt"><result</span> <span class="na">name=</span><span class="s">"success"</span><span class="nt">></span>good_result.jsp<span class="nt"></result></span> + <span class="nt"></action></span> +<span class="nt"></struts></span> + +</code></pre> +</div> + +<p><strong>File Types</strong></p> + +<p>There are two ways to limit the uploaded file type, declaratively and programmatically. To declaratively limit the file type a comma separated list of allowedTypes can be specified as a fileUpload interceptor param as shown in the following example:</p> + +<div class="highlighter-rouge"><pre class="highlight"><code><action name="doUpload" class="com.example.UploadAction"> + <interceptor-ref name="basicStack"/> + <interceptor-ref name="fileUpload"> + <param name="allowedTypes">image/jpeg,image/gif</param> + </interceptor-ref> + <interceptor-ref name="validation"/> + <interceptor-ref name="workflow"/> + + <result name="success">good_result.jsp</result> +</action> + +</code></pre> +</div> + +<p>When the uploaded file type does not match one of the MIME types specified a field error will be created as described in the next section entitled Error Messages. Programmatically limiting the file type means using the information passed in to your Action class via the</p> + +<div class="highlighter-rouge"><pre class="highlight"><code>setXContentType(String contentType) +</code></pre> +</div> +<p>method. The benefit to this type of approach would be that itâs more flexible and no interceptor configuration would be needed if file sizes are keep under 2 megs.</p> + +<p><strong>Error Messages</strong></p> + +<p>If an error occurs several field errors will be added assuming that the action implements</p> + +<div class="highlighter-rouge"><pre class="highlight"><code>com.opensymphony.xwork2.ValidationAware +</code></pre> +</div> +<p>or extends</p> + +<div class="highlighter-rouge"><pre class="highlight"><code>com.opensymphony.xwork2.ActionSupport +</code></pre> +</div> +<p>. These error messages are based on several i18n values stored in struts-messages.properties, a default i18n file processed for all i18n requests. You can override the text of these messages by providing text for the following keys:</p> + +<table> + <thead> + <tr> + <th>Error Key</th> + <th>Description</th> + </tr> + </thead> + <tbody> + <tr> + <td>struts.messages.error.uploading</td> + <td>A general error that occurs when the file could not be uploaded</td> + </tr> + <tr> + <td>struts.messages.error.file.too.large</td> + <td>Occurs when the uploaded file is too large as specified by maximumSize.</td> + </tr> + <tr> + <td>struts.messages.error.content.type.not.allowed</td> + <td>Occurs when the uploaded file does not match the expected content types specified</td> + </tr> + <tr> + <td>struts.messages.error.file.extension.not.allowed</td> + <td>Occurs when uploaded file has disallowed extension</td> + </tr> + <tr> + <td>struts.messages.upload.error.SizeLimitExceededException</td> + <td>Occurs when the upload request (as a whole) exceed configured <strong>struts.multipart.maxSize</strong></td> + </tr> + <tr> + <td>struts.messages.upload.error.<Exception class SimpleName></td> + <td>Occurs when any other exception took place during file upload process</td> + </tr> + </tbody> +</table> + +<p><strong>Temporary Directories</strong></p> + +<p>All uploaded files are saved to a temporary directory by the framework before being passed in to an Action. Depending on the allowed file sizes it may be necessary to have the framework store these temporary files in an alternate location. To do this change</p> + +<div class="highlighter-rouge"><pre class="highlight"><code>struts.multipart.saveDir +</code></pre> +</div> +<p>to the directory where the uploaded files will be placed. If this property is not set it defaults to</p> + +<div class="highlighter-rouge"><pre class="highlight"><code>javax.servlet.context.tempdir +</code></pre> +</div> +<p>. Keep in mind that on some operating systems, like Solaris,</p> + +<div class="highlighter-rouge"><pre class="highlight"><code>/tmp +</code></pre> +</div> +<p>is memory based and files stored in that directory would consume an amount of RAM approximately equal to the size of the uploaded file.</p> + +<p><strong>Alternate Libraries</strong></p> + +<p>The</p> + +<div class="highlighter-rouge"><pre class="highlight"><code>struts.multipart.parser +</code></pre> +</div> +<p>used by the fileUpload interceptor to handle HTTP POST requests, encoded using the MIME-type multipart/form-data, can be changed out. Currently there are two choices, jakarta and pell. The jakarta parser is a standard part of the Struts 2 framework needing only its required libraries added to a project. The pell parser uses Jason Pellâs multipart parser instead of the Commons-FileUpload library. The pell parser is a Struts 2 plugin, for more details see: <em>pell multipart plugin</em> . There was a third alternative, cos, but it was removed due to licensing incompatibilities.</p> + +<p>As from Struts version 2.3.18 a new implementation of </p> + +<div class="highlighter-rouge"><pre class="highlight"><code>MultiPartRequest +</code></pre> +</div> +<p>was added - </p> + +<div class="highlighter-rouge"><pre class="highlight"><code>JakartaStreamMultiPartRequest +</code></pre> +</div> +<p>. It can be used to handle large files, see <a href="https://issues\.apache\.org/jira/browse/WW\-3025";>WW-3025</a>^[https://issues.apache.org/jira/browse/WW-3025] for more details, but you can simple set</p> + +<blockquote> + <p><constant name=âstruts.multipart.parserâ value=âjakarta-streamâ /></p> +</blockquote> + +<p>in struts.xml to start using it.</p> + +<p><strong>Request validation</strong></p> + +<p>The </p> + +<div class="highlighter-rouge"><pre class="highlight"><code>struts.multipart.validationRegex +</code></pre> +</div> +<p> is used to define a RegEx to be used to validate if the incoming request is a multipart request. The request must use the</p> + +<div class="highlighter-rouge"><pre class="highlight"><code>POST +</code></pre> +</div> +<p> method and match the RegEx, by default the RegEx is defined as follow:</p> + +<div class="highlighter-rouge"><pre class="highlight"><code>^multipart\\/form-data(; boundary=[a-zA-Z0-9]{1,70})? +</code></pre> +</div> + +<p>Please read <a href="https://www\.w3\.org/Protocols/rfc1341/7\_2\_Multipart\.html";>RFC1341</a>^[https://www.w3.org/Protocols/rfc1341/7_2_Multipart.html] the <strong>Multipart section</strong> for more details, existing Struts</p> + +<div class="highlighter-rouge"><pre class="highlight"><code>Multipart +</code></pre> +</div> +<p> parsers support only </p> + +<div class="highlighter-rouge"><pre class="highlight"><code>multipart/form-data +</code></pre> +</div> +<p> content type. This option is available since Struts 2.3.11.</p> + +<p><strong>Disabling file upload support</strong></p> + +<p>You can alternatively disable the whole file upload mechanism defining a constant in </p> + +<div class="highlighter-rouge"><pre class="highlight"><code>struts.xml +</code></pre> +</div> +<p>:</p> + +<div class="highlighter-rouge"><pre class="highlight"><code><constant name="struts.multipart.enabled" value="false"/> +</code></pre> +</div> + +<p>With this constant in place, Struts will ignore a </p> + +<div class="highlighter-rouge"><pre class="highlight"><code>Content-Type +</code></pre> +</div> +<p>header and will treat each request as an ordinary http request. This option is available since Struts 2.3.11.</p> + +<p> </p> + + </section> +</article> + + +<footer class="container"> + <div class="col-md-12"> + Copyright © 2000-2016 <a href="http://www.apache.org/";>The Apache Software Foundation </a>. + All Rights Reserved. + </div> + <div class="col-md-12"> + Apache Struts, Struts, Apache, the Apache feather logo, and the Apache Struts project logos are + trademarks of The Apache Software Foundation. + </div> + <div class="col-md-12">Logo and website design donated by <a href="https://softwaremill.com/";>SoftwareMill</a>.</div> +</footer> + +<script>!function (d, s, id) { + var js, fjs = d.getElementsByTagName(s)[0]; + if (!d.getElementById(id)) { + js = d.createElement(s); + js.id = id; + js.src = "//platform.twitter.com/widgets.js"; + fjs.parentNode.insertBefore(js, fjs); + } +}(document, "script", "twitter-wjs");</script> +<script src="https://apis.google.com/js/platform.js"; async="async" defer="defer"></script> + +<div id="fb-root"></div> + +<script>(function (d, s, id) { + var js, fjs = d.getElementsByTagName(s)[0]; + if (d.getElementById(id)) return; + js = d.createElement(s); + js.id = id; + js.src = "//connect.facebook.net/en_GB/all.js#xfbml=1"; + fjs.parentNode.insertBefore(js, fjs); +}(document, 'script', 'facebook-jssdk'));</script> + + +<script> +$(function() { + return $("h2, h3, h4, h5, h6").each(function(i, el) { + var $el, id; + $el = $(el); + id = $el.attr('id'); + if (id) { + $el.removeAttr('id'); + return $el.before($("<a />").addClass('anchor').attr('name', id)); + } + }); +}); +</script> + +</body> +</html> Added: websites/production/struts/content/core-developers/formatting-dates-and-numbers.html ============================================================================== --- websites/production/struts/content/core-developers/formatting-dates-and-numbers.html (added) +++ websites/production/struts/content/core-developers/formatting-dates-and-numbers.html Thu Jun 1 11:35:58 2017 @@ -0,0 +1,288 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="UTF-8"/> + <meta name="viewport" content="width=device-width, initial-scale=1.0"/> + <meta name="Date-Revision-yyyymmdd" content="20140918"/> + <meta http-equiv="Content-Language" content="en"/> + <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> + + <title>Formatting Dates and Numbers</title> + + <link href="//fonts.googleapis.com/css?family=Source+Sans+Pro:300,400,600,700,400italic,600italic,700italic" rel="stylesheet" type="text/css"> + <link href="//netdna.bootstrapcdn.com/font-awesome/4.0.3/css/font-awesome.css" rel="stylesheet"> + <link href="/css/main.css" rel="stylesheet"> + <link href="/css/custom.css" rel="stylesheet"> + <link href="/highlighter/github-theme.css" rel="stylesheet"> + + <script src="//ajax.googleapis.com/ajax/libs/jquery/1.11.0/jquery.min.js"></script> + <script type="text/javascript" src="/bootstrap/js/bootstrap.js"></script> + <script type="text/javascript" src="/js/community.js"></script> +</head> +<body> + +<a href="http://github.com/apache/struts"; class="github-ribbon"> + <img style="position: absolute; right: 0; border: 0;" src="https://s3.amazonaws.com/github/ribbons/forkme_right_red_aa0000.png"; alt="Fork me on GitHub"> +</a> + +<header> + <nav> + <div role="navigation" class="navbar navbar-default navbar-fixed-top"> + <div class="container"> + <div class="navbar-header"> + <button type="button" data-toggle="collapse" data-target="#struts-menu" class="navbar-toggle"> + Menu + <span class="sr-only">Toggle navigation</span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + </button> + <a href="/index.html" class="navbar-brand logo"><img src="/img/struts-logo.svg"></a> + </div> + <div id="struts-menu" class="navbar-collapse collapse"> + <ul class="nav navbar-nav"> + <li class="dropdown"> + <a data-toggle="dropdown" href="#" class="dropdown-toggle"> + Home<b class="caret"></b> + </a> + <ul class="dropdown-menu"> + <li><a href="/index.html">Welcome</a></li> + <li><a href="/downloads.html">Downloads</a></li> + <li><a href="/announce.html">Announcements</a></li> + <li><a href="http://www.apache.org/licenses/";>License</a></li> + <li><a href="http://apache.org/foundation/thanks.html";>Thanks!</a></li> + <li><a href="http://apache.org/foundation/sponsorship.html";>Sponsorship</a></li> + </ul> + </li> + <li class="dropdown"> + <a data-toggle="dropdown" href="#" class="dropdown-toggle"> + Support<b class="caret"></b> + </a> + <ul class="dropdown-menu"> + <li><a href="/mail.html">User Mailing List</a></li> + <li><a href="https://issues.apache.org/jira/browse/WW";>Issue Tracker</a></li> + <li><a href="/security.html">Reporting Security Issues</a></li> + <li class="divider"></li> + <li><a href="/maven/project-info.html">Project info</a></li> + <li><a href="/maven/struts2-core/dependencies.html">Struts Core dependencies</a></li> + <li><a href="/maven/struts2-plugins/modules.html">Plugin dependencies</a></li> + </ul> + </li> + <li class="dropdown"> + <a data-toggle="dropdown" href="#" class="dropdown-toggle"> + Documentation<b class="caret"></b> + </a> + <ul class="dropdown-menu"> + <li><a href="/birdseye.html">Birds Eye</a></li> + <li><a href="/primer.html">Key Technologies</a></li> + <li><a href="/kickstart.html">Kickstart FAQ</a></li> + <li><a href="https://cwiki.apache.org/confluence/display/WW/Home";>Wiki</a></li> + <li class="divider"></li> + <li><a href="/getting-started/">Getting Started</a></li> + <li><a href="/docs/tutorials.html">Tutorials</a></li> + <li><a href="/docs/faqs.html">FAQs</a></li> + <li><a href="/docs/guides.html">Guides</a></li> + <li class="divider"></li> + <li><a href="/maven/struts2-core/apidocs/index.html">Struts Core API</a></li> + <li><a href="/docs/plugins.html">Plugin APIs</a></li> + <li><a href="/docs/tag-reference.html">Tag reference</a></li> + <li><a href="http://cwiki.apache.org/S2PLUGINS/home.html";>Plugin registry</a></li> + <li class="divider"></li> + <li><a href="/security/">Security Guide (WIP)</a></li> + <li><a href="/core-developers/">Core Developers Guide (WIP)</a></li> + </ul> + </li> + <li class="dropdown"> + <a data-toggle="dropdown" href="#" class="dropdown-toggle"> + Contributing<b class="caret"></b> + </a> + <ul class="dropdown-menu"> + <li><a href="/youatstruts.html">You at Struts</a></li> + <li><a href="/helping.html">How to Help FAQ</a></li> + <li><a href="/dev-mail.html">Development Lists</a></li> + <li class="divider"></li> + <li><a href="/submitting-patches.html">Submitting patches</a></li> + <li><a href="/builds.html">Source Code</a></li> + <li><a href="/coding-standards.html">Coding standards</a></li> + <li class="divider"></li> + <li><a href="/releases.html">Release Guidelines</a></li> + <li><a href="/bylaws.html">PMC Charter</a></li> + <li><a href="/volunteers.html">Volunteers</a></li> + <li><a href="https://git-wip-us.apache.org/repos/asf?p=struts.git";>Source Repository</a></li> + </ul> + </li> + <li class="apache"><a href="http://www.apache.org/";><img src="/img/apache.png"></a></li> + </ul> + </div> + </div> + </div> + </nav> +</header> + + +<article class="container"> + <section class="col-md-12"> + <a href="index.html" title="back to Core Developers Guide"><< back to Core Developers Guide</a> + <h1 id="formatting-dates-and-numbers">Formatting Dates and Numbers</h1> + +<p>####Defining Formats####</p> + +<p>Struts2 supports localization (l10n) aware formatting of dates, times and numbers very easily, utilizing Javaâs built-in date formatting features.</p> + +<p>As seen in the <a href="#PAGE_14043">Localization</a> chapter, it is quite easy to define hierarchical resource bundles with Struts2, giving the developer the opportunity to define locale dependent message formats. This is the entry point to define the needed date, time and number formats. Your default properties could contain the following generic formats:</p> + +<div class="highlighter-rouge"><pre class="highlight"><code> +format.time = {0,time} +format.number = {0,number,#0.0##} +format.percent = {0,number,##0.00'%'} +format.money = {0,number,\u00A4##0.00} + +</code></pre> +</div> + +<p>An appropriate en_US format definition extension could look like this:</p> + +<div class="highlighter-rouge"><pre class="highlight"><code> +format.date = {0,date,MM/dd/yy} + +</code></pre> +</div> + +<p>In parallel, you could add the following to your de_DE bundle:</p> + +<div class="highlighter-rouge"><pre class="highlight"><code> +format.date = {0,date,dd.MM.yyyy} + +</code></pre> +</div> + +<p>Read more on how to define message formats in Sunâs Java API docs for <a href="http://java\.sun\.com/j2se/1\.5\.0/docs/api/java/text/MessageFormat\.html";>MessageFormat</a>^[http://java.sun.com/j2se/1.5.0/docs/api/java/text/MessageFormat.html].</p> + +<p>Now that we have our formats set up, it is quite easy to use them in our views.</p> + +<p>####Formatting output using the s:text tag####</p> + +<p>Given you had a Float value myMoneyValue, accessible through the getter getMyMoneyValue in your action, the following code would print out localized representation of the value as a currency amount, using the format.money message format defined above with a <em>s:text</em> tag:</p> + +<div class="highlighter-rouge"><pre class="highlight"><code> +<s:text name="format.money"> + <s:param name="value" value="myMoneyValue"/> +</s:text> + +</code></pre> +</div> + +<p>The (first) parameter defines the value which is to replace the â0â placeholder in the defined message format.</p> + +<p>Another example, formatting a date value:</p> + +<div class="highlighter-rouge"><pre class="highlight"><code> +<s:text name="format.date"><s:param value="dueDate"/></s:text> + +</code></pre> +</div> + +<table> + <tbody> + <tr> + <td>While the s:text tag is very useful to format numbers, date formatting has become a lot easier thanks to the <em>s:date</em> tag.</td> + </tr> + </tbody> +</table> + +<table> + <tbody> + <tr> + </tr> + </tbody> +</table> + +<p>####Localizing form data with getText####</p> + +<p>Placing a textfield in a form like this</p> + +<div class="highlighter-rouge"><pre class="highlight"><code> +<s:textfield key="orderItem.price" /> + +</code></pre> +</div> + +<p>to input a number, one might have noticed that the number is always shown in the Java default number format. Not only that this is not âniceâ, if you are in a non-en locale, it will also cause trouble when submitting the form since type conversion is locale aware. The solution is to again use the message formats as defined above, by using the getText Method of ActionSupport:</p> + +<div class="highlighter-rouge"><pre class="highlight"><code> +<s:textfield key="orderItem.price" value="%{getText('format.number',{orderItem.price})}" /> + +</code></pre> +</div> + +<p>This maps to the method signature getText( String key, Object[] params ) in ActionSupport.</p> + +<p>####Using getFormatted() with conversion support####</p> + +<p>A new method getFormatted was added to ActionSupport (which can be implemented in your base action) to support formatting and conversion errors with I10N.</p> + +<p>You can place a code like below</p> + +<div class="highlighter-rouge"><pre class="highlight"><code> +<s:textfield key="user.born" value="%{getFormatted('format.number','user.born')}" /> + +</code></pre> +</div> + +<p>to get support for I10N and also to support conversion errors.</p> + + </section> +</article> + + +<footer class="container"> + <div class="col-md-12"> + Copyright © 2000-2016 <a href="http://www.apache.org/";>The Apache Software Foundation </a>. + All Rights Reserved. + </div> + <div class="col-md-12"> + Apache Struts, Struts, Apache, the Apache feather logo, and the Apache Struts project logos are + trademarks of The Apache Software Foundation. + </div> + <div class="col-md-12">Logo and website design donated by <a href="https://softwaremill.com/";>SoftwareMill</a>.</div> +</footer> + +<script>!function (d, s, id) { + var js, fjs = d.getElementsByTagName(s)[0]; + if (!d.getElementById(id)) { + js = d.createElement(s); + js.id = id; + js.src = "//platform.twitter.com/widgets.js"; + fjs.parentNode.insertBefore(js, fjs); + } +}(document, "script", "twitter-wjs");</script> +<script src="https://apis.google.com/js/platform.js"; async="async" defer="defer"></script> + +<div id="fb-root"></div> + +<script>(function (d, s, id) { + var js, fjs = d.getElementsByTagName(s)[0]; + if (d.getElementById(id)) return; + js = d.createElement(s); + js.id = id; + js.src = "//connect.facebook.net/en_GB/all.js#xfbml=1"; + fjs.parentNode.insertBefore(js, fjs); +}(document, 'script', 'facebook-jssdk'));</script> + + +<script> +$(function() { + return $("h2, h3, h4, h5, h6").each(function(i, el) { + var $el, id; + $el = $(el); + id = $el.attr('id'); + if (id) { + $el.removeAttr('id'); + return $el.before($("<a />").addClass('anchor').attr('name', id)); + } + }); +}); +</script> + +</body> +</html> Added: websites/production/struts/content/core-developers/freemarker-result.html ============================================================================== --- websites/production/struts/content/core-developers/freemarker-result.html (added) +++ websites/production/struts/content/core-developers/freemarker-result.html Thu Jun 1 11:35:58 2017 @@ -0,0 +1,253 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="UTF-8"/> + <meta name="viewport" content="width=device-width, initial-scale=1.0"/> + <meta name="Date-Revision-yyyymmdd" content="20140918"/> + <meta http-equiv="Content-Language" content="en"/> + <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> + + <title>FreeMarker Result</title> + + <link href="//fonts.googleapis.com/css?family=Source+Sans+Pro:300,400,600,700,400italic,600italic,700italic" rel="stylesheet" type="text/css"> + <link href="//netdna.bootstrapcdn.com/font-awesome/4.0.3/css/font-awesome.css" rel="stylesheet"> + <link href="/css/main.css" rel="stylesheet"> + <link href="/css/custom.css" rel="stylesheet"> + <link href="/highlighter/github-theme.css" rel="stylesheet"> + + <script src="//ajax.googleapis.com/ajax/libs/jquery/1.11.0/jquery.min.js"></script> + <script type="text/javascript" src="/bootstrap/js/bootstrap.js"></script> + <script type="text/javascript" src="/js/community.js"></script> +</head> +<body> + +<a href="http://github.com/apache/struts"; class="github-ribbon"> + <img style="position: absolute; right: 0; border: 0;" src="https://s3.amazonaws.com/github/ribbons/forkme_right_red_aa0000.png"; alt="Fork me on GitHub"> +</a> + +<header> + <nav> + <div role="navigation" class="navbar navbar-default navbar-fixed-top"> + <div class="container"> + <div class="navbar-header"> + <button type="button" data-toggle="collapse" data-target="#struts-menu" class="navbar-toggle"> + Menu + <span class="sr-only">Toggle navigation</span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + </button> + <a href="/index.html" class="navbar-brand logo"><img src="/img/struts-logo.svg"></a> + </div> + <div id="struts-menu" class="navbar-collapse collapse"> + <ul class="nav navbar-nav"> + <li class="dropdown"> + <a data-toggle="dropdown" href="#" class="dropdown-toggle"> + Home<b class="caret"></b> + </a> + <ul class="dropdown-menu"> + <li><a href="/index.html">Welcome</a></li> + <li><a href="/downloads.html">Downloads</a></li> + <li><a href="/announce.html">Announcements</a></li> + <li><a href="http://www.apache.org/licenses/";>License</a></li> + <li><a href="http://apache.org/foundation/thanks.html";>Thanks!</a></li> + <li><a href="http://apache.org/foundation/sponsorship.html";>Sponsorship</a></li> + </ul> + </li> + <li class="dropdown"> + <a data-toggle="dropdown" href="#" class="dropdown-toggle"> + Support<b class="caret"></b> + </a> + <ul class="dropdown-menu"> + <li><a href="/mail.html">User Mailing List</a></li> + <li><a href="https://issues.apache.org/jira/browse/WW";>Issue Tracker</a></li> + <li><a href="/security.html">Reporting Security Issues</a></li> + <li class="divider"></li> + <li><a href="/maven/project-info.html">Project info</a></li> + <li><a href="/maven/struts2-core/dependencies.html">Struts Core dependencies</a></li> + <li><a href="/maven/struts2-plugins/modules.html">Plugin dependencies</a></li> + </ul> + </li> + <li class="dropdown"> + <a data-toggle="dropdown" href="#" class="dropdown-toggle"> + Documentation<b class="caret"></b> + </a> + <ul class="dropdown-menu"> + <li><a href="/birdseye.html">Birds Eye</a></li> + <li><a href="/primer.html">Key Technologies</a></li> + <li><a href="/kickstart.html">Kickstart FAQ</a></li> + <li><a href="https://cwiki.apache.org/confluence/display/WW/Home";>Wiki</a></li> + <li class="divider"></li> + <li><a href="/getting-started/">Getting Started</a></li> + <li><a href="/docs/tutorials.html">Tutorials</a></li> + <li><a href="/docs/faqs.html">FAQs</a></li> + <li><a href="/docs/guides.html">Guides</a></li> + <li class="divider"></li> + <li><a href="/maven/struts2-core/apidocs/index.html">Struts Core API</a></li> + <li><a href="/docs/plugins.html">Plugin APIs</a></li> + <li><a href="/docs/tag-reference.html">Tag reference</a></li> + <li><a href="http://cwiki.apache.org/S2PLUGINS/home.html";>Plugin registry</a></li> + <li class="divider"></li> + <li><a href="/security/">Security Guide (WIP)</a></li> + <li><a href="/core-developers/">Core Developers Guide (WIP)</a></li> + </ul> + </li> + <li class="dropdown"> + <a data-toggle="dropdown" href="#" class="dropdown-toggle"> + Contributing<b class="caret"></b> + </a> + <ul class="dropdown-menu"> + <li><a href="/youatstruts.html">You at Struts</a></li> + <li><a href="/helping.html">How to Help FAQ</a></li> + <li><a href="/dev-mail.html">Development Lists</a></li> + <li class="divider"></li> + <li><a href="/submitting-patches.html">Submitting patches</a></li> + <li><a href="/builds.html">Source Code</a></li> + <li><a href="/coding-standards.html">Coding standards</a></li> + <li class="divider"></li> + <li><a href="/releases.html">Release Guidelines</a></li> + <li><a href="/bylaws.html">PMC Charter</a></li> + <li><a href="/volunteers.html">Volunteers</a></li> + <li><a href="https://git-wip-us.apache.org/repos/asf?p=struts.git";>Source Repository</a></li> + </ul> + </li> + <li class="apache"><a href="http://www.apache.org/";><img src="/img/apache.png"></a></li> + </ul> + </div> + </div> + </div> + </nav> +</header> + + +<article class="container"> + <section class="col-md-12"> + <a href="index.html" title="back to Core Developers Guide"><< back to Core Developers Guide</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> + +<ul> + <li>a classpath resource, e.g.:</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> + +<ul> + <li> + <p><strong>location</strong> (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> + </li> + <li> + <p><strong>contentType</strong> - defaults to</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> + +<div class="highlighter-rouge"><pre class="highlight"><code><result name="success" type="freemarker">foo.ftl</result> +</code></pre> +</div> + + </section> +</article> + + +<footer class="container"> + <div class="col-md-12"> + Copyright © 2000-2016 <a href="http://www.apache.org/";>The Apache Software Foundation </a>. + All Rights Reserved. + </div> + <div class="col-md-12"> + Apache Struts, Struts, Apache, the Apache feather logo, and the Apache Struts project logos are + trademarks of The Apache Software Foundation. + </div> + <div class="col-md-12">Logo and website design donated by <a href="https://softwaremill.com/";>SoftwareMill</a>.</div> +</footer> + +<script>!function (d, s, id) { + var js, fjs = d.getElementsByTagName(s)[0]; + if (!d.getElementById(id)) { + js = d.createElement(s); + js.id = id; + js.src = "//platform.twitter.com/widgets.js"; + fjs.parentNode.insertBefore(js, fjs); + } +}(document, "script", "twitter-wjs");</script> +<script src="https://apis.google.com/js/platform.js"; async="async" defer="defer"></script> + +<div id="fb-root"></div> + +<script>(function (d, s, id) { + var js, fjs = d.getElementsByTagName(s)[0]; + if (d.getElementById(id)) return; + js = d.createElement(s); + js.id = id; + js.src = "//connect.facebook.net/en_GB/all.js#xfbml=1"; + fjs.parentNode.insertBefore(js, fjs); +}(document, 'script', 'facebook-jssdk'));</script> + + +<script> +$(function() { + return $("h2, h3, h4, h5, h6").each(function(i, el) { + var $el, id; + $el = $(el); + id = $el.attr('id'); + if (id) { + $el.removeAttr('id'); + return $el.before($("<a />").addClass('anchor').attr('name', id)); + } + }); +}); +</script> + +</body> +</html>
![https://s3.amazonaws.com/github/ribbons/forkme_right_red_aa0000.png"](https://s3.amazonaws.com/github/ribbons/forkme_right_red_aa0000.png"){kind=link}