| <!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:31 EDT 2018 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>HttpConversation (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="HttpConversation (Jetty :: Project 9.3.24.v20180605 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":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"; |
| </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/HttpConversation.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/client/HttpContentResponse.html" title="class in org.eclipse.jetty.client"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/eclipse/jetty/client/HttpDestination.html" title="class in org.eclipse.jetty.client"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/eclipse/jetty/client/HttpConversation.html" target="_top">Frames</a></li> |
| <li><a href="HttpConversation.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.client</div> |
| <h2 title="Class HttpConversation" class="title">Class HttpConversation</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../org/eclipse/jetty/util/AttributesMap.html" title="class in org.eclipse.jetty.util">org.eclipse.jetty.util.AttributesMap</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.eclipse.jetty.client.HttpConversation</li> |
| </ul> |
| </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/util/Attributes.html" title="interface in org.eclipse.jetty.util">Attributes</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">HttpConversation</span> |
| extends <a href="../../../../org/eclipse/jetty/util/AttributesMap.html" title="class in org.eclipse.jetty.util">AttributesMap</a></pre> |
| </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/client/HttpConversation.html#HttpConversation--">HttpConversation</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></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>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/jetty/client/HttpConversation.html#abort-java.lang.Throwable-">abort</a></span>(java.lang.Throwable cause)</code> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>java.util.Deque<<a href="../../../../org/eclipse/jetty/client/HttpExchange.html" title="class in org.eclipse.jetty.client">HttpExchange</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/jetty/client/HttpConversation.html#getExchanges--">getExchanges</a></span>()</code> </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>java.util.List<<a href="../../../../org/eclipse/jetty/client/api/Response.ResponseListener.html" title="interface in org.eclipse.jetty.client.api">Response.ResponseListener</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/jetty/client/HttpConversation.html#getResponseListeners--">getResponseListeners</a></span>()</code> |
| <div class="block">Returns the list of response listeners that needs to be notified of response events.</div> |
| </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/client/HttpConversation.html#toString--">toString</a></span>()</code> </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/jetty/client/HttpConversation.html#updateResponseListeners-org.eclipse.jetty.client.api.Response.ResponseListener-">updateResponseListeners</a></span>(<a href="../../../../org/eclipse/jetty/client/api/Response.ResponseListener.html" title="interface in org.eclipse.jetty.client.api">Response.ResponseListener</a> overrideListener)</code> |
| <div class="block">Requests to update the response listener, eventually using the given override response listener, |
| that must be notified instead of the first exchange response listeners.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.eclipse.jetty.util.AttributesMap"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.eclipse.jetty.util.<a href="../../../../org/eclipse/jetty/util/AttributesMap.html" title="class in org.eclipse.jetty.util">AttributesMap</a></h3> |
| <code><a href="../../../../org/eclipse/jetty/util/AttributesMap.html#addAll-org.eclipse.jetty.util.Attributes-">addAll</a>, <a href="../../../../org/eclipse/jetty/util/AttributesMap.html#clearAttributes--">clearAttributes</a>, <a href="../../../../org/eclipse/jetty/util/AttributesMap.html#getAttribute-java.lang.String-">getAttribute</a>, <a href="../../../../org/eclipse/jetty/util/AttributesMap.html#getAttributeEntrySet--">getAttributeEntrySet</a>, <a href="../../../../org/eclipse/jetty/util/AttributesMap.html#getAttributeNames--">getAttributeNames</a>, <a href="../../../../org/eclipse/jetty/util/AttributesMap.html#getAttributeNamesCopy-org.eclipse.jetty.util.Attributes-">getAttributeNamesCopy</a>, <a href="../../../../org/eclipse/jetty/util/AttributesMap.html#getAttributeNameSet--">getAttributeNameSet</a>, <a href="../../../../org/eclipse/jetty/util/AttributesMap.html#removeAttribute-java.lang.String-">removeAttribute</a>, <a href="../../../../org/eclipse/jetty/util/AttributesMap.html#setAttribute-java.lang.String-java.lang.Object-">setAttribute</a>, <a href="../../../../org/eclipse/jetty/util/AttributesMap.html#size--">size</a></code></li> |
| </ul> |
| <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="HttpConversation--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>HttpConversation</h4> |
| <pre>public HttpConversation()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getExchanges--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getExchanges</h4> |
| <pre>public java.util.Deque<<a href="../../../../org/eclipse/jetty/client/HttpExchange.html" title="class in org.eclipse.jetty.client">HttpExchange</a>> getExchanges()</pre> |
| </li> |
| </ul> |
| <a name="getResponseListeners--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getResponseListeners</h4> |
| <pre>public java.util.List<<a href="../../../../org/eclipse/jetty/client/api/Response.ResponseListener.html" title="interface in org.eclipse.jetty.client.api">Response.ResponseListener</a>> getResponseListeners()</pre> |
| <div class="block">Returns the list of response listeners that needs to be notified of response events. |
| This list changes as the conversation proceeds, as follows: |
| <ol> |
| <li> |
| request R1 send => conversation.updateResponseListeners(null) |
| <ul> |
| <li>exchanges in conversation: E1</li> |
| <li>listeners to be notified: E1.listeners</li> |
| </ul> |
| </li> |
| <li> |
| response R1 arrived, 401 => conversation.updateResponseListeners(AuthenticationProtocolHandler.listener) |
| <ul> |
| <li>exchanges in conversation: E1</li> |
| <li>listeners to be notified: AuthenticationProtocolHandler.listener</li> |
| </ul> |
| </li> |
| <li> |
| request R2 send => conversation.updateResponseListeners(null) |
| <ul> |
| <li>exchanges in conversation: E1 + E2</li> |
| <li>listeners to be notified: E2.listeners + E1.listeners</li> |
| </ul> |
| </li> |
| <li> |
| response R2 arrived, 302 => conversation.updateResponseListeners(RedirectProtocolHandler.listener) |
| <ul> |
| <li>exchanges in conversation: E1 + E2</li> |
| <li>listeners to be notified: E2.listeners + RedirectProtocolHandler.listener</li> |
| </ul> |
| </li> |
| <li> |
| request R3 send => conversation.updateResponseListeners(null) |
| <ul> |
| <li>exchanges in conversation: E1 + E2 + E3</li> |
| <li>listeners to be notified: E3.listeners + E1.listeners</li> |
| </ul> |
| </li> |
| <li> |
| response R3 arrived, 200 => conversation.updateResponseListeners(null) |
| <ul> |
| <li>exchanges in conversation: E1 + E2 + E3</li> |
| <li>listeners to be notified: E3.listeners + E1.listeners</li> |
| </ul> |
| </li> |
| </ol> |
| Basically the override conversation listener replaces the first exchange response listener, |
| and we also notify the last exchange response listeners (if it's not also the first). |
| |
| This scheme allows for protocol handlers to not worry about other protocol handlers, or to worry |
| too much about notifying the first exchange response listeners, but still allowing a protocol |
| handler to perform completion activities while another protocol handler performs new ones (as an |
| example, the <a href="../../../../org/eclipse/jetty/client/AuthenticationProtocolHandler.html" title="class in org.eclipse.jetty.client"><code>AuthenticationProtocolHandler</code></a> stores the successful authentication credentials |
| while the <a href="../../../../org/eclipse/jetty/client/RedirectProtocolHandler.html" title="class in org.eclipse.jetty.client"><code>RedirectProtocolHandler</code></a> performs a redirect).</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the list of response listeners that needs to be notified of response events</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="updateResponseListeners-org.eclipse.jetty.client.api.Response.ResponseListener-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>updateResponseListeners</h4> |
| <pre>public void updateResponseListeners(<a href="../../../../org/eclipse/jetty/client/api/Response.ResponseListener.html" title="interface in org.eclipse.jetty.client.api">Response.ResponseListener</a> overrideListener)</pre> |
| <div class="block">Requests to update the response listener, eventually using the given override response listener, |
| that must be notified instead of the first exchange response listeners. |
| This works in conjunction with <a href="../../../../org/eclipse/jetty/client/HttpConversation.html#getResponseListeners--"><code>getResponseListeners()</code></a>, returning the appropriate response |
| listeners that needs to be notified of response events.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>overrideListener</code> - the override response listener</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="abort-java.lang.Throwable-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>abort</h4> |
| <pre>public boolean abort(java.lang.Throwable cause)</pre> |
| </li> |
| </ul> |
| <a name="toString--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>toString</h4> |
| <pre>public java.lang.String toString()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../org/eclipse/jetty/util/AttributesMap.html#toString--">toString</a></code> in class <code><a href="../../../../org/eclipse/jetty/util/AttributesMap.html" title="class in org.eclipse.jetty.util">AttributesMap</a></code></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/HttpConversation.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/client/HttpContentResponse.html" title="class in org.eclipse.jetty.client"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/eclipse/jetty/client/HttpDestination.html" title="class in org.eclipse.jetty.client"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/eclipse/jetty/client/HttpConversation.html" target="_top">Frames</a></li> |
| <li><a href="HttpConversation.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> |
