| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) on Thu Sep 15 14:13:16 CDT 2022 --> |
| <title>RewriteHandler (Eclipse Jetty API Doc - v11.0.12)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2022-09-15"> |
| <meta name="description" content="declaration: package: org.eclipse.jetty.rewrite.handler, class: RewriteHandler"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-3.5.1.min.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| var pathtoroot = "../../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">Class</li> |
| <li><a href="class-use/RewriteHandler.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#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li><a href="#nested-class-summary">Nested</a> | </li> |
| <li><a href="#field-summary">Field</a> | </li> |
| <li><a href="#constructor-summary">Constr</a> | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor-detail">Constr</a> | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><label for="search-input">SEARCH:</label> |
| <input type="text" id="search-input" value="search" disabled="disabled"> |
| <input type="reset" id="reset-button" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.eclipse.jetty.rewrite.handler</a></div> |
| <h1 title="Class RewriteHandler" class="title">Class RewriteHandler</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> |
| <div class="inheritance"><a href="../../util/component/AbstractLifeCycle.html" title="class in org.eclipse.jetty.util.component">org.eclipse.jetty.util.component.AbstractLifeCycle</a> |
| <div class="inheritance"><a href="../../util/component/ContainerLifeCycle.html" title="class in org.eclipse.jetty.util.component">org.eclipse.jetty.util.component.ContainerLifeCycle</a> |
| <div class="inheritance"><a href="../../server/handler/AbstractHandler.html" title="class in org.eclipse.jetty.server.handler">org.eclipse.jetty.server.handler.AbstractHandler</a> |
| <div class="inheritance"><a href="../../server/handler/AbstractHandlerContainer.html" title="class in org.eclipse.jetty.server.handler">org.eclipse.jetty.server.handler.AbstractHandlerContainer</a> |
| <div class="inheritance"><a href="../../server/handler/HandlerWrapper.html" title="class in org.eclipse.jetty.server.handler">org.eclipse.jetty.server.handler.HandlerWrapper</a> |
| <div class="inheritance">org.eclipse.jetty.rewrite.handler.RewriteHandler</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="../../server/Handler.html" title="interface in org.eclipse.jetty.server">Handler</a></code>, <code><a href="../../server/HandlerContainer.html" title="interface in org.eclipse.jetty.server">HandlerContainer</a></code>, <code><a href="../../util/component/Container.html" title="interface in org.eclipse.jetty.util.component">Container</a></code>, <code><a href="../../util/component/Destroyable.html" title="interface in org.eclipse.jetty.util.component">Destroyable</a></code>, <code><a href="../../util/component/Dumpable.html" title="interface in org.eclipse.jetty.util.component">Dumpable</a></code>, <code><a href="../../util/component/Dumpable.DumpableContainer.html" title="interface in org.eclipse.jetty.util.component">Dumpable.DumpableContainer</a></code>, <code><a href="../../util/component/LifeCycle.html" title="interface in org.eclipse.jetty.util.component">LifeCycle</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">RewriteHandler</span> |
| <span class="extends-implements">extends <a href="../../server/handler/HandlerWrapper.html" title="class in org.eclipse.jetty.server.handler">HandlerWrapper</a></span></div> |
| <div class="block"><p> Rewrite handler is responsible for managing the rules. Its capabilities |
| is not only limited for URL rewrites such as RewritePatternRule or RewriteRegexRule. |
| There is also handling for cookies, headers, redirection, setting status or error codes |
| whenever the rule finds a match. |
| |
| <p> The rules can be matched by the either: pattern matching of @<a href="../../http/pathmap/ServletPathSpec.html" title="class in org.eclipse.jetty.http.pathmap"><code>ServletPathSpec</code></a> |
| (eg <a href="PatternRule.html" title="class in org.eclipse.jetty.rewrite.handler"><code>PatternRule</code></a>), regular expressions (eg <a href="RegexRule.html" title="class in org.eclipse.jetty.rewrite.handler"><code>RegexRule</code></a>) or certain conditions set |
| (eg <a href="MsieSslRule.html" title="class in org.eclipse.jetty.rewrite.handler"><code>MsieSslRule</code></a> - the requests must be in SSL mode). |
| |
| <p> The rules can be grouped into rule containers (class <a href="RuleContainer.html" title="class in org.eclipse.jetty.rewrite.handler"><code>RuleContainer</code></a>), and will only |
| be applied if the request matches the conditions for their container |
| (e.g., by virtual host name) |
| |
| <p>The list of predefined rules is: |
| <ul> |
| <li> <a href="CookiePatternRule.html" title="class in org.eclipse.jetty.rewrite.handler"><code>CookiePatternRule</code></a> - adds a new cookie in response. </li> |
| <li> <a href="HeaderPatternRule.html" title="class in org.eclipse.jetty.rewrite.handler"><code>HeaderPatternRule</code></a> - adds/modifies the HTTP headers in response. </li> |
| <li> <a href="RedirectPatternRule.html" title="class in org.eclipse.jetty.rewrite.handler"><code>RedirectPatternRule</code></a> - sets the redirect location. </li> |
| <li> <a href="ResponsePatternRule.html" title="class in org.eclipse.jetty.rewrite.handler"><code>ResponsePatternRule</code></a> - sets the status/error codes. </li> |
| <li> <a href="RewritePatternRule.html" title="class in org.eclipse.jetty.rewrite.handler"><code>RewritePatternRule</code></a> - rewrites the requested URI. </li> |
| <li> <a href="RewriteRegexRule.html" title="class in org.eclipse.jetty.rewrite.handler"><code>RewriteRegexRule</code></a> - rewrites the requested URI using regular expression for pattern matching. </li> |
| <li> <a href="MsieSslRule.html" title="class in org.eclipse.jetty.rewrite.handler"><code>MsieSslRule</code></a> - disables the keep alive on SSL for IE5 and IE6. </li> |
| <li> <a href="ForwardedSchemeHeaderRule.html" title="class in org.eclipse.jetty.rewrite.handler"><code>ForwardedSchemeHeaderRule</code></a> - set the scheme according to the headers present. </li> |
| <li> <a href="VirtualHostRuleContainer.html" title="class in org.eclipse.jetty.rewrite.handler"><code>VirtualHostRuleContainer</code></a> - checks whether the request matches one of a set of virtual host names.</li> |
| </ul> |
| |
| |
| Here is a typical jetty.xml configuration would be: <pre> |
| |
| <New id="RewriteHandler" class="org.eclipse.jetty.rewrite.handler.RewriteHandler"> |
| <Set name="rules"> |
| <Array type="org.eclipse.jetty.rewrite.handler.Rule"> |
| |
| <Item> |
| <New id="rewrite" class="org.eclipse.jetty.rewrite.handler.RewritePatternRule"> |
| <Set name="pattern">/*</Set> |
| <Set name="replacement">/test</Set> |
| </New> |
| </Item> |
| |
| <Item> |
| <New id="response" class="org.eclipse.jetty.rewrite.handler.ResponsePatternRule"> |
| <Set name="pattern">/session/</Set> |
| <Set name="code">400</Set> |
| <Set name="reason">Setting error code 400</Set> |
| </New> |
| </Item> |
| |
| <Item> |
| <New id="header" class="org.eclipse.jetty.rewrite.handler.HeaderPatternRule"> |
| <Set name="pattern">*.jsp</Set> |
| <Set name="name">server</Set> |
| <Set name="value">dexter webserver</Set> |
| </New> |
| </Item> |
| |
| <Item> |
| <New id="header" class="org.eclipse.jetty.rewrite.handler.HeaderPatternRule"> |
| <Set name="pattern">*.jsp</Set> |
| <Set name="name">title</Set> |
| <Set name="value">driven header purpose</Set> |
| </New> |
| </Item> |
| |
| <Item> |
| <New id="redirect" class="org.eclipse.jetty.rewrite.handler.RedirectPatternRule"> |
| <Set name="pattern">/test/dispatch</Set> |
| <Set name="location">http://jetty.eclipse.org</Set> |
| </New> |
| </Item> |
| |
| <Item> |
| <New id="regexRewrite" class="org.eclipse.jetty.rewrite.handler.RewriteRegexRule"> |
| <Set name="regex">/test-jaas/$</Set> |
| <Set name="replacement">/demo</Set> |
| </New> |
| </Item> |
| |
| <Item> |
| <New id="forwardedHttps" class="org.eclipse.jetty.rewrite.handler.ForwardedSchemeHeaderRule"> |
| <Set name="header">X-Forwarded-Scheme</Set> |
| <Set name="headerValue">https</Set> |
| <Set name="scheme">https</Set> |
| </New> |
| </Item> |
| |
| <Item> |
| <New id="virtualHost" class="org.eclipse.jetty.rewrite.handler.VirtualHostRuleContainer"> |
| |
| <Set name="virtualHosts"> |
| <Array type="java.lang.String"> |
| <Item>eclipse.com</Item> |
| <Item>www.eclipse.com</Item> |
| <Item>eclipse.org</Item> |
| <Item>www.eclipse.org</Item> |
| </Array> |
| </Set> |
| |
| <Call name="addRule"> |
| <Arg> |
| <New class="org.eclipse.jetty.rewrite.handler.CookiePatternRule"> |
| <Set name="pattern">/*</Set> |
| <Set name="name">CookiePatternRule</Set> |
| <Set name="value">1</Set> |
| </New> |
| </Arg> |
| </Call> |
| |
| </New> |
| </Item> |
| |
| </Array> |
| </Set> |
| </New> |
| |
| <Set name="handler"> |
| <Ref id="RewriteHandler"/> |
| <Set name="handler"> |
| <New id="Handlers" class="org.eclipse.jetty.server.handler.HandlerCollection"> |
| <Set name="handlers"> |
| <Array type="org.eclipse.jetty.server.Handler"> |
| <Item> |
| <New id="Contexts" class="org.eclipse.jetty.server.handler.ContextHandlerCollection"/> |
| </Item> |
| <Item> |
| <New id="DefaultHandler" class="org.eclipse.jetty.server.handler.DefaultHandler"/> |
| </Item> |
| </Array> |
| </Set> |
| </New> |
| </Set> |
| </Ref> |
| </Set> |
| </pre></div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <li> |
| <section class="nested-class-summary" id="nested-class-summary"> |
| <h2>Nested Class Summary</h2> |
| <div class="inherited-list"> |
| <h2 id="nested-classes-inherited-from-class-org.eclipse.jetty.server.handler.AbstractHandler">Nested classes/interfaces inherited from class org.eclipse.jetty.server.handler.<a href="../../server/handler/AbstractHandler.html" title="class in org.eclipse.jetty.server.handler">AbstractHandler</a></h2> |
| <code><a href="../../server/handler/AbstractHandler.ErrorDispatchHandler.html" title="class in org.eclipse.jetty.server.handler">AbstractHandler.ErrorDispatchHandler</a></code></div> |
| <div class="inherited-list"> |
| <h2 id="nested-classes-inherited-from-class-org.eclipse.jetty.util.component.AbstractLifeCycle">Nested classes/interfaces inherited from class org.eclipse.jetty.util.component.<a href="../../util/component/AbstractLifeCycle.html" title="class in org.eclipse.jetty.util.component">AbstractLifeCycle</a></h2> |
| <code><a href="../../util/component/AbstractLifeCycle.AbstractLifeCycleListener.html" title="class in org.eclipse.jetty.util.component">AbstractLifeCycle.AbstractLifeCycleListener</a>, <a href="../../util/component/AbstractLifeCycle.StopException.html" title="class in org.eclipse.jetty.util.component">AbstractLifeCycle.StopException</a></code></div> |
| <div class="inherited-list"> |
| <h2 id="nested-classes-inherited-from-class-org.eclipse.jetty.util.component.Container">Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.<a href="../../util/component/Container.html" title="interface in org.eclipse.jetty.util.component">Container</a></h2> |
| <code><a href="../../util/component/Container.InheritedListener.html" title="interface in org.eclipse.jetty.util.component">Container.InheritedListener</a>, <a href="../../util/component/Container.Listener.html" title="interface in org.eclipse.jetty.util.component">Container.Listener</a></code></div> |
| <div class="inherited-list"> |
| <h2 id="nested-classes-inherited-from-class-org.eclipse.jetty.util.component.Dumpable">Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.<a href="../../util/component/Dumpable.html" title="interface in org.eclipse.jetty.util.component">Dumpable</a></h2> |
| <code><a href="../../util/component/Dumpable.DumpableContainer.html" title="interface in org.eclipse.jetty.util.component">Dumpable.DumpableContainer</a></code></div> |
| <div class="inherited-list"> |
| <h2 id="nested-classes-inherited-from-class-org.eclipse.jetty.util.component.LifeCycle">Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.<a href="../../util/component/LifeCycle.html" title="interface in org.eclipse.jetty.util.component">LifeCycle</a></h2> |
| <code><a href="../../util/component/LifeCycle.Listener.html" title="interface in org.eclipse.jetty.util.component">LifeCycle.Listener</a></code></div> |
| </section> |
| </li> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li> |
| <section class="field-summary" id="field-summary"> |
| <h2>Field Summary</h2> |
| <div class="inherited-list"> |
| <h3 id="fields-inherited-from-class-org.eclipse.jetty.server.handler.HandlerWrapper">Fields inherited from class org.eclipse.jetty.server.handler.<a href="../../server/handler/HandlerWrapper.html" title="class in org.eclipse.jetty.server.handler">HandlerWrapper</a></h3> |
| <code><a href="../../server/handler/HandlerWrapper.html#_handler">_handler</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="fields-inherited-from-class-org.eclipse.jetty.util.component.AbstractLifeCycle">Fields inherited from class org.eclipse.jetty.util.component.<a href="../../util/component/AbstractLifeCycle.html" title="class in org.eclipse.jetty.util.component">AbstractLifeCycle</a></h3> |
| <code><a href="../../util/component/AbstractLifeCycle.html#FAILED">FAILED</a>, <a href="../../util/component/AbstractLifeCycle.html#STARTED">STARTED</a>, <a href="../../util/component/AbstractLifeCycle.html#STARTING">STARTING</a>, <a href="../../util/component/AbstractLifeCycle.html#STOPPED">STOPPED</a>, <a href="../../util/component/AbstractLifeCycle.html#STOPPING">STOPPING</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="fields-inherited-from-class-org.eclipse.jetty.util.component.Dumpable">Fields inherited from interface 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></div> |
| </section> |
| </li> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li> |
| <section class="constructor-summary" id="constructor-summary"> |
| <h2>Constructor Summary</h2> |
| <div class="caption"><span>Constructors</span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">RewriteHandler</a>()</code></div> |
| <div class="col-last even-row-color"> </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#addRule(org.eclipse.jetty.rewrite.handler.Rule)" class="member-name-link">addRule</a><wbr>(<a href="Rule.html" title="class in org.eclipse.jetty.rewrite.handler">Rule</a> rule)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Add a Rule</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/EnumSet.html" title="class or interface in java.util" class="external-link">EnumSet</a><jakarta.servlet.DispatcherType></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getDispatcherTypes()" class="member-name-link">getDispatcherTypes</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getOriginalPathAttribute()" class="member-name-link">getOriginalPathAttribute</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="RuleContainer.html" title="class in org.eclipse.jetty.rewrite.handler">RuleContainer</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getRuleContainer()" class="member-name-link">getRuleContainer</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="Rule.html" title="class in org.eclipse.jetty.rewrite.handler">Rule</a>[]</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getRules()" class="member-name-link">getRules</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the list of rules.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#handle(java.lang.String,org.eclipse.jetty.server.Request,jakarta.servlet.http.HttpServletRequest,jakarta.servlet.http.HttpServletResponse)" class="member-name-link">handle</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> target, |
| <a href="../../server/Request.html" title="class in org.eclipse.jetty.server">Request</a> baseRequest, |
| jakarta.servlet.http.HttpServletRequest request, |
| jakarta.servlet.http.HttpServletResponse response)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Handle a request.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isRewritePathInfo()" class="member-name-link">isRewritePathInfo</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isRewriteRequestURI()" class="member-name-link">isRewriteRequestURI</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setDispatcherTypes(jakarta.servlet.DispatcherType...)" class="member-name-link">setDispatcherTypes</a><wbr>(jakarta.servlet.DispatcherType... types)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setDispatcherTypes(java.util.EnumSet)" class="member-name-link">setDispatcherTypes</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/EnumSet.html" title="class or interface in java.util" class="external-link">EnumSet</a><jakarta.servlet.DispatcherType> types)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setOriginalPathAttribute(java.lang.String)" class="member-name-link">setOriginalPathAttribute</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> originalPathAttribute)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setRewritePathInfo(boolean)" class="member-name-link">setRewritePathInfo</a><wbr>(boolean rewritePathInfo)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setRewriteRequestURI(boolean)" class="member-name-link">setRewriteRequestURI</a><wbr>(boolean rewriteRequestURI)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setRuleContainer(org.eclipse.jetty.rewrite.handler.RuleContainer)" class="member-name-link">setRuleContainer</a><wbr>(<a href="RuleContainer.html" title="class in org.eclipse.jetty.rewrite.handler">RuleContainer</a> rules)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Assigns the rules to process.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setRules(org.eclipse.jetty.rewrite.handler.Rule%5B%5D)" class="member-name-link">setRules</a><wbr>(<a href="Rule.html" title="class in org.eclipse.jetty.rewrite.handler">Rule</a>[] rules)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Assigns the rules to process.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.eclipse.jetty.server.handler.HandlerWrapper">Methods inherited from class org.eclipse.jetty.server.handler.<a href="../../server/handler/HandlerWrapper.html" title="class in org.eclipse.jetty.server.handler">HandlerWrapper</a></h3> |
| <code><a href="../../server/handler/HandlerWrapper.html#destroy()">destroy</a>, <a href="../../server/handler/HandlerWrapper.html#expandChildren(java.util.List,java.lang.Class)">expandChildren</a>, <a href="../../server/handler/HandlerWrapper.html#getHandler()">getHandler</a>, <a href="../../server/handler/HandlerWrapper.html#getHandlers()">getHandlers</a>, <a href="../../server/handler/HandlerWrapper.html#insertHandler(org.eclipse.jetty.server.handler.HandlerWrapper)">insertHandler</a>, <a href="../../server/handler/HandlerWrapper.html#setHandler(org.eclipse.jetty.server.Handler)">setHandler</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.eclipse.jetty.server.handler.AbstractHandlerContainer">Methods inherited from class org.eclipse.jetty.server.handler.<a href="../../server/handler/AbstractHandlerContainer.html" title="class in org.eclipse.jetty.server.handler">AbstractHandlerContainer</a></h3> |
| <code><a href="../../server/handler/AbstractHandlerContainer.html#expandHandler(org.eclipse.jetty.server.Handler,java.util.List,java.lang.Class)">expandHandler</a>, <a href="../../server/handler/AbstractHandlerContainer.html#findContainerOf(org.eclipse.jetty.server.HandlerContainer,java.lang.Class,org.eclipse.jetty.server.Handler)">findContainerOf</a>, <a href="../../server/handler/AbstractHandlerContainer.html#getChildHandlerByClass(java.lang.Class)">getChildHandlerByClass</a>, <a href="../../server/handler/AbstractHandlerContainer.html#getChildHandlers()">getChildHandlers</a>, <a href="../../server/handler/AbstractHandlerContainer.html#getChildHandlersByClass(java.lang.Class)">getChildHandlersByClass</a>, <a href="../../server/handler/AbstractHandlerContainer.html#setServer(org.eclipse.jetty.server.Server)">setServer</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.eclipse.jetty.server.handler.AbstractHandler">Methods inherited from class org.eclipse.jetty.server.handler.<a href="../../server/handler/AbstractHandler.html" title="class in org.eclipse.jetty.server.handler">AbstractHandler</a></h3> |
| <code><a href="../../server/handler/AbstractHandler.html#doError(java.lang.String,org.eclipse.jetty.server.Request,jakarta.servlet.http.HttpServletRequest,jakarta.servlet.http.HttpServletResponse)">doError</a>, <a href="../../server/handler/AbstractHandler.html#doStart()">doStart</a>, <a href="../../server/handler/AbstractHandler.html#doStop()">doStop</a>, <a href="../../server/handler/AbstractHandler.html#getServer()">getServer</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.eclipse.jetty.util.component.ContainerLifeCycle">Methods inherited from class org.eclipse.jetty.util.component.<a href="../../util/component/ContainerLifeCycle.html" title="class in org.eclipse.jetty.util.component">ContainerLifeCycle</a></h3> |
| <code><a href="../../util/component/ContainerLifeCycle.html#addBean(java.lang.Object)">addBean</a>, <a href="../../util/component/ContainerLifeCycle.html#addBean(java.lang.Object,boolean)">addBean</a>, <a href="../../util/component/ContainerLifeCycle.html#addEventListener(java.util.EventListener)">addEventListener</a>, <a href="../../util/component/ContainerLifeCycle.html#addManaged(org.eclipse.jetty.util.component.LifeCycle)">addManaged</a>, <a href="../../util/component/ContainerLifeCycle.html#contains(java.lang.Object)">contains</a>, <a href="../../util/component/ContainerLifeCycle.html#dump()">dump</a>, <a href="../../util/component/ContainerLifeCycle.html#dump(java.lang.Appendable)">dump</a>, <a href="../../util/component/ContainerLifeCycle.html#dump(java.lang.Appendable,java.lang.String)">dump</a>, <a href="../../util/component/ContainerLifeCycle.html#dumpObjects(java.lang.Appendable,java.lang.String,java.lang.Object...)">dumpObjects</a>, <a href="../../util/component/ContainerLifeCycle.html#dumpStdErr()">dumpStdErr</a>, <a href="../../util/component/ContainerLifeCycle.html#getBean(java.lang.Class)">getBean</a>, <a href="../../util/component/ContainerLifeCycle.html#getBeans()">getBeans</a>, <a href="../../util/component/ContainerLifeCycle.html#getBeans(java.lang.Class)">getBeans</a>, <a href="../../util/component/ContainerLifeCycle.html#getContainedBeans(java.lang.Class)">getContainedBeans</a>, <a href="../../util/component/ContainerLifeCycle.html#getContainedBeans(java.lang.Class,java.util.Collection)">getContainedBeans</a>, <a href="../../util/component/ContainerLifeCycle.html#isAuto(java.lang.Object)">isAuto</a>, <a href="../../util/component/ContainerLifeCycle.html#isManaged(java.lang.Object)">isManaged</a>, <a href="../../util/component/ContainerLifeCycle.html#isUnmanaged(java.lang.Object)">isUnmanaged</a>, <a href="../../util/component/ContainerLifeCycle.html#manage(java.lang.Object)">manage</a>, <a href="../../util/component/ContainerLifeCycle.html#removeBean(java.lang.Object)">removeBean</a>, <a href="../../util/component/ContainerLifeCycle.html#removeBeans()">removeBeans</a>, <a href="../../util/component/ContainerLifeCycle.html#removeEventListener(java.util.EventListener)">removeEventListener</a>, <a href="../../util/component/ContainerLifeCycle.html#setBeans(java.util.Collection)">setBeans</a>, <a href="../../util/component/ContainerLifeCycle.html#start(org.eclipse.jetty.util.component.LifeCycle)">start</a>, <a href="../../util/component/ContainerLifeCycle.html#stop(org.eclipse.jetty.util.component.LifeCycle)">stop</a>, <a href="../../util/component/ContainerLifeCycle.html#unmanage(java.lang.Object)">unmanage</a>, <a href="../../util/component/ContainerLifeCycle.html#updateBean(java.lang.Object,java.lang.Object)">updateBean</a>, <a href="../../util/component/ContainerLifeCycle.html#updateBean(java.lang.Object,java.lang.Object,boolean)">updateBean</a>, <a href="../../util/component/ContainerLifeCycle.html#updateBeans(java.lang.Object%5B%5D,java.lang.Object%5B%5D)">updateBeans</a>, <a href="../../util/component/ContainerLifeCycle.html#updateBeans(java.util.Collection,java.util.Collection)">updateBeans</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.eclipse.jetty.util.component.AbstractLifeCycle">Methods inherited from class org.eclipse.jetty.util.component.<a href="../../util/component/AbstractLifeCycle.html" title="class in org.eclipse.jetty.util.component">AbstractLifeCycle</a></h3> |
| <code><a href="../../util/component/AbstractLifeCycle.html#getEventListeners()">getEventListeners</a>, <a href="../../util/component/AbstractLifeCycle.html#getState()">getState</a>, <a href="../../util/component/AbstractLifeCycle.html#getState(org.eclipse.jetty.util.component.LifeCycle)">getState</a>, <a href="../../util/component/AbstractLifeCycle.html#isFailed()">isFailed</a>, <a href="../../util/component/AbstractLifeCycle.html#isRunning()">isRunning</a>, <a href="../../util/component/AbstractLifeCycle.html#isStarted()">isStarted</a>, <a href="../../util/component/AbstractLifeCycle.html#isStarting()">isStarting</a>, <a href="../../util/component/AbstractLifeCycle.html#isStopped()">isStopped</a>, <a href="../../util/component/AbstractLifeCycle.html#isStopping()">isStopping</a>, <a href="../../util/component/AbstractLifeCycle.html#setEventListeners(java.util.Collection)">setEventListeners</a>, <a href="../../util/component/AbstractLifeCycle.html#start()">start</a>, <a href="../../util/component/AbstractLifeCycle.html#stop()">stop</a>, <a href="../../util/component/AbstractLifeCycle.html#toString()">toString</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.eclipse.jetty.util.component.Container">Methods inherited from interface org.eclipse.jetty.util.component.<a href="../../util/component/Container.html" title="interface in org.eclipse.jetty.util.component">Container</a></h3> |
| <code><a href="../../util/component/Container.html#getCachedBeans(java.lang.Class)">getCachedBeans</a>, <a href="../../util/component/Container.html#getEventListeners()">getEventListeners</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.eclipse.jetty.util.component.Dumpable">Methods inherited from interface 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#dumpSelf()">dumpSelf</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.eclipse.jetty.util.component.Dumpable.DumpableContainer">Methods inherited from interface org.eclipse.jetty.util.component.<a href="../../util/component/Dumpable.DumpableContainer.html" title="interface in org.eclipse.jetty.util.component">Dumpable.DumpableContainer</a></h3> |
| <code><a href="../../util/component/Dumpable.DumpableContainer.html#isDumpable(java.lang.Object)">isDumpable</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.eclipse.jetty.util.component.LifeCycle">Methods inherited from interface org.eclipse.jetty.util.component.<a href="../../util/component/LifeCycle.html" title="interface in org.eclipse.jetty.util.component">LifeCycle</a></h3> |
| <code><a href="../../util/component/LifeCycle.html#addEventListener(java.util.EventListener)">addEventListener</a>, <a href="../../util/component/LifeCycle.html#isFailed()">isFailed</a>, <a href="../../util/component/LifeCycle.html#isRunning()">isRunning</a>, <a href="../../util/component/LifeCycle.html#isStarted()">isStarted</a>, <a href="../../util/component/LifeCycle.html#isStarting()">isStarting</a>, <a href="../../util/component/LifeCycle.html#isStopped()">isStopped</a>, <a href="../../util/component/LifeCycle.html#isStopping()">isStopping</a>, <a href="../../util/component/LifeCycle.html#removeEventListener(java.util.EventListener)">removeEventListener</a>, <a href="../../util/component/LifeCycle.html#start()">start</a>, <a href="../../util/component/LifeCycle.html#stop()">stop</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor-detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>()"> |
| <h3>RewriteHandler</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">RewriteHandler</span>()</div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="getRules()"> |
| <h3>getRules</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="Rule.html" title="class in org.eclipse.jetty.rewrite.handler">Rule</a>[]</span> <span class="element-name">getRules</span>()</div> |
| <div class="block">Returns the list of rules.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>an array of <a href="Rule.html" title="class in org.eclipse.jetty.rewrite.handler"><code>Rule</code></a>.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setRules(org.eclipse.jetty.rewrite.handler.Rule[])"> |
| <h3>setRules</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setRules</span><wbr><span class="parameters">(<a href="Rule.html" title="class in org.eclipse.jetty.rewrite.handler">Rule</a>[] rules)</span></div> |
| <div class="block">Assigns the rules to process.</div> |
| <dl class="notes"> |
| <dt>Parameters:</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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setRuleContainer(org.eclipse.jetty.rewrite.handler.RuleContainer)"> |
| <h3>setRuleContainer</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setRuleContainer</span><wbr><span class="parameters">(<a href="RuleContainer.html" title="class in org.eclipse.jetty.rewrite.handler">RuleContainer</a> rules)</span></div> |
| <div class="block">Assigns the rules to process.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>rules</code> - a <a href="RuleContainer.html" title="class in org.eclipse.jetty.rewrite.handler"><code>RuleContainer</code></a> containing other rules to process</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getRuleContainer()"> |
| <h3>getRuleContainer</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="RuleContainer.html" title="class in org.eclipse.jetty.rewrite.handler">RuleContainer</a></span> <span class="element-name">getRuleContainer</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="addRule(org.eclipse.jetty.rewrite.handler.Rule)"> |
| <h3>addRule</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">addRule</span><wbr><span class="parameters">(<a href="Rule.html" title="class in org.eclipse.jetty.rewrite.handler">Rule</a> rule)</span></div> |
| <div class="block">Add a Rule</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>rule</code> - The rule to add to the end of the rules array</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isRewriteRequestURI()"> |
| <h3>isRewriteRequestURI</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isRewriteRequestURI</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the rewriteRequestURI If true, this handler will rewrite the value |
| returned by <code>HttpServletRequest.getRequestURI()</code>.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setRewriteRequestURI(boolean)"> |
| <h3>setRewriteRequestURI</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setRewriteRequestURI</span><wbr><span class="parameters">(boolean rewriteRequestURI)</span></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>rewriteRequestURI</code> - true if this handler will rewrite the value |
| returned by <code>HttpServletRequest.getRequestURI()</code>.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isRewritePathInfo()"> |
| <h3>isRewritePathInfo</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isRewritePathInfo</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>true if this handler will rewrite the value |
| returned by <code>HttpServletRequest.getPathInfo()</code>.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setRewritePathInfo(boolean)"> |
| <h3>setRewritePathInfo</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setRewritePathInfo</span><wbr><span class="parameters">(boolean rewritePathInfo)</span></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>rewritePathInfo</code> - true if this handler will rewrite the value |
| returned by <code>HttpServletRequest.getPathInfo()</code>.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getOriginalPathAttribute()"> |
| <h3>getOriginalPathAttribute</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getOriginalPathAttribute</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the originalPathAttribte. If non null, this string will be used |
| as the attribute name to store the original request path.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setOriginalPathAttribute(java.lang.String)"> |
| <h3>setOriginalPathAttribute</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setOriginalPathAttribute</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> originalPathAttribute)</span></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>originalPathAttribute</code> - If non null, this string will be used |
| as the attribute name to store the original request path.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getDispatcherTypes()"> |
| <h3>getDispatcherTypes</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/EnumSet.html" title="class or interface in java.util" class="external-link">EnumSet</a><jakarta.servlet.DispatcherType></span> <span class="element-name">getDispatcherTypes</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setDispatcherTypes(java.util.EnumSet)"> |
| <h3>setDispatcherTypes</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setDispatcherTypes</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/EnumSet.html" title="class or interface in java.util" class="external-link">EnumSet</a><jakarta.servlet.DispatcherType> types)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setDispatcherTypes(jakarta.servlet.DispatcherType...)"> |
| <h3>setDispatcherTypes</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setDispatcherTypes</span><wbr><span class="parameters">(jakarta.servlet.DispatcherType... types)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="handle(java.lang.String,org.eclipse.jetty.server.Request,jakarta.servlet.http.HttpServletRequest,jakarta.servlet.http.HttpServletResponse)"> |
| <h3>handle</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">handle</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> target, |
| <a href="../../server/Request.html" title="class in org.eclipse.jetty.server">Request</a> baseRequest, |
| jakarta.servlet.http.HttpServletRequest request, |
| jakarta.servlet.http.HttpServletResponse response)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a>, |
| jakarta.servlet.ServletException</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../../server/Handler.html#handle(java.lang.String,org.eclipse.jetty.server.Request,jakarta.servlet.http.HttpServletRequest,jakarta.servlet.http.HttpServletResponse)">Handler</a></code></span></div> |
| <div class="block">Handle a request.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../../server/Handler.html#handle(java.lang.String,org.eclipse.jetty.server.Request,jakarta.servlet.http.HttpServletRequest,jakarta.servlet.http.HttpServletResponse)">handle</a></code> in interface <code><a href="../../server/Handler.html" title="interface in org.eclipse.jetty.server">Handler</a></code></dd> |
| <dt>Overrides:</dt> |
| <dd><code><a href="../../server/handler/HandlerWrapper.html#handle(java.lang.String,org.eclipse.jetty.server.Request,jakarta.servlet.http.HttpServletRequest,jakarta.servlet.http.HttpServletResponse)">handle</a></code> in class <code><a href="../../server/handler/HandlerWrapper.html" title="class in org.eclipse.jetty.server.handler">HandlerWrapper</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>target</code> - The target of the request - either a URI or a name.</dd> |
| <dd><code>baseRequest</code> - The original unwrapped request object.</dd> |
| <dd><code>request</code> - The request either as the <a href="../../server/Request.html" title="class in org.eclipse.jetty.server"><code>Request</code></a> object or a wrapper of that request. The |
| <code><a href="../../server/HttpConnection.html#getCurrentConnection()"><code>HttpConnection.getCurrentConnection()</code></a>.<a href="../../server/HttpConnection.html#getHttpChannel()"><code>getHttpChannel()</code></a>.<a href="../../server/HttpChannel.html#getRequest()"><code>getRequest()</code></a></code> |
| method can be used access the Request object if required.</dd> |
| <dd><code>response</code> - The response as the <a href="../../server/Response.html" title="class in org.eclipse.jetty.server"><code>Response</code></a> object or a wrapper of that request. The |
| <code><a href="../../server/HttpConnection.html#getCurrentConnection()"><code>HttpConnection.getCurrentConnection()</code></a>.<a href="../../server/HttpConnection.html#getHttpChannel()"><code>getHttpChannel()</code></a>.<a href="../../server/HttpChannel.html#getResponse()"><code>getResponse()</code></a></code> |
| method can be used access the Response object if required.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code> - if unable to handle the request or response processing</dd> |
| <dd><code>jakarta.servlet.ServletException</code> - if unable to handle the request or response due to underlying servlet issue</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 1995–2022 <a href="https://webtide.com">Webtide</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
