Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.apache.struts2.dispatcher
Class HttpHeaderResult

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

All Implemented Interfaces:
  Result, Serializable

    public class HttpHeaderResult

extends Object
implements 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 String` | `DEFAULT_PARAM` The default parameter
`private Map<String,String>` | `headers`
`private boolean` | `parse`
`private static long` | `serialVersionUID`
`private int` | `status`

Constructor Summary
`HttpHeaderResult()`
`HttpHeaderResult(int status)`

Method Summary
`void` | `addHeader(String name, String value)` Adds an HTTP header to the response
`void` | `execute(ActionInvocation invocation)` Sets the optional HTTP response status code and also re-sets HTTP headers after they've been optionally evaluated against the ValueStack.
`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

### serialVersionUID

    private static final long serialVersionUID

See Also:
  Constant Field Values

### DEFAULT_PARAM

    public static final String DEFAULT_PARAM

  The default parameter

  See Also:
    Constant Field Values

### parse

    private boolean parse

### headers

    private Map<String,String> headers

### status

    private int status

Constructor Detail

### HttpHeaderResult

    public HttpHeaderResult()

### HttpHeaderResult

    public HttpHeaderResult(int status)

Method Detail

### getHeaders

    public 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)`

### addHeader

    public void addHeader(String name,
                          String value)

  Adds an HTTP header to the response

  Parameters:
    `name` -
    `value` -

### execute

    public void execute(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:
    `execute` in interface `Result`
  Parameters:
    `invocation` - an encapsulation of the action execution state.
  Throws:
    `Exception` - if an error occurs when re-setting the headers.

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.