| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.14.1) on Mon Apr 04 09:09:38 CDT 2022 --> |
| <title>HttpRedirector (Eclipse Jetty API Doc - v10.0.9)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2022-04-04"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../../jquery/jquery-3.5.1.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jquery-ui.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="HttpRedirector (Eclipse Jetty API Doc - v10.0.9)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| var pathtoroot = "../../../../"; |
| var useModuleDirectories = true; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/HttpRedirector.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <ul class="navListSearch"> |
| <li><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </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 id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </div> |
| <script type="text/javascript"><!-- |
| $('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
| //--> |
| </script> |
| </nav> |
| </header> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <main role="main"> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.eclipse.jetty.client</a></div> |
| <h2 title="Class HttpRedirector" class="title">Class HttpRedirector</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.eclipse.jetty.client.HttpRedirector</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <pre>public class <span class="typeNameLabel">HttpRedirector</span> |
| extends java.lang.Object</pre> |
| <div class="block">Utility class that handles HTTP redirects. |
| <p> |
| Applications can disable redirection via <a href="api/Request.html#followRedirects(boolean)"><code>Request.followRedirects(boolean)</code></a> |
| and then rely on this class to perform the redirect in a simpler way, for example: |
| <pre> |
| HttpRedirector redirector = new HttpRedirector(httpClient); |
| |
| Request request = httpClient.newRequest("http://host/path").followRedirects(false); |
| ContentResponse response = request.send(); |
| while (redirector.isRedirect(response)) |
| { |
| // Validate the redirect URI |
| if (!validate(redirector.extractRedirectURI(response))) |
| break; |
| |
| Result result = redirector.redirect(request, response); |
| request = result.getRequest(); |
| response = result.getResponse(); |
| } |
| </pre></div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Constructor</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.eclipse.jetty.client.HttpClient)">HttpRedirector</a></span>​(<a href="HttpClient.html" title="class in org.eclipse.jetty.client">HttpClient</a> client)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </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></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>java.net.URI</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#extractRedirectURI(org.eclipse.jetty.client.api.Response)">extractRedirectURI</a></span>​(<a href="api/Response.html" title="interface in org.eclipse.jetty.client.api">Response</a> response)</code></th> |
| <td class="colLast"> |
| <div class="block">Extracts and sanitizes (by making it absolute and escaping paths and query parameters) |
| the redirect URI of the given <code>response</code>.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#fail(org.eclipse.jetty.client.api.Request,java.lang.Throwable,org.eclipse.jetty.client.api.Response)">fail</a></span>​(<a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a> request, |
| java.lang.Throwable failure, |
| <a href="api/Response.html" title="interface in org.eclipse.jetty.client.api">Response</a> response)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#fail(org.eclipse.jetty.client.api.Request,org.eclipse.jetty.client.api.Response,java.lang.Throwable)">fail</a></span>​(<a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a> request, |
| <a href="api/Response.html" title="interface in org.eclipse.jetty.client.api">Response</a> response, |
| java.lang.Throwable failure)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isRedirect(org.eclipse.jetty.client.api.Response)">isRedirect</a></span>​(<a href="api/Response.html" title="interface in org.eclipse.jetty.client.api">Response</a> response)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="api/Result.html" title="class in org.eclipse.jetty.client.api">Result</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#redirect(org.eclipse.jetty.client.api.Request,org.eclipse.jetty.client.api.Response)">redirect</a></span>​(<a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a> request, |
| <a href="api/Response.html" title="interface in org.eclipse.jetty.client.api">Response</a> response)</code></th> |
| <td class="colLast"> |
| <div class="block">Redirects the given <code>response</code>, blocking until the redirect is complete.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#redirect(org.eclipse.jetty.client.api.Request,org.eclipse.jetty.client.api.Response,org.eclipse.jetty.client.api.Response.CompleteListener)">redirect</a></span>​(<a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a> request, |
| <a href="api/Response.html" title="interface in org.eclipse.jetty.client.api">Response</a> response, |
| <a href="api/Response.CompleteListener.html" title="interface in org.eclipse.jetty.client.api">Response.CompleteListener</a> listener)</code></th> |
| <td class="colLast"> |
| <div class="block">Redirects the given <code>response</code> asynchronously.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="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, toString, wait, wait, wait</code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a id="<init>(org.eclipse.jetty.client.HttpClient)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>HttpRedirector</h4> |
| <pre>public HttpRedirector​(<a href="HttpClient.html" title="class in org.eclipse.jetty.client">HttpClient</a> client)</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="isRedirect(org.eclipse.jetty.client.api.Response)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isRedirect</h4> |
| <pre class="methodSignature">public boolean isRedirect​(<a href="api/Response.html" title="interface in org.eclipse.jetty.client.api">Response</a> response)</pre> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>response</code> - the response to check for redirects</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>whether the response code is an HTTP redirect code</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="redirect(org.eclipse.jetty.client.api.Request,org.eclipse.jetty.client.api.Response)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>redirect</h4> |
| <pre class="methodSignature">public <a href="api/Result.html" title="class in org.eclipse.jetty.client.api">Result</a> redirect​(<a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a> request, |
| <a href="api/Response.html" title="interface in org.eclipse.jetty.client.api">Response</a> response) |
| throws java.lang.InterruptedException, |
| java.util.concurrent.ExecutionException</pre> |
| <div class="block">Redirects the given <code>response</code>, blocking until the redirect is complete.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>request</code> - the original request that triggered the redirect</dd> |
| <dd><code>response</code> - the response to the original request</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a <a href="api/Result.html" title="class in org.eclipse.jetty.client.api"><code>Result</code></a> object containing the request to the redirected location and its response</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.InterruptedException</code> - if the thread is interrupted while waiting for the redirect to complete</dd> |
| <dd><code>java.util.concurrent.ExecutionException</code> - if the redirect failed</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#redirect(org.eclipse.jetty.client.api.Request,org.eclipse.jetty.client.api.Response,org.eclipse.jetty.client.api.Response.CompleteListener)"><code>redirect(Request, Response, Response.CompleteListener)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="redirect(org.eclipse.jetty.client.api.Request,org.eclipse.jetty.client.api.Response,org.eclipse.jetty.client.api.Response.CompleteListener)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>redirect</h4> |
| <pre class="methodSignature">public <a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a> redirect​(<a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a> request, |
| <a href="api/Response.html" title="interface in org.eclipse.jetty.client.api">Response</a> response, |
| <a href="api/Response.CompleteListener.html" title="interface in org.eclipse.jetty.client.api">Response.CompleteListener</a> listener)</pre> |
| <div class="block">Redirects the given <code>response</code> asynchronously.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>request</code> - the original request that triggered the redirect</dd> |
| <dd><code>response</code> - the response to the original request</dd> |
| <dd><code>listener</code> - the listener that receives response events</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the request to the redirected location</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="extractRedirectURI(org.eclipse.jetty.client.api.Response)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>extractRedirectURI</h4> |
| <pre class="methodSignature">public java.net.URI extractRedirectURI​(<a href="api/Response.html" title="interface in org.eclipse.jetty.client.api">Response</a> response)</pre> |
| <div class="block">Extracts and sanitizes (by making it absolute and escaping paths and query parameters) |
| the redirect URI of the given <code>response</code>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>response</code> - the response to extract the redirect URI from</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the absolute redirect URI, or null if the response does not contain a valid redirect location</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="fail(org.eclipse.jetty.client.api.Request,org.eclipse.jetty.client.api.Response,java.lang.Throwable)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>fail</h4> |
| <pre class="methodSignature">protected void fail​(<a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a> request, |
| <a href="api/Response.html" title="interface in org.eclipse.jetty.client.api">Response</a> response, |
| java.lang.Throwable failure)</pre> |
| </li> |
| </ul> |
| <a id="fail(org.eclipse.jetty.client.api.Request,java.lang.Throwable,org.eclipse.jetty.client.api.Response)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>fail</h4> |
| <pre class="methodSignature">protected void fail​(<a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a> request, |
| java.lang.Throwable failure, |
| <a href="api/Response.html" title="interface in org.eclipse.jetty.client.api">Response</a> response)</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </main> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/HttpRedirector.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </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 id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 1995–2022 <a href="https://webtide.com">Webtide</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |
