com.opensymphony.webwork.dispatcher
Class HttpHeaderResult
java.lang.Object
com.opensymphony.webwork.dispatcher.WebWorkResultSupport
com.opensymphony.webwork.views.AbstractHttpHeaderPopulatingResult
com.opensymphony.webwork.dispatcher.HttpHeaderResult
- All Implemented Interfaces:
- WebWorkStatics, Result, Serializable
public class HttpHeaderResult
- extends AbstractHttpHeaderPopulatingResult
A custom Result type for evaluating HTTP headers 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>
- Version:
- $Date: 2007-11-30 18:45:26 +0800 (Fri, 30 Nov 2007) $ $Id: HttpHeaderResult.java 2977 2007-11-30 10:45:26Z tm_jee $
- Author:
- Jason Carreira, tmjee
- See Also:
- Serialized Form
Method Summary |
protected void |
afterHttpHeadersPopulatedExecute(String finalLocation,
ActionInvocation invocation)
Sets the optional HTTP response status code and also re-sets HTTP headers after they've
been optionally evaluated against the ValueStack. |
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 |
DEFAULT_PARAM
public static final String DEFAULT_PARAM
- See Also:
- Constant Field Values
HttpHeaderResult
public HttpHeaderResult()
setParse
public void setParse(boolean parse)
- Sets whether or not the HTTP header values should be evaluated against the ValueStack (by default they are).
- Overrides:
setParse
in class WebWorkResultSupport
- 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)
afterHttpHeadersPopulatedExecute
protected void afterHttpHeadersPopulatedExecute(String finalLocation,
ActionInvocation invocation)
throws 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:
afterHttpHeadersPopulatedExecute
in class AbstractHttpHeaderPopulatingResult
- Parameters:
finalLocation
- invocation
- an encapsulation of the action execution state.
- Throws:
Exception
- if an error occurs when re-setting the headers.