| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) on Thu Sep 15 14:13:16 CDT 2022 --> |
| <title>ForwardedRequestCustomizer (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.server, class: ForwardedRequestCustomizer"> |
| <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/ForwardedRequestCustomizer.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>Field | </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.server</a></div> |
| <h1 title="Class ForwardedRequestCustomizer" class="title">Class ForwardedRequestCustomizer</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">org.eclipse.jetty.server.ForwardedRequestCustomizer</div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="HttpConfiguration.Customizer.html" title="interface in org.eclipse.jetty.server">HttpConfiguration.Customizer</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">ForwardedRequestCustomizer</span> |
| <span class="extends-implements">extends <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> |
| implements <a href="HttpConfiguration.Customizer.html" title="interface in org.eclipse.jetty.server">HttpConfiguration.Customizer</a></span></div> |
| <div class="block">Customize Requests for Proxy Forwarding. |
| <p> |
| This customizer looks at at HTTP request for headers that indicate |
| it has been forwarded by one or more proxies. Specifically handled are |
| <ul> |
| <li><code>Forwarded</code>, as defined by <a href="https://tools.ietf.org/html/rfc7239">rfc7239</a> |
| <li><code>X-Forwarded-Host</code></li> |
| <li><code>X-Forwarded-Server</code></li> |
| <li><code>X-Forwarded-For</code></li> |
| <li><code>X-Forwarded-Proto</code></li> |
| <li><code>X-Proxied-Https</code></li> |
| </ul> |
| <p>If these headers are present, then the <a href="Request.html" title="class in org.eclipse.jetty.server"><code>Request</code></a> object is updated |
| so that the proxy is not seen as the other end point of the connection on which |
| the request came</p> |
| <p>Headers can also be defined so that forwarded SSL Session IDs and Cipher |
| suites may be customised</p> |
| <p> |
| The Authority (host and port) is updated on the <a href="Request.html" title="class in org.eclipse.jetty.server"><code>Request</code></a> object based |
| on the host / port information in the following search order. |
| </p> |
| <table style="border: 1px solid black; border-collapse: separate; border-spacing: 0px;"> |
| <caption style="font-weight: bold; font-size: 1.2em">Request Authority Search Order</caption> |
| <colgroup> |
| <col><col style="width: 15%"><col><col><col><col> |
| </colgroup> |
| <thead style="background-color: lightgray"> |
| <tr> |
| <th>#</th> |
| <th>Value Origin</th> |
| <th>Host</th> |
| <th>Port</th> |
| <th>Protocol</th> |
| <th>Notes</th> |
| </tr> |
| </thead> |
| <tbody style="text-align: left; vertical-align: top;"> |
| <tr> |
| <td>1</td> |
| <td><code>Forwarded</code> Header</td> |
| <td>"<code>host=<host></code>" param (Required)</td> |
| <td>"<code>host=<host>:<port></code> param (Implied)</td> |
| <td>"<code>proto=<value></code>" param (Optional)</td> |
| <td>From left-most relevant parameter (see <a href="https://tools.ietf.org/html/rfc7239">rfc7239</a>)</td> |
| </tr> |
| <tr> |
| <td>2</td> |
| <td><code>X-Forwarded-Host</code> Header</td> |
| <td>Required</td> |
| <td>Implied</td> |
| <td>n/a</td> |
| <td>left-most value</td> |
| </tr> |
| <tr> |
| <td>3</td> |
| <td><code>X-Forwarded-Port</code> Header</td> |
| <td>n/a</td> |
| <td>Required</td> |
| <td>n/a</td> |
| <td>left-most value (only if <a href="#getForwardedPortAsAuthority()"><code>getForwardedPortAsAuthority()</code></a> is true)</td> |
| </tr> |
| <tr> |
| <td>4</td> |
| <td><code>X-Forwarded-Server</code> Header</td> |
| <td>Required</td> |
| <td>Optional</td> |
| <td>n/a</td> |
| <td>left-most value</td> |
| </tr> |
| <tr> |
| <td>5</td> |
| <td><code>X-Forwarded-Proto</code> Header</td> |
| <td>n/a</td> |
| <td>Implied from value</td> |
| <td>Required</td> |
| <td> |
| <p>left-most value becomes protocol.</p> |
| <ul> |
| <li>Value of "<code>http</code>" means port=80.</li> |
| <li>Value of "<a href="HttpConfiguration.html#getSecureScheme()"><code>HttpConfiguration.getSecureScheme()</code></a>" means port=<a href="HttpConfiguration.html#getSecurePort()"><code>HttpConfiguration.getSecurePort()</code></a>.</li> |
| </ul> |
| </td> |
| </tr> |
| <tr> |
| <td>6</td> |
| <td><code>X-Proxied-Https</code> Header</td> |
| <td>n/a</td> |
| <td>Implied from value</td> |
| <td>boolean</td> |
| <td> |
| <p>left-most value determines protocol and port.</p> |
| <ul> |
| <li>Value of "<code>on</code>" means port=<a href="HttpConfiguration.html#getSecurePort()"><code>HttpConfiguration.getSecurePort()</code></a>, and protocol=<a href="HttpConfiguration.html#getSecureScheme()"><code>HttpConfiguration.getSecureScheme()</code></a>).</li> |
| <li>Value of "<code>off</code>" means port=80, and protocol=http.</li> |
| </ul> |
| </td> |
| </tr> |
| </tbody> |
| </table></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list-long"> |
| <li><a href="http://en.wikipedia.org/wiki/X-Forwarded-For">Wikipedia: X-Forwarded-For</a></li> |
| <li><a href="https://tools.ietf.org/html/rfc7239">RFC 7239: Forwarded HTTP Extension</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </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="caption"><span>Nested Classes</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Class</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>static enum </code></div> |
| <div class="col-second even-row-color"><code><a href="ForwardedRequestCustomizer.Source.html" class="type-name-link" title="enum in org.eclipse.jetty.server">ForwardedRequestCustomizer.Source</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Ordered Source Enum.</div> |
| </div> |
| </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">ForwardedRequestCustomizer</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-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static 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="#customize(org.eclipse.jetty.server.Connector,org.eclipse.jetty.server.HttpConfiguration,org.eclipse.jetty.server.Request)" class="member-name-link">customize</a><wbr>(<a href="Connector.html" title="interface in org.eclipse.jetty.server">Connector</a> connector, |
| <a href="HttpConfiguration.html" title="class in org.eclipse.jetty.server">HttpConfiguration</a> config, |
| <a href="Request.html" title="class in org.eclipse.jetty.server">Request</a> request)</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="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 odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getForcedHost()" class="member-name-link">getForcedHost</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="#getForwardedCipherSuiteHeader()" class="member-name-link">getForwardedCipherSuiteHeader</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="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 odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getForwardedForHeader()" class="member-name-link">getForwardedForHeader</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="#getForwardedHeader()" class="member-name-link">getForwardedHeader</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="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 odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getForwardedHostHeader()" class="member-name-link">getForwardedHostHeader</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="#getForwardedHttpsHeader()" class="member-name-link">getForwardedHttpsHeader</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="#getForwardedPortAsAuthority()" class="member-name-link">getForwardedPortAsAuthority</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="#getForwardedPortHeader()" class="member-name-link">getForwardedPortHeader</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="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 odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getForwardedProtoHeader()" class="member-name-link">getForwardedProtoHeader</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Get the forwardedProtoHeader.</div> |
| </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="#getForwardedServerHeader()" class="member-name-link">getForwardedServerHeader</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="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 odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getForwardedSslSessionIdHeader()" class="member-name-link">getForwardedSslSessionIdHeader</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="#getHostHeader()" class="member-name-link">getHostHeader</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-tab1 method-summary-table-tab4"><code>protected static <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 odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getLeftMost(java.lang.String)" class="member-name-link">getLeftMost</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> headerValue)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> </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="#getProxyAsAuthority()" class="member-name-link">getProxyAsAuthority</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-tab1 method-summary-table-tab4"><code>protected static int</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getSecurePort(org.eclipse.jetty.server.HttpConfiguration)" class="member-name-link">getSecurePort</a><wbr>(<a href="HttpConfiguration.html" title="class in org.eclipse.jetty.server">HttpConfiguration</a> config)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> </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="#isSslIsSecure()" class="member-name-link">isSslIsSecure</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>protected void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#onError(org.eclipse.jetty.http.HttpField,java.lang.Throwable)" class="member-name-link">onError</a><wbr>(<a href="../http/HttpField.html" title="class in org.eclipse.jetty.http">HttpField</a> field, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Throwable.html" title="class or interface in java.lang" class="external-link">Throwable</a> t)</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="#setForcedHost(java.lang.String)" class="member-name-link">setForcedHost</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> hostAndPort)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Set a forced valued for the host header to control what is returned by <code>ServletRequest.getServerName()</code> and <code>ServletRequest.getServerPort()</code>.</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="#setForwardedCipherSuiteHeader(java.lang.String)" class="member-name-link">setForwardedCipherSuiteHeader</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> forwardedCipherSuiteHeader)</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="#setForwardedForHeader(java.lang.String)" class="member-name-link">setForwardedForHeader</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> forwardedRemoteAddressHeader)</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="#setForwardedHeader(java.lang.String)" class="member-name-link">setForwardedHeader</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> forwardedHeader)</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="#setForwardedHostHeader(java.lang.String)" class="member-name-link">setForwardedHostHeader</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> forwardedHostHeader)</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="#setForwardedHttpsHeader(java.lang.String)" class="member-name-link">setForwardedHttpsHeader</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> forwardedHttpsHeader)</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="#setForwardedOnly(boolean)" class="member-name-link">setForwardedOnly</a><wbr>(boolean rfc7239only)</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="#setForwardedPortAsAuthority(boolean)" class="member-name-link">setForwardedPortAsAuthority</a><wbr>(boolean forwardedPortAsAuthority)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Set if the X-Forwarded-Port header will be used for Authority</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="#setForwardedPortHeader(java.lang.String)" class="member-name-link">setForwardedPortHeader</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> forwardedPortHeader)</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="#setForwardedProtoHeader(java.lang.String)" class="member-name-link">setForwardedProtoHeader</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> forwardedProtoHeader)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Set the forwardedProtoHeader.</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="#setForwardedServerHeader(java.lang.String)" class="member-name-link">setForwardedServerHeader</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> forwardedServerHeader)</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="#setForwardedSslSessionIdHeader(java.lang.String)" class="member-name-link">setForwardedSslSessionIdHeader</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> forwardedSslSessionIdHeader)</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="#setHostHeader(java.lang.String)" class="member-name-link">setHostHeader</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> hostHeader)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Set a forced valued for the host header to control what is returned by <code>ServletRequest.getServerName()</code> and <code>ServletRequest.getServerPort()</code>.</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="#setProxyAsAuthority(boolean)" class="member-name-link">setProxyAsAuthority</a><wbr>(boolean proxyAsAuthority)</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="#setSslIsSecure(boolean)" class="member-name-link">setSslIsSecure</a><wbr>(boolean sslIsSecure)</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="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 odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString()" class="member-name-link">toString</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| </div> |
| </div> |
| </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> |
| </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>ForwardedRequestCustomizer</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">ForwardedRequestCustomizer</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="getProxyAsAuthority()"> |
| <h3>getProxyAsAuthority</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">getProxyAsAuthority</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>true if the proxy address obtained via |
| <code>X-Forwarded-Server</code> or RFC7239 "by" is used as |
| the request authority. Default false</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setProxyAsAuthority(boolean)"> |
| <h3>setProxyAsAuthority</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setProxyAsAuthority</span><wbr><span class="parameters">(boolean proxyAsAuthority)</span></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>proxyAsAuthority</code> - if true, use the proxy address obtained via |
| <code>X-Forwarded-Server</code> or RFC7239 "by" as the request authority.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setForwardedOnly(boolean)"> |
| <h3>setForwardedOnly</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setForwardedOnly</span><wbr><span class="parameters">(boolean rfc7239only)</span></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>rfc7239only</code> - Configure to only support the RFC7239 Forwarded header and to |
| not support any <code>X-Forwarded-</code> headers. This convenience method |
| clears all the non RFC headers if passed true and sets them to |
| the default values (if not already set) if passed false.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getForcedHost()"> |
| <h3>getForcedHost</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">getForcedHost</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setForcedHost(java.lang.String)"> |
| <h3>setForcedHost</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setForcedHost</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> hostAndPort)</span></div> |
| <div class="block">Set a forced valued for the host header to control what is returned by <code>ServletRequest.getServerName()</code> and <code>ServletRequest.getServerPort()</code>.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>hostAndPort</code> - The value of the host header to force.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getForwardedHeader()"> |
| <h3>getForwardedHeader</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">getForwardedHeader</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>The header name for RFC forwarded (default Forwarded)</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setForwardedHeader(java.lang.String)"> |
| <h3>setForwardedHeader</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setForwardedHeader</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> forwardedHeader)</span></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>forwardedHeader</code> - The header name for RFC forwarded (default Forwarded)</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getForwardedHostHeader()"> |
| <h3>getForwardedHostHeader</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">getForwardedHostHeader</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setForwardedHostHeader(java.lang.String)"> |
| <h3>setForwardedHostHeader</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setForwardedHostHeader</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> forwardedHostHeader)</span></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>forwardedHostHeader</code> - The header name for forwarded hosts (default <code>X-Forwarded-Host</code>)</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getForwardedServerHeader()"> |
| <h3>getForwardedServerHeader</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">getForwardedServerHeader</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the header name for forwarded server.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setForwardedServerHeader(java.lang.String)"> |
| <h3>setForwardedServerHeader</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setForwardedServerHeader</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> forwardedServerHeader)</span></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>forwardedServerHeader</code> - The header name for forwarded server (default <code>X-Forwarded-Server</code>)</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getForwardedForHeader()"> |
| <h3>getForwardedForHeader</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">getForwardedForHeader</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the forwarded for header</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setForwardedForHeader(java.lang.String)"> |
| <h3>setForwardedForHeader</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setForwardedForHeader</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> forwardedRemoteAddressHeader)</span></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>forwardedRemoteAddressHeader</code> - The header name for forwarded for (default <code>X-Forwarded-For</code>)</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getForwardedPortHeader()"> |
| <h3>getForwardedPortHeader</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">getForwardedPortHeader</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setForwardedPortHeader(java.lang.String)"> |
| <h3>setForwardedPortHeader</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setForwardedPortHeader</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> forwardedPortHeader)</span></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>forwardedPortHeader</code> - The header name for forwarded hosts (default <code>X-Forwarded-Port</code>)</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getForwardedPortAsAuthority()"> |
| <h3>getForwardedPortAsAuthority</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">getForwardedPortAsAuthority</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>if true, the X-Forwarded-Port header applies to the authority, |
| else it applies to the remote client address</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setForwardedPortAsAuthority(boolean)"> |
| <h3>setForwardedPortAsAuthority</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setForwardedPortAsAuthority</span><wbr><span class="parameters">(boolean forwardedPortAsAuthority)</span></div> |
| <div class="block">Set if the X-Forwarded-Port header will be used for Authority</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>forwardedPortAsAuthority</code> - if true, the X-Forwarded-Port header applies to the authority, |
| else it applies to the remote client address</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getForwardedProtoHeader()"> |
| <h3>getForwardedProtoHeader</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">getForwardedProtoHeader</span>()</div> |
| <div class="block">Get the forwardedProtoHeader.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the forwardedProtoHeader (default <code>X-Forwarded-Proto</code>)</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setForwardedProtoHeader(java.lang.String)"> |
| <h3>setForwardedProtoHeader</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setForwardedProtoHeader</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> forwardedProtoHeader)</span></div> |
| <div class="block">Set the forwardedProtoHeader.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>forwardedProtoHeader</code> - the forwardedProtoHeader to set (default <code>X-Forwarded-Proto</code>)</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getForwardedCipherSuiteHeader()"> |
| <h3>getForwardedCipherSuiteHeader</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">getForwardedCipherSuiteHeader</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>The header name holding a forwarded cipher suite (default <code>Proxy-auth-cert</code>)</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setForwardedCipherSuiteHeader(java.lang.String)"> |
| <h3>setForwardedCipherSuiteHeader</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setForwardedCipherSuiteHeader</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> forwardedCipherSuiteHeader)</span></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>forwardedCipherSuiteHeader</code> - The header name holding a forwarded cipher suite (default <code>Proxy-auth-cert</code>)</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getForwardedSslSessionIdHeader()"> |
| <h3>getForwardedSslSessionIdHeader</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">getForwardedSslSessionIdHeader</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>The header name holding a forwarded SSL Session ID (default <code>Proxy-ssl-id</code>)</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setForwardedSslSessionIdHeader(java.lang.String)"> |
| <h3>setForwardedSslSessionIdHeader</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setForwardedSslSessionIdHeader</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> forwardedSslSessionIdHeader)</span></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>forwardedSslSessionIdHeader</code> - The header name holding a forwarded SSL Session ID (default <code>Proxy-ssl-id</code>)</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getForwardedHttpsHeader()"> |
| <h3>getForwardedHttpsHeader</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">getForwardedHttpsHeader</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>The header name holding a forwarded Https status indicator (on|off true|false) (default <code>X-Proxied-Https</code>)</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setForwardedHttpsHeader(java.lang.String)"> |
| <h3>setForwardedHttpsHeader</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setForwardedHttpsHeader</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> forwardedHttpsHeader)</span></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>forwardedHttpsHeader</code> - the header name holding a forwarded Https status indicator(default <code>X-Proxied-Https</code>)</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isSslIsSecure()"> |
| <h3>isSslIsSecure</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isSslIsSecure</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>true if the presence of an SSL session or certificate header is sufficient |
| to indicate a secure request (default is true)</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setSslIsSecure(boolean)"> |
| <h3>setSslIsSecure</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setSslIsSecure</span><wbr><span class="parameters">(boolean sslIsSecure)</span></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>sslIsSecure</code> - true if the presence of an SSL session or certificate header is sufficient |
| to indicate a secure request (default is true)</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="customize(org.eclipse.jetty.server.Connector,org.eclipse.jetty.server.HttpConfiguration,org.eclipse.jetty.server.Request)"> |
| <h3>customize</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">customize</span><wbr><span class="parameters">(<a href="Connector.html" title="interface in org.eclipse.jetty.server">Connector</a> connector, |
| <a href="HttpConfiguration.html" title="class in org.eclipse.jetty.server">HttpConfiguration</a> config, |
| <a href="Request.html" title="class in org.eclipse.jetty.server">Request</a> request)</span></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="HttpConfiguration.Customizer.html#customize(org.eclipse.jetty.server.Connector,org.eclipse.jetty.server.HttpConfiguration,org.eclipse.jetty.server.Request)">customize</a></code> in interface <code><a href="HttpConfiguration.Customizer.html" title="interface in org.eclipse.jetty.server">HttpConfiguration.Customizer</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getSecurePort(org.eclipse.jetty.server.HttpConfiguration)"> |
| <h3>getSecurePort</h3> |
| <div class="member-signature"><span class="modifiers">protected static</span> <span class="return-type">int</span> <span class="element-name">getSecurePort</span><wbr><span class="parameters">(<a href="HttpConfiguration.html" title="class in org.eclipse.jetty.server">HttpConfiguration</a> config)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="onError(org.eclipse.jetty.http.HttpField,java.lang.Throwable)"> |
| <h3>onError</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">void</span> <span class="element-name">onError</span><wbr><span class="parameters">(<a href="../http/HttpField.html" title="class in org.eclipse.jetty.http">HttpField</a> field, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Throwable.html" title="class or interface in java.lang" class="external-link">Throwable</a> t)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getLeftMost(java.lang.String)"> |
| <h3>getLeftMost</h3> |
| <div class="member-signature"><span class="modifiers">protected static</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">getLeftMost</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> headerValue)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="toString()"> |
| <h3>toString</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">toString</span>()</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a></code> in class <code><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></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getHostHeader()"> |
| <h3>getHostHeader</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">getHostHeader</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setHostHeader(java.lang.String)"> |
| <h3>setHostHeader</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setHostHeader</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> hostHeader)</span></div> |
| <div class="block">Set a forced valued for the host header to control what is returned by <code>ServletRequest.getServerName()</code> and <code>ServletRequest.getServerPort()</code>.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>hostHeader</code> - The value of the host header to force.</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> |
