001/*
002 * Copyright 2012 Atteo.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *      http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016package org.atteo.moonshine.jetty.rewriterules;
017
018import javax.xml.bind.annotation.XmlElement;
019import javax.xml.bind.annotation.XmlRootElement;
020
021import org.eclipse.jetty.rewrite.handler.RewriteRegexRule;
022import org.eclipse.jetty.rewrite.handler.Rule;
023
024/**
025 * Rewrite the URI by matching with a regular expression.
026 *
027 * <p>
028 * The replacement string may use $n" to replace the nth capture group.
029 * If the replacement string contains ? character, then it is split
030 * into a path and query string component. The replacement query string
031 * may also contain $Q, which is replaced with the original query string.
032 * The returned target contains only the path.
033 * </p>
034 */
035@XmlRootElement(name = "rewriteRegex")
036public class RewriteRegexRuleConfig extends RuleConfig {
037    @XmlElement(required = true)
038    private String regex;
039
040    @XmlElement(required = true)
041    private String replacement;
042
043    @Override
044    public Rule getRule() {
045        RewriteRegexRule rule = new RewriteRegexRule();
046        rule.setRegex(regex);
047        rule.setReplacement(replacement);
048
049        return rule;
050    }
051}