Class RewriteRegexRule

All Implemented Interfaces:

public class RewriteRegexRule extends RegexRule implements Rule.ApplyURI
Rewrite the URI by matching with a regular expression. The replacement string may use $n" to replace the nth capture group. If the replacement string contains ? character, then it is split into a path and query string component. The replacement query string may also contain $Q, which is replaced with the original query string. The returned target contains only the path.
  • Constructor Details

    • RewriteRegexRule

      public RewriteRegexRule()
    • RewriteRegexRule

      public RewriteRegexRule(@Name("regex") String regex, @Name("replacement") String replacement)
  • Method Details

    • setReplacement

      public void setReplacement(String replacement)
      Whenever a match is found, it replaces with this value.
      replacement - the replacement string.
    • apply

      public String apply(String target, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, Matcher matcher) throws 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
      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).
      The target (possible updated).
      IOException - exceptions dealing with operating on request or response objects
    • applyURI

      public void applyURI(Request request, String oldURI, String newURI) throws IOException
      Specified by:
      applyURI in interface Rule.ApplyURI
    • toString

      public String toString()
      Returns the replacement string.
      toString in class RegexRule