| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (1.8.0_92) on Thu Jun 07 14:26:28 EDT 2018 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>ForwardedRequestCustomizer (Jetty :: Project 9.3.24.v20180605 API)</title> |
| <meta name="date" content="2018-06-07"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="ForwardedRequestCustomizer (Jetty :: Project 9.3.24.v20180605 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":42,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":42,"i25":10,"i26":10,"i27":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">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">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/eclipse/jetty/server/EncodingHttpWriter.html" title="class in org.eclipse.jetty.server"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/eclipse/jetty/server/Handler.html" title="interface in org.eclipse.jetty.server"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/eclipse/jetty/server/ForwardedRequestCustomizer.html" target="_top">Frames</a></li> |
| <li><a href="ForwardedRequestCustomizer.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.eclipse.jetty.server</div> |
| <h2 title="Class ForwardedRequestCustomizer" class="title">Class ForwardedRequestCustomizer</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.eclipse.jetty.server.ForwardedRequestCustomizer</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="../../../../org/eclipse/jetty/server/HttpConfiguration.Customizer.html" title="interface in org.eclipse.jetty.server">HttpConfiguration.Customizer</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">ForwardedRequestCustomizer</span> |
| extends java.lang.Object |
| implements <a href="../../../../org/eclipse/jetty/server/HttpConfiguration.Customizer.html" title="interface in org.eclipse.jetty.server">HttpConfiguration.Customizer</a></pre> |
| <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="../../../../org/eclipse/jetty/server/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></div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="http://en.wikipedia.org/wiki/X-Forwarded-For">Wikipedia: X-Forwarded-For</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/eclipse/jetty/server/ForwardedRequestCustomizer.html#ForwardedRequestCustomizer--">ForwardedRequestCustomizer</a></span>()</code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/jetty/server/ForwardedRequestCustomizer.html#customize-org.eclipse.jetty.server.Connector-org.eclipse.jetty.server.HttpConfiguration-org.eclipse.jetty.server.Request-">customize</a></span>(<a href="../../../../org/eclipse/jetty/server/Connector.html" title="interface in org.eclipse.jetty.server">Connector</a> connector, |
| <a href="../../../../org/eclipse/jetty/server/HttpConfiguration.html" title="class in org.eclipse.jetty.server">HttpConfiguration</a> config, |
| <a href="../../../../org/eclipse/jetty/server/Request.html" title="class in org.eclipse.jetty.server">Request</a> request)</code> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/jetty/server/ForwardedRequestCustomizer.html#getForcedHost--">getForcedHost</a></span>()</code> </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/jetty/server/ForwardedRequestCustomizer.html#getForwardedCipherSuiteHeader--">getForwardedCipherSuiteHeader</a></span>()</code> </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/jetty/server/ForwardedRequestCustomizer.html#getForwardedForHeader--">getForwardedForHeader</a></span>()</code> </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/jetty/server/ForwardedRequestCustomizer.html#getForwardedHeader--">getForwardedHeader</a></span>()</code> </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/jetty/server/ForwardedRequestCustomizer.html#getForwardedHostHeader--">getForwardedHostHeader</a></span>()</code> </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/jetty/server/ForwardedRequestCustomizer.html#getForwardedHttpsHeader--">getForwardedHttpsHeader</a></span>()</code> </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/jetty/server/ForwardedRequestCustomizer.html#getForwardedProtoHeader--">getForwardedProtoHeader</a></span>()</code> |
| <div class="block">Get the forwardedProtoHeader.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/jetty/server/ForwardedRequestCustomizer.html#getForwardedServerHeader--">getForwardedServerHeader</a></span>()</code> </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/jetty/server/ForwardedRequestCustomizer.html#getForwardedSslSessionIdHeader--">getForwardedSslSessionIdHeader</a></span>()</code> </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/jetty/server/ForwardedRequestCustomizer.html#getHostHeader--">getHostHeader</a></span>()</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>protected java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/jetty/server/ForwardedRequestCustomizer.html#getLeftMost-java.lang.String-">getLeftMost</a></span>(java.lang.String headerValue)</code> </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/jetty/server/ForwardedRequestCustomizer.html#getProxyAsAuthority--">getProxyAsAuthority</a></span>()</code> </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/jetty/server/ForwardedRequestCustomizer.html#isSslIsSecure--">isSslIsSecure</a></span>()</code> </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/jetty/server/ForwardedRequestCustomizer.html#setForcedHost-java.lang.String-">setForcedHost</a></span>(java.lang.String hostAndPort)</code> |
| <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> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/jetty/server/ForwardedRequestCustomizer.html#setForwardedCipherSuiteHeader-java.lang.String-">setForwardedCipherSuiteHeader</a></span>(java.lang.String forwardedCipherSuite)</code> </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/jetty/server/ForwardedRequestCustomizer.html#setForwardedForHeader-java.lang.String-">setForwardedForHeader</a></span>(java.lang.String forwardedRemoteAddressHeader)</code> </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/jetty/server/ForwardedRequestCustomizer.html#setForwardedHeader-java.lang.String-">setForwardedHeader</a></span>(java.lang.String forwardedHeader)</code> </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/jetty/server/ForwardedRequestCustomizer.html#setForwardedHostHeader-java.lang.String-">setForwardedHostHeader</a></span>(java.lang.String forwardedHostHeader)</code> </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/jetty/server/ForwardedRequestCustomizer.html#setForwardedHttpsHeader-java.lang.String-">setForwardedHttpsHeader</a></span>(java.lang.String forwardedHttpsHeader)</code> </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/jetty/server/ForwardedRequestCustomizer.html#setForwardedOnly-boolean-">setForwardedOnly</a></span>(boolean rfc7239only)</code> |
| <div class="block">Configure to only support the RFC7239 Forwarded header and to |
| not support any <code>X-Forwarded-</code> headers.</div> |
| </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/jetty/server/ForwardedRequestCustomizer.html#setForwardedProtoHeader-java.lang.String-">setForwardedProtoHeader</a></span>(java.lang.String forwardedProtoHeader)</code> |
| <div class="block">Set the forwardedProtoHeader.</div> |
| </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/jetty/server/ForwardedRequestCustomizer.html#setForwardedServerHeader-java.lang.String-">setForwardedServerHeader</a></span>(java.lang.String forwardedServerHeader)</code> </td> |
| </tr> |
| <tr id="i23" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/jetty/server/ForwardedRequestCustomizer.html#setForwardedSslSessionIdHeader-java.lang.String-">setForwardedSslSessionIdHeader</a></span>(java.lang.String forwardedSslSessionId)</code> </td> |
| </tr> |
| <tr id="i24" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/jetty/server/ForwardedRequestCustomizer.html#setHostHeader-java.lang.String-">setHostHeader</a></span>(java.lang.String hostHeader)</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| </td> |
| </tr> |
| <tr id="i25" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/jetty/server/ForwardedRequestCustomizer.html#setProxyAsAuthority-boolean-">setProxyAsAuthority</a></span>(boolean proxyAsAuthority)</code> </td> |
| </tr> |
| <tr id="i26" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/jetty/server/ForwardedRequestCustomizer.html#setSslIsSecure-boolean-">setSslIsSecure</a></span>(boolean sslIsSecure)</code> </td> |
| </tr> |
| <tr id="i27" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/jetty/server/ForwardedRequestCustomizer.html#toString--">toString</a></span>()</code> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.Object</h3> |
| <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="ForwardedRequestCustomizer--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>ForwardedRequestCustomizer</h4> |
| <pre>public ForwardedRequestCustomizer()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getProxyAsAuthority--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getProxyAsAuthority</h4> |
| <pre>public boolean getProxyAsAuthority()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></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> |
| </li> |
| </ul> |
| <a name="setProxyAsAuthority-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setProxyAsAuthority</h4> |
| <pre>public void setProxyAsAuthority(boolean proxyAsAuthority)</pre> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></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> |
| </li> |
| </ul> |
| <a name="setForwardedOnly-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setForwardedOnly</h4> |
| <pre>public void setForwardedOnly(boolean rfc7239only)</pre> |
| <div class="block">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.</div> |
| </li> |
| </ul> |
| <a name="getForcedHost--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getForcedHost</h4> |
| <pre>public java.lang.String getForcedHost()</pre> |
| </li> |
| </ul> |
| <a name="setForcedHost-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setForcedHost</h4> |
| <pre>public void setForcedHost(java.lang.String hostAndPort)</pre> |
| <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> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>hostAndPort</code> - The value of the host header to force.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getForwardedHeader--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getForwardedHeader</h4> |
| <pre>public java.lang.String getForwardedHeader()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The header name for RFC forwarded (default Forwarded)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setForwardedHeader-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setForwardedHeader</h4> |
| <pre>public void setForwardedHeader(java.lang.String forwardedHeader)</pre> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>forwardedHeader</code> - The header name for RFC forwarded (default Forwarded)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getForwardedHostHeader--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getForwardedHostHeader</h4> |
| <pre>public java.lang.String getForwardedHostHeader()</pre> |
| </li> |
| </ul> |
| <a name="setForwardedHostHeader-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setForwardedHostHeader</h4> |
| <pre>public void setForwardedHostHeader(java.lang.String forwardedHostHeader)</pre> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>forwardedHostHeader</code> - The header name for forwarded hosts (default <code>X-Forwarded-Host</code>)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getForwardedServerHeader--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getForwardedServerHeader</h4> |
| <pre>public java.lang.String getForwardedServerHeader()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the header name for forwarded server.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setForwardedServerHeader-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setForwardedServerHeader</h4> |
| <pre>public void setForwardedServerHeader(java.lang.String forwardedServerHeader)</pre> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>forwardedServerHeader</code> - The header name for forwarded server (default <code>X-Forwarded-Server</code>)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getForwardedForHeader--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getForwardedForHeader</h4> |
| <pre>public java.lang.String getForwardedForHeader()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the forwarded for header</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setForwardedForHeader-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setForwardedForHeader</h4> |
| <pre>public void setForwardedForHeader(java.lang.String forwardedRemoteAddressHeader)</pre> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>forwardedRemoteAddressHeader</code> - The header name for forwarded for (default <code>X-Forwarded-For</code>)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getForwardedProtoHeader--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getForwardedProtoHeader</h4> |
| <pre>public java.lang.String getForwardedProtoHeader()</pre> |
| <div class="block">Get the forwardedProtoHeader.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the forwardedProtoHeader (default <code>X-Forwarded-Proto</code>)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setForwardedProtoHeader-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setForwardedProtoHeader</h4> |
| <pre>public void setForwardedProtoHeader(java.lang.String forwardedProtoHeader)</pre> |
| <div class="block">Set the forwardedProtoHeader.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>forwardedProtoHeader</code> - the forwardedProtoHeader to set (default <code>X-Forwarded-Proto</code>)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getForwardedCipherSuiteHeader--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getForwardedCipherSuiteHeader</h4> |
| <pre>public java.lang.String getForwardedCipherSuiteHeader()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The header name holding a forwarded cipher suite (default <code>Proxy-auth-cert</code>)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setForwardedCipherSuiteHeader-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setForwardedCipherSuiteHeader</h4> |
| <pre>public void setForwardedCipherSuiteHeader(java.lang.String forwardedCipherSuite)</pre> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>forwardedCipherSuite</code> - The header name holding a forwarded cipher suite (default <code>Proxy-auth-cert</code>)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getForwardedSslSessionIdHeader--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getForwardedSslSessionIdHeader</h4> |
| <pre>public java.lang.String getForwardedSslSessionIdHeader()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The header name holding a forwarded SSL Session ID (default <code>Proxy-ssl-id</code>)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setForwardedSslSessionIdHeader-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setForwardedSslSessionIdHeader</h4> |
| <pre>public void setForwardedSslSessionIdHeader(java.lang.String forwardedSslSessionId)</pre> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>forwardedSslSessionId</code> - The header name holding a forwarded SSL Session ID (default <code>Proxy-ssl-id</code>)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getForwardedHttpsHeader--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getForwardedHttpsHeader</h4> |
| <pre>public java.lang.String getForwardedHttpsHeader()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The header name holding a forwarded Https status indicator (on|off true|false) (default <code>X-Proxied-Https</code>)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setForwardedHttpsHeader-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setForwardedHttpsHeader</h4> |
| <pre>public void setForwardedHttpsHeader(java.lang.String forwardedHttpsHeader)</pre> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>forwardedHttpsHeader</code> - the header name holding a forwarded Https status indicator(default <code>X-Proxied-Https</code>)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isSslIsSecure--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isSslIsSecure</h4> |
| <pre>public boolean isSslIsSecure()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if the presence of a SSL session or certificate header is sufficient |
| to indicate a secure request (default is true)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setSslIsSecure-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSslIsSecure</h4> |
| <pre>public void setSslIsSecure(boolean sslIsSecure)</pre> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>sslIsSecure</code> - true if the presence of a SSL session or certificate header is sufficient |
| to indicate a secure request (default is true)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="customize-org.eclipse.jetty.server.Connector-org.eclipse.jetty.server.HttpConfiguration-org.eclipse.jetty.server.Request-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>customize</h4> |
| <pre>public void customize(<a href="../../../../org/eclipse/jetty/server/Connector.html" title="interface in org.eclipse.jetty.server">Connector</a> connector, |
| <a href="../../../../org/eclipse/jetty/server/HttpConfiguration.html" title="class in org.eclipse.jetty.server">HttpConfiguration</a> config, |
| <a href="../../../../org/eclipse/jetty/server/Request.html" title="class in org.eclipse.jetty.server">Request</a> request)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/eclipse/jetty/server/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="../../../../org/eclipse/jetty/server/HttpConfiguration.Customizer.html" title="interface in org.eclipse.jetty.server">HttpConfiguration.Customizer</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getLeftMost-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLeftMost</h4> |
| <pre>protected java.lang.String getLeftMost(java.lang.String headerValue)</pre> |
| </li> |
| </ul> |
| <a name="toString--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toString</h4> |
| <pre>public java.lang.String toString()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code>toString</code> in class <code>java.lang.Object</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getHostHeader--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getHostHeader</h4> |
| <pre>@Deprecated |
| public java.lang.String getHostHeader()</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| </li> |
| </ul> |
| <a name="setHostHeader-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>setHostHeader</h4> |
| <pre>@Deprecated |
| public void setHostHeader(java.lang.String hostHeader)</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</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> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>hostHeader</code> - The value of the host header to force.</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">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">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/eclipse/jetty/server/EncodingHttpWriter.html" title="class in org.eclipse.jetty.server"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/eclipse/jetty/server/Handler.html" title="interface in org.eclipse.jetty.server"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/eclipse/jetty/server/ForwardedRequestCustomizer.html" target="_top">Frames</a></li> |
| <li><a href="ForwardedRequestCustomizer.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 1995–2018 <a href="http://webtide.com">Webtide</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
