Child pages
  • Stream Result
Skip to end of metadata
Go to start of metadata

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 HTTPS and IE Issues

Parameters

  • contentType - the stream mime-type as sent to the web browser (default = text/plain).
  • contentLength - the stream length in bytes (the browser displays a progress bar).
  • contentDisposition - the content disposition header value for specifying the file name (default = inline, values are typically attachment;filename="document.pdf".
  • inputName - the name of the InputStream property from the chained action (default = inputStream).
  • bufferSize - the size of the buffer to copy from input to output (default = 1024).
  • allowCaching - if set to 'false' it will set the headers Pragma and Cache-Control to no-cahce, and prevent client from caching the content (default = true).
  • contentCharSet - 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

These parameters can also be set by exposing a similarly named getter method on your Action. For example, you can provide getContentType() to override that parameter for the current action. To do it you you must explicitly define this param as an expression i.e.

xmlparameter defined as an expression${contentType}]]>

Please be aware that this was changed since Struts 2.5.2, previously each parameter was automagically resolved by looking throughout the ValueStack, now you must explicitly define wich parameter must be evaluated, even inputName.

Examples

Annotation based Configuration

To configure Actions and Results with Annotations you need to activate the Struts2 Convention Plugin in your Struts2 application.

java

XML based Configuration

javaExample configuration image/jpeg ${imageStream} attachment;filename="document.pdf" 1024 ]]>

2 Comments

  1. This page (and the Javadoc) should mention that the InputStream used will be closed by this Result.