blob: 5513a10d43d6444d64338d803e897590076b1ea8 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.13) on Tue Feb 08 12:40:05 CST 2022 -->
<title>org.eclipse.jetty.rewrite.handler (Eclipse Jetty API Doc - v10.0.8)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-02-08">
<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="org.eclipse.jetty.rewrite.handler (Eclipse Jetty API Doc - v10.0.8)";
}
}
catch(err) {
}
//-->
var pathtoroot = "../../../../../";
var useModuleDirectories = true;
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 class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.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>
<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>
<main role="main">
<div class="header">
<h1 title="Package" class="title">Package&nbsp;org.eclipse.jetty.rewrite.handler</h1>
</div>
<div class="contentContainer">
<section role="region"><a id="package.description">
<!-- -->
</a>
<div class="block">Jetty Rewrite : Rewrite Handler and Rules for Jetty</div>
</section>
<ul class="blockList">
<li class="blockList">
<table class="typeSummary">
<caption><span>Interface Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="Rule.ApplyURI.html" title="interface in org.eclipse.jetty.rewrite.handler">Rule.ApplyURI</a></th>
<td class="colLast">
<div class="block">Interface used to apply a changed target if <a href="RuleContainer.html#setRewriteRequestURI(boolean)"><code>RuleContainer.setRewriteRequestURI(boolean)</code></a> is true.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="CompactPathRule.html" title="class in org.eclipse.jetty.rewrite.handler">CompactPathRule</a></th>
<td class="colLast">
<div class="block">Rewrite the URI by compacting to remove //</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="CookiePatternRule.html" title="class in org.eclipse.jetty.rewrite.handler">CookiePatternRule</a></th>
<td class="colLast">
<div class="block">Sets the cookie in the response whenever the rule finds a match.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="ForceRequestHeaderValueRule.html" title="class in org.eclipse.jetty.rewrite.handler">ForceRequestHeaderValueRule</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="ForwardedSchemeHeaderRule.html" title="class in org.eclipse.jetty.rewrite.handler">ForwardedSchemeHeaderRule</a></th>
<td class="colLast">
<div class="block">Set the scheme for the request</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="HeaderPatternRule.html" title="class in org.eclipse.jetty.rewrite.handler">HeaderPatternRule</a></th>
<td class="colLast">
<div class="block">Sets the header in the response whenever the rule finds a match.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="HeaderRegexRule.html" title="class in org.eclipse.jetty.rewrite.handler">HeaderRegexRule</a></th>
<td class="colLast">
<div class="block">Rule to add a header based on a Regex match</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="HeaderRule.html" title="class in org.eclipse.jetty.rewrite.handler">HeaderRule</a></th>
<td class="colLast">
<div class="block">Abstract rule that matches against request headers.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="MsieRule.html" title="class in org.eclipse.jetty.rewrite.handler">MsieRule</a></th>
<td class="colLast">
<div class="block">Special handling for MSIE (Microsoft Internet Explorer).</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="MsieSslRule.html" title="class in org.eclipse.jetty.rewrite.handler">MsieSslRule</a></th>
<td class="colLast">Deprecated.
<div class="deprecationComment">use MsieRule</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="PatternRule.html" title="class in org.eclipse.jetty.rewrite.handler">PatternRule</a></th>
<td class="colLast">
<div class="block">Abstract rule that use a <a href="../../http/pathmap/ServletPathSpec.html" title="class in org.eclipse.jetty.http.pathmap"><code>ServletPathSpec</code></a> for pattern matching.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="RedirectPatternRule.html" title="class in org.eclipse.jetty.rewrite.handler">RedirectPatternRule</a></th>
<td class="colLast">
<div class="block">Issues a (3xx) Redirect response whenever the rule finds a match.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="RedirectRegexRule.html" title="class in org.eclipse.jetty.rewrite.handler">RedirectRegexRule</a></th>
<td class="colLast">
<div class="block">Issues a (3xx) Redirect response whenever the rule finds a match via regular expression.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="RedirectUtil.html" title="class in org.eclipse.jetty.rewrite.handler">RedirectUtil</a></th>
<td class="colLast">
<div class="block">Utility for managing redirect based rules</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="RegexRule.html" title="class in org.eclipse.jetty.rewrite.handler">RegexRule</a></th>
<td class="colLast">
<div class="block">Abstract rule to use as a base class for rules that match with a regular expression.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="ResponsePatternRule.html" title="class in org.eclipse.jetty.rewrite.handler">ResponsePatternRule</a></th>
<td class="colLast">
<div class="block">Sends the response code whenever the rule finds a match.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="RewriteHandler.html" title="class in org.eclipse.jetty.rewrite.handler">RewriteHandler</a></th>
<td class="colLast">
<div class="block"> Rewrite handler is responsible for managing the rules.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="RewritePatternRule.html" title="class in org.eclipse.jetty.rewrite.handler">RewritePatternRule</a></th>
<td class="colLast">
<div class="block">Rewrite the URI by replacing the matched <a href="../../http/pathmap/ServletPathSpec.html" title="class in org.eclipse.jetty.http.pathmap"><code>ServletPathSpec</code></a> path with a fixed string.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="RewriteRegexRule.html" title="class in org.eclipse.jetty.rewrite.handler">RewriteRegexRule</a></th>
<td class="colLast">
<div class="block">Rewrite the URI by matching with a regular expression.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="Rule.html" title="class in org.eclipse.jetty.rewrite.handler">Rule</a></th>
<td class="colLast">
<div class="block">An abstract rule for creating rewrite rules.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="RuleContainer.html" title="class in org.eclipse.jetty.rewrite.handler">RuleContainer</a></th>
<td class="colLast">
<div class="block">Base container to group rules.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="TerminatingPatternRule.html" title="class in org.eclipse.jetty.rewrite.handler">TerminatingPatternRule</a></th>
<td class="colLast">
<div class="block">If this rule matches, terminate the processing of other rules.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="TerminatingRegexRule.html" title="class in org.eclipse.jetty.rewrite.handler">TerminatingRegexRule</a></th>
<td class="colLast">
<div class="block">If this rule matches, terminate the processing of other rules.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="ValidUrlRule.html" title="class in org.eclipse.jetty.rewrite.handler">ValidUrlRule</a></th>
<td class="colLast">
<div class="block">This rule can be used to protect against invalid unicode characters in a url making it into applications.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="VirtualHostRuleContainer.html" title="class in org.eclipse.jetty.rewrite.handler">VirtualHostRuleContainer</a></th>
<td class="colLast">
<div class="block">Groups rules that apply only to a specific virtual host
or sets of virtual hosts</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
</div>
</main>
<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 class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.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>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &#169; 1995&#x2013;2022 <a href="https://webtide.com">Webtide</a>. All rights reserved.</small></p>
</footer>
</body>
</html>