content/core-developers/stream-result.html - struts-site - Git at Google

 <!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>Stream 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="//code.jquery.com/jquery-1.11.0.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="/download.cgi">Download</a></li>
                 <li><a href="/releases.html">Releases</a></li>
                 <li><a href="/announce.html">Announcements</a></li>
                 <li><a href="http://www.apache.org/licenses/">License</a></li>
                 <li><a href="https://www.apache.org/foundation/thanks.html">Thanks!</a></li>
                 <li><a href="https://www.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="https://cwiki.apache.org/confluence/display/WW/Migration+Guide">Version Notes</a></li>
                 <li><a href="https://cwiki.apache.org/confluence/display/WW/Security+Bulletins">Security Bulletins</a></li>
                 <li class="divider"></li>
                 <li><a href="/maven/project-info.html">Maven 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="/security/">Security Guide</a></li>
                 <li><a href="/core-developers/">Core Developers Guide</a></li>
                 <li><a href="/tag-developers/">Tag Developers Guide</a></li>
                 <li><a href="/maven-archetypes/">Maven Archetypes</a></li>
                 <li><a href="/plugins/">Plugins</a></li>
                 <li><a href="/maven/struts2-core/apidocs/index.html">Struts Core API</a></li>
                 <li><a href="/tag-developers/tag-reference.html">Tag reference</a></li>
                 <li><a href="https://cwiki.apache.org/confluence/display/WW/FAQs">FAQs</a></li>
                 <li><a href="http://cwiki.apache.org/S2PLUGINS/home.html">Plugin registry</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><a href="/contributors/">Contributors Guide</a></li>
                 <li class="divider"></li>
                 <li><a href="/submitting-patches.html">Submitting patches</a></li>
                 <li><a href="/builds.html">Source Code and Builds</a></li>
                 <li><a href="/coding-standards.html">Coding standards</a></li>
                 <li><a href="https://cwiki.apache.org/confluence/display/WW/Contributors+Guide">Contributors Guide</a></li>
                 <li class="divider"></li>
                 <li><a href="/release-guidelines.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://gitbox.apache.org/repos/asf?p=struts.git">Source Repository</a></li>
                 <li><a href="/updating-website.html">Updating the website</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 class="edit-on-gh" href="https://github.com/apache/struts-site/edit/master/source/core-developers/stream-result.md" title="Edit this page on GitHub">Edit on GitHub</a>

     <a href="index.html" title="back to Core Developers Guide"><< back to Core Developers Guide</a>

     <h1 id="stream-result">Stream Result</h1>

 <p>A custom Result type for sending raw data (via an InputStream) directly to the HttpServletResponse. Very useful for
 allowing users to download content. If you are running your app server under HTTPS and having issues with PDF’s or other
 file streams you should take a look at <a href="https-and-ie-issues.html">HTTPS and IE Issues</a></p>

 <h2 id="parameters">Parameters</h2>

 <ul>
   <li><code class="highlighter-rouge">contentType</code> - the stream mime-type as sent to the web browser (default = <code class="highlighter-rouge">text/plain</code>).</li>
   <li><code class="highlighter-rouge">contentLength</code> - the stream length in bytes (the browser displays a progress bar).</li>
   <li><code class="highlighter-rouge">contentDisposition</code> - the content disposition header value for specifying the file name (default = <code class="highlighter-rouge">inline</code>, values
 are typically <code class="highlighter-rouge">attachment;filename="document.pdf"</code>.</li>
   <li><code class="highlighter-rouge">inputName</code> - the name of the InputStream property from the chained action (default = <code class="highlighter-rouge">inputStream</code>).</li>
   <li><code class="highlighter-rouge">bufferSize</code> - the size of the buffer to copy from input to output (default = <code class="highlighter-rouge">1024</code>).</li>
   <li><code class="highlighter-rouge">allowCaching</code> - if set to ‘false’ it will set the headers <code class="highlighter-rouge">Pragma</code> and <code class="highlighter-rouge">Cache-Control</code> to <code class="highlighter-rouge">no-cahce</code>, and prevent
 client from caching the content (default = <code class="highlighter-rouge">true</code>).</li>
   <li><code class="highlighter-rouge">contentCharSet</code> - if set to a string, ‘;charset=value’ will be added to the content-type header, where value is the string
 set. If set to an expression, the result of evaluating the expression will be used. If not set, then no charset will
 be set on the header</li>
 </ul>

 <p>These parameters can also be set by exposing a similarly named getter method on your Action. For example, you can provide
 <code class="highlighter-rouge">getContentType()</code> to override that parameter for the current action. To do it you you must explicitly define this param
 as an expression i.e. <code class="highlighter-rouge">&lt;param name="contentType"&gt;${contentType}&lt;/param&gt;</code></p>

 <p class="alert alert-success">Please be aware that this was changed since Struts 2.5.2, previously each parameter was automatically resolved by looking
 throughout the <code class="highlighter-rouge">ValueStack</code>, now you must explicitly define which parameter must be evaluated, even <code class="highlighter-rouge">inputName</code>.</p>

 <h2 id="examples">Examples</h2>

 <h3 id="annotation-based-configuration">Annotation based Configuration</h3>

 <p>To configure Actions and Results with Annotations you need to activate the Struts2 <a href="../plugins/convention/">Convention Plugin</a>
 in your Struts2 application.</p>

 <div class="language-java highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kn">package</span> <span class="n">com</span><span class="o">.</span><span class="na">mycompany</span><span class="o">.</span><span class="na">webapp</span><span class="o">.</span><span class="na">actions</span><span class="o">;</span>

 <span class="kn">import</span> <span class="nn">java.io.File</span><span class="o">;</span>
 <span class="kn">import</span> <span class="nn">java.io.FileInputStream</span><span class="o">;</span>
 <span class="kn">import</span> <span class="nn">java.io.InputStream</span><span class="o">;</span>

 <span class="kn">import</span> <span class="nn">org.apache.struts2.convention.annotation.Result</span><span class="o">;</span>

 <span class="kn">import</span> <span class="nn">com.opensymphony.xwork2.Action</span><span class="o">;</span>
 <span class="kn">import</span> <span class="nn">com.opensymphony.xwork2.ActionSupport</span><span class="o">;</span>

 <span class="nd">@Result</span><span class="o">(</span>
 	<span class="n">name</span> <span class="o">=</span> <span class="s">"success"</span><span class="o">,</span>
 	<span class="n">type</span> <span class="o">=</span> <span class="s">"stream"</span><span class="o">,</span>
 	<span class="n">params</span> <span class="o">=</span> <span class="o">{</span>
 		<span class="s">"contentType"</span><span class="o">,</span> <span class="s">"${type}"</span><span class="o">,</span>
 		<span class="s">"inputName"</span><span class="o">,</span> <span class="s">"${stream}"</span><span class="o">,</span>
 		<span class="s">"bufferSize"</span><span class="o">,</span> <span class="s">"1024"</span><span class="o">,</span>
 		<span class="s">"contentDisposition"</span><span class="o">,</span> <span class="s">"attachment;filename=\"${filename}\""</span>
 	<span class="o">}</span>
 <span class="o">)</span>
 <span class="kd">public</span> <span class="kd">class</span> <span class="nc">FileDisplay</span> <span class="kd">extends</span> <span class="n">ActionSupport</span> <span class="o">{</span>

 	<span class="kd">private</span> <span class="n">String</span> <span class="n">type</span> <span class="o">=</span> <span class="s">"image/jpeg"</span><span class="o">;</span>
 	<span class="kd">private</span> <span class="n">String</span> <span class="n">filename</span><span class="o">;</span>
 	<span class="kd">private</span> <span class="n">InputStream</span> <span class="n">stream</span><span class="o">;</span>

 	<span class="kd">public</span> <span class="n">String</span> <span class="nf">execute</span><span class="o">()</span> <span class="kd">throws</span> <span class="n">Exception</span> <span class="o">{</span>

 		<span class="n">filename</span> <span class="o">=</span> <span class="s">"myimage.jpg"</span><span class="o">;</span>
 		<span class="n">File</span> <span class="n">img</span> <span class="o">=</span> <span class="k">new</span> <span class="n">File</span><span class="o">(</span><span class="s">"/path/to/image/image.jpg"</span><span class="o">);</span>
 		<span class="n">stream</span> <span class="o">=</span> <span class="k">new</span> <span class="n">FileInputStream</span><span class="o">(</span><span class="n">img</span><span class="o">);</span>

 		<span class="k">return</span> <span class="n">Action</span><span class="o">.</span><span class="na">SUCCESS</span><span class="o">;</span>
 	<span class="o">}</span>

 	<span class="kd">private</span> <span class="n">String</span> <span class="nf">getType</span><span class="o">()</span> <span class="o">{</span>
 		<span class="k">return</span> <span class="k">this</span><span class="o">.</span><span class="na">type</span><span class="o">;</span>
 	<span class="o">}</span>

 	<span class="kd">private</span> <span class="n">String</span> <span class="nf">getFilename</span><span class="o">()</span> <span class="o">{</span>
 		<span class="k">return</span> <span class="k">this</span><span class="o">.</span><span class="na">filename</span><span class="o">;</span>
 	<span class="o">}</span>

 	<span class="kd">private</span> <span class="n">String</span> <span class="nf">getStream</span><span class="o">()</span> <span class="o">{</span>
 		<span class="k">return</span> <span class="k">this</span><span class="o">.</span><span class="na">stream</span><span class="o">;</span>
 	<span class="o">}</span>
 <span class="o">}</span>
 </code></pre></div></div>

 <h3 id="xml-based-configuration">XML based Configuration</h3>

 <div class="language-xml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nt">&lt;result</span> <span class="na">name=</span><span class="s">"success"</span> <span class="na">type=</span><span class="s">"stream"</span><span class="nt">&gt;</span>
   <span class="nt">&lt;param</span> <span class="na">name=</span><span class="s">"contentType"</span><span class="nt">&gt;</span>image/jpeg<span class="nt">&lt;/param&gt;</span>
   <span class="nt">&lt;param</span> <span class="na">name=</span><span class="s">"inputName"</span><span class="nt">&gt;</span>${imageStream}<span class="nt">&lt;/param&gt;</span>
   <span class="nt">&lt;param</span> <span class="na">name=</span><span class="s">"contentDisposition"</span><span class="nt">&gt;</span>attachment;filename="document.pdf"<span class="nt">&lt;/param&gt;</span>
   <span class="nt">&lt;param</span> <span class="na">name=</span><span class="s">"bufferSize"</span><span class="nt">&gt;</span>1024<span class="nt">&lt;/param&gt;</span>
 <span class="nt">&lt;/result&gt;</span>
 </code></pre></div></div>

   </section>
 </article>


 <footer class="container">
   <div class="col-md-12">
     Copyright &copy; 2000-2018 <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>


 </body>
 </html>
	<!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>Stream 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="//code.jquery.com/jquery-1.11.0.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="/download.cgi">Download</a></li>
	<li><a href="/releases.html">Releases</a></li>
	<li><a href="/announce.html">Announcements</a></li>
	<li><a href="http://www.apache.org/licenses/">License</a></li>
	<li><a href="https://www.apache.org/foundation/thanks.html">Thanks!</a></li>
	<li><a href="https://www.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="https://cwiki.apache.org/confluence/display/WW/Migration+Guide">Version Notes</a></li>
	<li><a href="https://cwiki.apache.org/confluence/display/WW/Security+Bulletins">Security Bulletins</a></li>
	<li class="divider"></li>
	<li><a href="/maven/project-info.html">Maven 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="/security/">Security Guide</a></li>
	<li><a href="/core-developers/">Core Developers Guide</a></li>
	<li><a href="/tag-developers/">Tag Developers Guide</a></li>
	<li><a href="/maven-archetypes/">Maven Archetypes</a></li>
	<li><a href="/plugins/">Plugins</a></li>
	<li><a href="/maven/struts2-core/apidocs/index.html">Struts Core API</a></li>
	<li><a href="/tag-developers/tag-reference.html">Tag reference</a></li>
	<li><a href="https://cwiki.apache.org/confluence/display/WW/FAQs">FAQs</a></li>
	<li><a href="http://cwiki.apache.org/S2PLUGINS/home.html">Plugin registry</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><a href="/contributors/">Contributors Guide</a></li>
	<li class="divider"></li>
	<li><a href="/submitting-patches.html">Submitting patches</a></li>
	<li><a href="/builds.html">Source Code and Builds</a></li>
	<li><a href="/coding-standards.html">Coding standards</a></li>
	<li><a href="https://cwiki.apache.org/confluence/display/WW/Contributors+Guide">Contributors Guide</a></li>
	<li class="divider"></li>
	<li><a href="/release-guidelines.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://gitbox.apache.org/repos/asf?p=struts.git">Source Repository</a></li>
	<li><a href="/updating-website.html">Updating the website</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 class="edit-on-gh" href="https://github.com/apache/struts-site/edit/master/source/core-developers/stream-result.md" title="Edit this page on GitHub">Edit on GitHub</a>

	<a href="index.html" title="back to Core Developers Guide"><< back to Core Developers Guide</a>

	<h1 id="stream-result">Stream Result</h1>

	<p>A custom Result type for sending raw data (via an InputStream) directly to the HttpServletResponse. Very useful for
	allowing users to download content. If you are running your app server under HTTPS and having issues with PDF’s or other
	file streams you should take a look at <a href="https-and-ie-issues.html">HTTPS and IE Issues</a></p>

	<h2 id="parameters">Parameters</h2>

	<ul>
	<li><code class="highlighter-rouge">contentType</code> - the stream mime-type as sent to the web browser (default = <code class="highlighter-rouge">text/plain</code>).</li>
	<li><code class="highlighter-rouge">contentLength</code> - the stream length in bytes (the browser displays a progress bar).</li>
	<li><code class="highlighter-rouge">contentDisposition</code> - the content disposition header value for specifying the file name (default = <code class="highlighter-rouge">inline</code>, values
	are typically <code class="highlighter-rouge">attachment;filename="document.pdf"</code>.</li>
	<li><code class="highlighter-rouge">inputName</code> - the name of the InputStream property from the chained action (default = <code class="highlighter-rouge">inputStream</code>).</li>
	<li><code class="highlighter-rouge">bufferSize</code> - the size of the buffer to copy from input to output (default = <code class="highlighter-rouge">1024</code>).</li>
	<li><code class="highlighter-rouge">allowCaching</code> - if set to ‘false’ it will set the headers <code class="highlighter-rouge">Pragma</code> and <code class="highlighter-rouge">Cache-Control</code> to <code class="highlighter-rouge">no-cahce</code>, and prevent
	client from caching the content (default = <code class="highlighter-rouge">true</code>).</li>
	<li><code class="highlighter-rouge">contentCharSet</code> - if set to a string, ‘;charset=value’ will be added to the content-type header, where value is the string
	set. If set to an expression, the result of evaluating the expression will be used. If not set, then no charset will
	be set on the header</li>
	</ul>

	<p>These parameters can also be set by exposing a similarly named getter method on your Action. For example, you can provide
	<code class="highlighter-rouge">getContentType()</code> to override that parameter for the current action. To do it you you must explicitly define this param
	as an expression i.e. <code class="highlighter-rouge"><param name="contentType">${contentType}</param></code></p>

	<p class="alert alert-success">Please be aware that this was changed since Struts 2.5.2, previously each parameter was automatically resolved by looking
	throughout the <code class="highlighter-rouge">ValueStack</code>, now you must explicitly define which parameter must be evaluated, even <code class="highlighter-rouge">inputName</code>.</p>

	<h2 id="examples">Examples</h2>

	<h3 id="annotation-based-configuration">Annotation based Configuration</h3>

	<p>To configure Actions and Results with Annotations you need to activate the Struts2 <a href="../plugins/convention/">Convention Plugin</a>
	in your Struts2 application.</p>

	<div class="language-java highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kn">package</span> <span class="n">com</span><span class="o">.</span><span class="na">mycompany</span><span class="o">.</span><span class="na">webapp</span><span class="o">.</span><span class="na">actions</span><span class="o">;</span>

	<span class="kn">import</span> <span class="nn">java.io.File</span><span class="o">;</span>
	<span class="kn">import</span> <span class="nn">java.io.FileInputStream</span><span class="o">;</span>
	<span class="kn">import</span> <span class="nn">java.io.InputStream</span><span class="o">;</span>

	<span class="kn">import</span> <span class="nn">org.apache.struts2.convention.annotation.Result</span><span class="o">;</span>

	<span class="kn">import</span> <span class="nn">com.opensymphony.xwork2.Action</span><span class="o">;</span>
	<span class="kn">import</span> <span class="nn">com.opensymphony.xwork2.ActionSupport</span><span class="o">;</span>

	<span class="nd">@Result</span><span class="o">(</span>
	<span class="n">name</span> <span class="o">=</span> <span class="s">"success"</span><span class="o">,</span>
	<span class="n">type</span> <span class="o">=</span> <span class="s">"stream"</span><span class="o">,</span>
	<span class="n">params</span> <span class="o">=</span> <span class="o">{</span>
	<span class="s">"contentType"</span><span class="o">,</span> <span class="s">"${type}"</span><span class="o">,</span>
	<span class="s">"inputName"</span><span class="o">,</span> <span class="s">"${stream}"</span><span class="o">,</span>
	<span class="s">"bufferSize"</span><span class="o">,</span> <span class="s">"1024"</span><span class="o">,</span>
	<span class="s">"contentDisposition"</span><span class="o">,</span> <span class="s">"attachment;filename=\"${filename}\""</span>
	<span class="o">}</span>
	<span class="o">)</span>
	<span class="kd">public</span> <span class="kd">class</span> <span class="nc">FileDisplay</span> <span class="kd">extends</span> <span class="n">ActionSupport</span> <span class="o">{</span>

	<span class="kd">private</span> <span class="n">String</span> <span class="n">type</span> <span class="o">=</span> <span class="s">"image/jpeg"</span><span class="o">;</span>
	<span class="kd">private</span> <span class="n">String</span> <span class="n">filename</span><span class="o">;</span>
	<span class="kd">private</span> <span class="n">InputStream</span> <span class="n">stream</span><span class="o">;</span>

	<span class="kd">public</span> <span class="n">String</span> <span class="nf">execute</span><span class="o">()</span> <span class="kd">throws</span> <span class="n">Exception</span> <span class="o">{</span>

	<span class="n">filename</span> <span class="o">=</span> <span class="s">"myimage.jpg"</span><span class="o">;</span>
	<span class="n">File</span> <span class="n">img</span> <span class="o">=</span> <span class="k">new</span> <span class="n">File</span><span class="o">(</span><span class="s">"/path/to/image/image.jpg"</span><span class="o">);</span>
	<span class="n">stream</span> <span class="o">=</span> <span class="k">new</span> <span class="n">FileInputStream</span><span class="o">(</span><span class="n">img</span><span class="o">);</span>

	<span class="k">return</span> <span class="n">Action</span><span class="o">.</span><span class="na">SUCCESS</span><span class="o">;</span>
	<span class="o">}</span>

	<span class="kd">private</span> <span class="n">String</span> <span class="nf">getType</span><span class="o">()</span> <span class="o">{</span>
	<span class="k">return</span> <span class="k">this</span><span class="o">.</span><span class="na">type</span><span class="o">;</span>
	<span class="o">}</span>

	<span class="kd">private</span> <span class="n">String</span> <span class="nf">getFilename</span><span class="o">()</span> <span class="o">{</span>
	<span class="k">return</span> <span class="k">this</span><span class="o">.</span><span class="na">filename</span><span class="o">;</span>
	<span class="o">}</span>

	<span class="kd">private</span> <span class="n">String</span> <span class="nf">getStream</span><span class="o">()</span> <span class="o">{</span>
	<span class="k">return</span> <span class="k">this</span><span class="o">.</span><span class="na">stream</span><span class="o">;</span>
	<span class="o">}</span>
	<span class="o">}</span>
	</code></pre></div></div>

	<h3 id="xml-based-configuration">XML based Configuration</h3>

	<div class="language-xml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nt"><result</span> <span class="na">name=</span><span class="s">"success"</span> <span class="na">type=</span><span class="s">"stream"</span><span class="nt">></span>
	<span class="nt"><param</span> <span class="na">name=</span><span class="s">"contentType"</span><span class="nt">></span>image/jpeg<span class="nt"></param></span>
	<span class="nt"><param</span> <span class="na">name=</span><span class="s">"inputName"</span><span class="nt">></span>${imageStream}<span class="nt"></param></span>
	<span class="nt"><param</span> <span class="na">name=</span><span class="s">"contentDisposition"</span><span class="nt">></span>attachment;filename="document.pdf"<span class="nt"></param></span>
	<span class="nt"><param</span> <span class="na">name=</span><span class="s">"bufferSize"</span><span class="nt">></span>1024<span class="nt"></param></span>
	<span class="nt"></result></span>
	</code></pre></div></div>

	</section>
	</article>


	<footer class="container">
	<div class="col-md-12">
	Copyright © 2000-2018 <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>


	</body>
	</html>