org.apache.struts2.dispatcher
Class HttpHeaderResult

java.lang.Object
  org.apache.struts2.dispatcher.HttpHeaderResult

All Implemented Interfaces:

com.opensymphony.xwork2.Result, java.io.Serializable

public class HttpHeaderResult
extends java.lang.Object
implements com.opensymphony.xwork2.Result

A custom Result type for setting HTTP headers and status by optionally evaluating against the ValueStack.

This result type takes the following parameters:

• status - the http servlet response status code that should be set on a response.
• parse - true by default. If set to false, the headers param will not be parsed for Ognl expressions.
• headers - header values.

Example:

 <result name="success" type="httpheader">
   <param name="status">204</param>
   <param name="headers.a">a custom header value</param>
   <param name="headers.b">another custom header value</param>
 </result>
 

See Also:

Serialized Form

Field Summary

static java.lang.String

DEFAULT_PARAM The default parameter

Constructor Summary

HttpHeaderResult()

Method Summary

void	execute(com.opensymphony.xwork2.ActionInvocation invocation) Sets the optional HTTP response status code and also re-sets HTTP headers after they've been optionally evaluated against the ValueStack.
java.util.Map	getHeaders() Returns a Map of all HTTP headers.
void	setParse(boolean parse) Sets whether or not the HTTP header values should be evaluated against the ValueStack (by default they are).
void	setStatus(int status) Sets the http servlet response status code that should be set on a response.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_PARAM

public static final java.lang.String DEFAULT_PARAM

The default parameter

See Also:

Constant Field Values

Constructor Detail

HttpHeaderResult

public HttpHeaderResult()

Method Detail

getHeaders

public java.util.Map getHeaders()

Returns a Map of all HTTP headers.

Returns:

a Map of all HTTP headers.

setParse

public void setParse(boolean parse)

Sets whether or not the HTTP header values should be evaluated against the ValueStack (by default they are).

Parameters:

parse - true if HTTP header values should be evaluated agains the ValueStack, false otherwise.

setStatus

public void setStatus(int status)

Sets the http servlet response status code that should be set on a response.

Parameters:

status - the Http status code

See Also:

HttpServletResponse.setStatus(int)

execute

public void execute(com.opensymphony.xwork2.ActionInvocation invocation)
             throws java.lang.Exception

Sets the optional HTTP response status code and also re-sets HTTP headers after they've been optionally evaluated against the ValueStack.

Specified by:

execute in interface com.opensymphony.xwork2.Result

Parameters:

invocation - an encapsulation of the action execution state.

Throws:

java.lang.Exception - if an error occurs when re-setting the headers.