com.opensymphony.webwork.dispatcher
Class StreamResult

java.lang.Object
  extended by com.opensymphony.webwork.dispatcher.WebWorkResultSupport
      extended by com.opensymphony.webwork.dispatcher.StreamResult
All Implemented Interfaces:
WebWorkStatics, Result, Serializable

public class StreamResult
extends WebWorkResultSupport

A custom Result type for send raw data (via an InputStream) directly to the HttpServletResponse. Very useful for allowing users to download content.

This result type takes the following parameters:

Example:

 <result name="success" type="stream">
   <param name="contentType">image/jpeg</param>
   <param name="inputName">imageStream</param>
   <param name="contentDisposition">filename="document.pdf"</param>
   <param name="bufferSize">1024</param>
 </result>
 

Author:
mcrawford, Rainer Hermanns, tm_jee
See Also:
Serialized Form

Field Summary
protected  int bufferSize
           
protected  String contentDisposition
           
protected  String contentLength
           
protected  String contentType
           
protected  String inputName
           
protected static org.apache.commons.logging.Log log
           
 
Fields inherited from class com.opensymphony.webwork.dispatcher.WebWorkResultSupport
DEFAULT_PARAM, encode, location, parse
 
Fields inherited from interface com.opensymphony.webwork.WebWorkStatics
HTTP_REQUEST, HTTP_RESPONSE, PAGE_CONTEXT, SERVLET_CONTEXT, SERVLET_DISPATCHER
 
Constructor Summary
StreamResult()
           
 
Method Summary
protected  void doExecute(String finalLocation, ActionInvocation invocation)
          Executes the result given a final location (jsp page, action, etc) and the action invocation (the state in which the action was executed).
 int getBufferSize()
           
 String getContentDisposition()
           
 String getContentLength()
           
 String getContentType()
           
 String getInputName()
           
 void setBufferSize(int bufferSize)
           
 void setContentDisposition(String contentDisposition)
           
 void setContentLength(String contentLength)
           
 void setContentType(String contentType)
           
 void setInputName(String inputName)
           
 
Methods inherited from class com.opensymphony.webwork.dispatcher.WebWorkResultSupport
conditionalParse, execute, setEncode, setLocation, setParse
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

log

protected static final org.apache.commons.logging.Log log

contentType

protected String contentType

contentLength

protected String contentLength

contentDisposition

protected String contentDisposition

inputName

protected String inputName

bufferSize

protected int bufferSize
Constructor Detail

StreamResult

public StreamResult()
Method Detail

getBufferSize

public int getBufferSize()
Returns:
Returns the bufferSize.

setBufferSize

public void setBufferSize(int bufferSize)
Parameters:
bufferSize - The bufferSize to set.

getContentType

public String getContentType()
Returns:
Returns the contentType.

setContentType

public void setContentType(String contentType)
Parameters:
contentType - The contentType to set.

getContentLength

public String getContentLength()
Returns:
Returns the contentLength.

setContentLength

public void setContentLength(String contentLength)
Parameters:
contentLength - The contentLength to set.

getContentDisposition

public String getContentDisposition()
Returns:
Returns the Content-disposition header value.

setContentDisposition

public void setContentDisposition(String contentDisposition)
Parameters:
contentDisposition - the Content-disposition header value to use.

getInputName

public String getInputName()
Returns:
Returns the inputName.

setInputName

public void setInputName(String inputName)
Parameters:
inputName - The inputName to set.

doExecute

protected void doExecute(String finalLocation,
                         ActionInvocation invocation)
                  throws Exception
Description copied from class: WebWorkResultSupport
Executes the result given a final location (jsp page, action, etc) and the action invocation (the state in which the action was executed). Subclasses must implement this class to handle custom logic for result handling.

Specified by:
doExecute in class WebWorkResultSupport
Parameters:
finalLocation - the location (jsp page, action, etc) to go to.
invocation - the execution state of the action.
Throws:
Exception - if an error occurs while executing the result.

WebWork Project Page