Google Git
Sign in
eclipse / www.eclipse.org / jetty / 244b31480d88c4c2e783a862c86c320807c66eb3 / . / javadoc / 9.4.34.v20201102 / org / eclipse / jetty / rewrite / handler / RuleContainer.html
blob: 9d4febaf4fccddd1701609344cd8c5546ad0b98f [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.9) on Wed Nov 04 12:15:18 CST 2020 -->
<title>RuleContainer (Jetty :: Project 9.4.34.v20201102 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2020-11-04">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../../jquery/jquery-3.5.1.js"></script>
<script type="text/javascript" src="../../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="RuleContainer (Jetty :: Project 9.4.34.v20201102 API)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../../";
var useModuleDirectories = false;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/RuleContainer.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.eclipse.jetty.rewrite.handler</a></div>
<h2 title="Class RuleContainer" class="title">Class RuleContainer</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="Rule.html" title="class in org.eclipse.jetty.rewrite.handler">org.eclipse.jetty.rewrite.handler.Rule</a></li>
<li>
<ul class="inheritance">
<li>org.eclipse.jetty.rewrite.handler.RuleContainer</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="../../util/component/Dumpable.html" title="interface in org.eclipse.jetty.util.component">Dumpable</a></code></dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><code><a href="../RewriteCustomizer.html" title="class in org.eclipse.jetty.rewrite">RewriteCustomizer</a></code>, <code><a href="VirtualHostRuleContainer.html" title="class in org.eclipse.jetty.rewrite.handler">VirtualHostRuleContainer</a></code></dd>
</dl>
<hr>
<pre>public class <span class="typeNameLabel">RuleContainer</span>
extends <a href="Rule.html" title="class in org.eclipse.jetty.rewrite.handler">Rule</a>
implements <a href="../../util/component/Dumpable.html" title="interface in org.eclipse.jetty.util.component">Dumpable</a></pre>
<div class="block">Base container to group rules. Can be extended so that the contained rules
will only be applied under certain conditions</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<ul class="blockList">
<li class="blockList"><a id="nested.classes.inherited.from.class.org.eclipse.jetty.rewrite.handler.Rule">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from class&nbsp;org.eclipse.jetty.rewrite.handler.<a href="Rule.html" title="class in org.eclipse.jetty.rewrite.handler">Rule</a></h3>
<code><a href="Rule.ApplyURI.html" title="interface in org.eclipse.jetty.rewrite.handler">Rule.ApplyURI</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="nested.classes.inherited.from.class.org.eclipse.jetty.util.component.Dumpable">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from interface&nbsp;org.eclipse.jetty.util.component.<a href="../../util/component/Dumpable.html" title="interface in org.eclipse.jetty.util.component">Dumpable</a></h3>
<code><a href="../../util/component/Dumpable.DumpableContainer.html" title="interface in org.eclipse.jetty.util.component">Dumpable.DumpableContainer</a></code></li>
</ul>
</li>
</ul>
</section>
<!-- =========== FIELD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Field</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#_originalPathAttribute">_originalPathAttribute</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#_originalQueryStringAttribute">_originalQueryStringAttribute</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#_rewritePathInfo">_rewritePathInfo</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#_rewriteRequestURI">_rewriteRequestURI</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="Rule.html" title="class in org.eclipse.jetty.rewrite.handler">Rule</a>[]</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#_rules">_rules</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#ORIGINAL_QUERYSTRING_ATTRIBUTE_SUFFIX">ORIGINAL_QUERYSTRING_ATTRIBUTE_SUFFIX</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="fields.inherited.from.class.org.eclipse.jetty.rewrite.handler.Rule">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.eclipse.jetty.rewrite.handler.<a href="Rule.html" title="class in org.eclipse.jetty.rewrite.handler">Rule</a></h3>
<code><a href="Rule.html#_handling">_handling</a>, <a href="Rule.html#_terminating">_terminating</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="fields.inherited.from.class.org.eclipse.jetty.util.component.Dumpable">
<!-- -->
</a>
<h3>Fields inherited from interface&nbsp;org.eclipse.jetty.util.component.<a href="../../util/component/Dumpable.html" title="interface in org.eclipse.jetty.util.component">Dumpable</a></h3>
<code><a href="../../util/component/Dumpable.html#KEY">KEY</a></code></li>
</ul>
</li>
</ul>
</section>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">RuleContainer</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addRule(org.eclipse.jetty.rewrite.handler.Rule)">addRule</a></span>&#8203;(<a href="Rule.html" title="class in org.eclipse.jetty.rewrite.handler">Rule</a>&nbsp;rule)</code></th>
<td class="colLast">
<div class="block">Add a Rule</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>protected java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#apply(java.lang.String,javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse)">apply</a></span>&#8203;(java.lang.String&nbsp;target,
javax.servlet.http.HttpServletRequest&nbsp;request,
javax.servlet.http.HttpServletResponse&nbsp;response)</code></th>
<td class="colLast">
<div class="block">Process the contained rules (called by matchAndApply)</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#dump(java.lang.Appendable,java.lang.String)">dump</a></span>&#8203;(java.lang.Appendable&nbsp;out,
java.lang.String&nbsp;indent)</code></th>
<td class="colLast">
<div class="block">Dump this object (and children) into an Appendable using the provided indent after any new lines.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getOriginalPathAttribute()">getOriginalPathAttribute</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="Rule.html" title="class in org.eclipse.jetty.rewrite.handler">Rule</a>[]</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRules()">getRules</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the list of rules.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isRewritePathInfo()">isRewritePathInfo</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isRewriteRequestURI()">isRewriteRequestURI</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#matchAndApply(java.lang.String,javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse)">matchAndApply</a></span>&#8203;(java.lang.String&nbsp;target,
javax.servlet.http.HttpServletRequest&nbsp;request,
javax.servlet.http.HttpServletResponse&nbsp;response)</code></th>
<td class="colLast">
<div class="block">Process the contained rules</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setOriginalPathAttribute(java.lang.String)">setOriginalPathAttribute</a></span>&#8203;(java.lang.String&nbsp;originalPathAttribte)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setRewritePathInfo(boolean)">setRewritePathInfo</a></span>&#8203;(boolean&nbsp;rewritePathInfo)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setRewriteRequestURI(boolean)">setRewriteRequestURI</a></span>&#8203;(boolean&nbsp;rewriteRequestURI)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setRules(org.eclipse.jetty.rewrite.handler.Rule%5B%5D)">setRules</a></span>&#8203;(<a href="Rule.html" title="class in org.eclipse.jetty.rewrite.handler">Rule</a>[]&nbsp;rules)</code></th>
<td class="colLast">
<div class="block">Assigns the rules to process.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.eclipse.jetty.rewrite.handler.Rule">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.eclipse.jetty.rewrite.handler.<a href="Rule.html" title="class in org.eclipse.jetty.rewrite.handler">Rule</a></h3>
<code><a href="Rule.html#isHandling()">isHandling</a>, <a href="Rule.html#isTerminating()">isTerminating</a>, <a href="Rule.html#setHandling(boolean)">setHandling</a>, <a href="Rule.html#setTerminating(boolean)">setTerminating</a>, <a href="Rule.html#toString()">toString</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.eclipse.jetty.util.component.Dumpable">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.eclipse.jetty.util.component.<a href="../../util/component/Dumpable.html" title="interface in org.eclipse.jetty.util.component">Dumpable</a></h3>
<code><a href="../../util/component/Dumpable.html#dump()">dump</a>, <a href="../../util/component/Dumpable.html#dumpSelf()">dumpSelf</a></code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a id="ORIGINAL_QUERYSTRING_ATTRIBUTE_SUFFIX">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ORIGINAL_QUERYSTRING_ATTRIBUTE_SUFFIX</h4>
<pre>public static final&nbsp;java.lang.String ORIGINAL_QUERYSTRING_ATTRIBUTE_SUFFIX</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.eclipse.jetty.rewrite.handler.RuleContainer.ORIGINAL_QUERYSTRING_ATTRIBUTE_SUFFIX">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="_rules">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>_rules</h4>
<pre>protected&nbsp;<a href="Rule.html" title="class in org.eclipse.jetty.rewrite.handler">Rule</a>[] _rules</pre>
</li>
</ul>
<a id="_originalPathAttribute">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>_originalPathAttribute</h4>
<pre>protected&nbsp;java.lang.String _originalPathAttribute</pre>
</li>
</ul>
<a id="_originalQueryStringAttribute">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>_originalQueryStringAttribute</h4>
<pre>protected&nbsp;java.lang.String _originalQueryStringAttribute</pre>
</li>
</ul>
<a id="_rewriteRequestURI">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>_rewriteRequestURI</h4>
<pre>protected&nbsp;boolean _rewriteRequestURI</pre>
</li>
</ul>
<a id="_rewritePathInfo">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>_rewritePathInfo</h4>
<pre>protected&nbsp;boolean _rewritePathInfo</pre>
</li>
</ul>
</li>
</ul>
</section>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>RuleContainer</h4>
<pre>public&nbsp;RuleContainer()</pre>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="getRules()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRules</h4>
<pre class="methodSignature">public&nbsp;<a href="Rule.html" title="class in org.eclipse.jetty.rewrite.handler">Rule</a>[]&nbsp;getRules()</pre>
<div class="block">Returns the list of rules.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an array of <a href="Rule.html" title="class in org.eclipse.jetty.rewrite.handler"><code>Rule</code></a>.</dd>
</dl>
</li>
</ul>
<a id="setRules(org.eclipse.jetty.rewrite.handler.Rule[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setRules</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setRules&#8203;(<a href="Rule.html" title="class in org.eclipse.jetty.rewrite.handler">Rule</a>[]&nbsp;rules)</pre>
<div class="block">Assigns the rules to process.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>rules</code> - an array of <a href="Rule.html" title="class in org.eclipse.jetty.rewrite.handler"><code>Rule</code></a>.</dd>
</dl>
</li>
</ul>
<a id="addRule(org.eclipse.jetty.rewrite.handler.Rule)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addRule</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;addRule&#8203;(<a href="Rule.html" title="class in org.eclipse.jetty.rewrite.handler">Rule</a>&nbsp;rule)</pre>
<div class="block">Add a Rule</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>rule</code> - The rule to add to the end of the rules array</dd>
</dl>
</li>
</ul>
<a id="isRewriteRequestURI()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isRewriteRequestURI</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isRewriteRequestURI()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the rewriteRequestURI If true, this handler will rewrite the value
returned by <code>HttpServletRequest.getRequestURI()</code>.</dd>
</dl>
</li>
</ul>
<a id="setRewriteRequestURI(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setRewriteRequestURI</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setRewriteRequestURI&#8203;(boolean&nbsp;rewriteRequestURI)</pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>rewriteRequestURI</code> - true if this handler will rewrite the value
returned by <code>HttpServletRequest.getRequestURI()</code>.</dd>
</dl>
</li>
</ul>
<a id="isRewritePathInfo()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isRewritePathInfo</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isRewritePathInfo()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if this handler will rewrite the value
returned by <code>HttpServletRequest.getPathInfo()</code>.</dd>
</dl>
</li>
</ul>
<a id="setRewritePathInfo(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setRewritePathInfo</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setRewritePathInfo&#8203;(boolean&nbsp;rewritePathInfo)</pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>rewritePathInfo</code> - true if this handler will rewrite the value
returned by <code>HttpServletRequest.getPathInfo()</code>.</dd>
</dl>
</li>
</ul>
<a id="getOriginalPathAttribute()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOriginalPathAttribute</h4>
<pre class="methodSignature">public&nbsp;java.lang.String&nbsp;getOriginalPathAttribute()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the originalPathAttribte. If non null, this string will be used
as the attribute name to store the original request path.</dd>
</dl>
</li>
</ul>
<a id="setOriginalPathAttribute(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setOriginalPathAttribute</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setOriginalPathAttribute&#8203;(java.lang.String&nbsp;originalPathAttribte)</pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>originalPathAttribte</code> - If non null, this string will be used
as the attribute name to store the original request path.</dd>
</dl>
</li>
</ul>
<a id="matchAndApply(java.lang.String,javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>matchAndApply</h4>
<pre class="methodSignature">public&nbsp;java.lang.String&nbsp;matchAndApply&#8203;(java.lang.String&nbsp;target,
javax.servlet.http.HttpServletRequest&nbsp;request,
javax.servlet.http.HttpServletResponse&nbsp;response)
throws java.io.IOException</pre>
<div class="block">Process the contained rules</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="Rule.html#matchAndApply(java.lang.String,javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse)">matchAndApply</a></code>&nbsp;in class&nbsp;<code><a href="Rule.html" title="class in org.eclipse.jetty.rewrite.handler">Rule</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>target</code> - target field to pass on to the contained rules</dd>
<dd><code>request</code> - request object to pass on to the contained rules</dd>
<dd><code>response</code> - response object to pass on to the contained rules</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The new target if the rule has matched, else null</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code> - if unable to match the rule</dd>
</dl>
</li>
</ul>
<a id="apply(java.lang.String,javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>apply</h4>
<pre class="methodSignature">protected&nbsp;java.lang.String&nbsp;apply&#8203;(java.lang.String&nbsp;target,
javax.servlet.http.HttpServletRequest&nbsp;request,
javax.servlet.http.HttpServletResponse&nbsp;response)
throws java.io.IOException</pre>
<div class="block">Process the contained rules (called by matchAndApply)</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>target</code> - target field to pass on to the contained rules</dd>
<dd><code>request</code> - request object to pass on to the contained rules</dd>
<dd><code>response</code> - response object to pass on to the contained rules</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the target</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code> - if unable to apply the rule</dd>
</dl>
</li>
</ul>
<a id="dump(java.lang.Appendable,java.lang.String)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>dump</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;dump&#8203;(java.lang.Appendable&nbsp;out,
java.lang.String&nbsp;indent)
throws java.io.IOException</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../util/component/Dumpable.html#dump(java.lang.Appendable,java.lang.String)">Dumpable</a></code></span></div>
<div class="block">Dump this object (and children) into an Appendable using the provided indent after any new lines.
The indent should not be applied to the first object dumped.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../util/component/Dumpable.html#dump(java.lang.Appendable,java.lang.String)">dump</a></code>&nbsp;in interface&nbsp;<code><a href="../../util/component/Dumpable.html" title="interface in org.eclipse.jetty.util.component">Dumpable</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>out</code> - The appendable to dump to</dd>
<dd><code>indent</code> - The indent to apply after any new lines.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code> - if unable to write to Appendable</dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/RuleContainer.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &#169; 1995&#x2013;2020 <a href="https://webtide.com">Webtide</a>. All rights reserved.</small></p>
</footer>
</body>
</html>