org.eclipse.jetty.rewrite.handler

## Class HeaderPatternRule

- java.lang.Object
- - org.eclipse.jetty.rewrite.handler.Rule
  - - org.eclipse.jetty.rewrite.handler.PatternRule
    - - org.eclipse.jetty.rewrite.handler.HeaderPatternRule

-     public class HeaderPatternRule
      extends PatternRule

  Sets the header in the response whenever the rule finds a match.

- - ### Nested Class Summary

    - ### Nested classes/interfaces inherited from class org.eclipse.jetty.rewrite.handler.Rule

      `Rule.ApplyURI`

  - ### Field Summary

    - ### Fields inherited from class org.eclipse.jetty.rewrite.handler.PatternRule

      `_pattern`

    - ### Fields inherited from class org.eclipse.jetty.rewrite.handler.Rule

      `_handling, _terminating`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `HeaderPatternRule()`

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `String` | `apply(String target, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)` Invokes this method when a match found.
    `String` | `getName()` Returns the header name.
    `String` | `getValue()` Returns the header value.
    `boolean` | `isAdd()` Returns the add flag value.
    `void` | `setAdd(boolean add)` Sets the Add flag.
    `void` | `setName(String name)` Sets the header name.
    `void` | `setValue(String value)` Sets the header value.
    `String` | `toString()` Returns the header contents.

    - ### Methods inherited from class org.eclipse.jetty.rewrite.handler.PatternRule

      `getPattern, matchAndApply, setPattern`

    - ### Methods inherited from class org.eclipse.jetty.rewrite.handler.Rule

      `isHandling, isTerminating, setHandling, setTerminating`

    - ### Methods inherited from class java.lang.Object

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

- - ### Constructor Detail

    - #### HeaderPatternRule

          public HeaderPatternRule()

  - ### Method Detail

    - #### setName

          public void setName(String name)

      Sets the header name.
      Parameters:
        `name` - name of the header field

    - #### setValue

          public void setValue(String value)

      Sets the header value. The value can be either a `String` or `int` value.
      Parameters:
        `value` - of the header field

    - #### setAdd

          public void setAdd(boolean add)

      Sets the Add flag.
      Parameters:
        `add` - If true, the header is added to the response, otherwise the header it is set on the response.

    - #### apply

          public String apply(String target,
                     javax.servlet.http.HttpServletRequest request,
                     javax.servlet.http.HttpServletResponse response)
                       throws IOException

      Invokes this method when a match found. If the header had already been set, the new value overwrites the previous one. Otherwise, it adds the new header name and value.
      Specified by:
        `apply` in class `PatternRule`
      Parameters:
        `target` - field to attempt match
        `request` - request object
        `response` - response object
      Returns:
        The target (possible updated)
      Throws:
        `IOException` - exceptions dealing with operating on request or response objects
      See Also:
        `Rule.matchAndApply(String, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)`

    - #### getName

          public String getName()

      Returns the header name.
      Returns:
        the header name.

    - #### getValue

          public String getValue()

      Returns the header value.
      Returns:
        the header value.

    - #### isAdd

          public boolean isAdd()

      Returns the add flag value.

    - #### toString

          public String toString()

      Returns the header contents.
      Overrides:
        `toString` in class `PatternRule`

Copyright © 1995-2016 Mort Bay Consulting. All Rights Reserved.