Package org.eclipse.jetty.rewrite.handler

Class HeaderRegexRule

  • public class HeaderRegexRule
extends RegexRule
    Rule to add a header based on a Regex match

    • Nested Class Summary

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

        Rule.ApplyURI

    • Constructor Summary

      Constructors 
      Constructor Description
      HeaderRegexRule()  
      HeaderRegexRule​(java.lang.String regex, java.lang.String name, java.lang.String value)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected java.lang.String apply​(java.lang.String target, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, java.util.regex.Matcher matcher)
      Apply this rule to the request/response pair.
      java.lang.String getName()
      Returns the header name.
      java.lang.String getValue()
      Returns the header value.
      boolean isAdd()  
      void setAdd​(boolean add)
      Sets the Add flag.
      void setName​(java.lang.String name)
      Sets the header name.
      void setValue​(java.lang.String value)
      Sets the header value.
      java.lang.String toString()
      Returns the regular expression string.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • HeaderRegexRule

        public HeaderRegexRule()

      • HeaderRegexRule

        public HeaderRegexRule​(@Name("regex")
                       java.lang.String regex,
                       @Name("name")
                       java.lang.String name,
                       @Name("value")
                       java.lang.String value)

    • Method Detail

      • setName

        public void setName​(java.lang.String name)
        Sets the header name.
        Parameters:
        name - name of the header field

      • setValue

        public void setValue​(java.lang.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

        protected java.lang.String apply​(java.lang.String target,
                                 javax.servlet.http.HttpServletRequest request,
                                 javax.servlet.http.HttpServletResponse response,
                                 java.util.regex.Matcher matcher)
                          throws java.io.IOException
        Description copied from class: RegexRule
        Apply this rule to the request/response pair. Called by RegexRule.matchAndApply(String, HttpServletRequest, HttpServletResponse) if the regex matches.
        Specified by:
        apply in class RegexRule
        Parameters:
        target - field to attempt match
        request - request object
        response - response object
        matcher - The Regex matcher that matched the request (with capture groups available for replacement).
        Returns:
        The target (possible updated).
        Throws:
        java.io.IOException - exceptions dealing with operating on request or response objects

      • getName

        public java.lang.String getName()
        Returns the header name.
        Returns:
        the header name.

      • getValue

        public java.lang.String getValue()
        Returns the header value.
        Returns:
        the header value.

      • isAdd

        public boolean isAdd()
        Returns:
        the add flag value.

      • toString

        public java.lang.String toString()
        Description copied from class: RegexRule
        Returns the regular expression string.
        Overrides:
        toString in class RegexRule
        Returns:
        the header contents.