Class RedirectRegexRule

  • public class RedirectRegexRule
    extends RegexRule
    Issues a (3xx) Redirect response whenever the rule finds a match via regular expression.

    The replacement string may use $n" to replace the nth capture group.

    All redirects are part of the 3xx Redirection status code set.

    Defaults to 302 Found

    • Field Detail

      • _location

        protected java.lang.String _location
    • Constructor Detail

      • RedirectRegexRule

        public RedirectRegexRule()
      • RedirectRegexRule

        public RedirectRegexRule​(@Name("regex")
                                 java.lang.String regex,
                                 java.lang.String location)
    • Method Detail

      • setReplacement

        public void setReplacement​(java.lang.String replacement)
        use setLocation(String) instead.
        replacement - the URI to redirect to
      • setLocation

        public void setLocation​(java.lang.String location)
        Sets the redirect location.
        location - the URI to redirect to
      • setStatusCode

        public void setStatusCode​(int statusCode)
        Sets the redirect status code.
        statusCode - the 3xx redirect status code
      • 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)
        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).
        Throws: - exceptions dealing with operating on request or response objects
      • toString

        public java.lang.String toString()
        Returns the redirect status code and replacement.
        toString in class RegexRule