| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.11) on Wed May 12 10:10:59 EDT 2021 --> |
| <title>ClientDelivery (Qpid ProtonJ2 Parent 1.0.0-M1 API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2021-05-12"> |
| <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="ClientDelivery (Qpid ProtonJ2 Parent 1.0.0-M1 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":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/ClientDelivery.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>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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.apache.qpid.protonj2.client.impl</a></div> |
| <h2 title="Class ClientDelivery" class="title">Class ClientDelivery</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.qpid.protonj2.client.impl.ClientDelivery</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="../Delivery.html" title="interface in org.apache.qpid.protonj2.client">Delivery</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public final class <span class="typeNameLabel">ClientDelivery</span> |
| extends java.lang.Object |
| implements <a href="../Delivery.html" title="interface in org.apache.qpid.protonj2.client">Delivery</a></pre> |
| <div class="block">Client inbound delivery object.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== 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><a href="../Delivery.html" title="interface in org.apache.qpid.protonj2.client">Delivery</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#accept()">accept</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Accepts and settles the delivery.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>java.util.Map<java.lang.String,​java.lang.Object></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#annotations()">annotations</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Decodes the <a href="../Delivery.html" title="interface in org.apache.qpid.protonj2.client"><code>Delivery</code></a> payload and returns a <code>Map</code> containing a copy |
| of any associated <a href="../../types/messaging/DeliveryAnnotations.html" title="class in org.apache.qpid.protonj2.types.messaging"><code>DeliveryAnnotations</code></a> that were transmitted with the <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a> |
| payload of this <a href="../Delivery.html" title="interface in org.apache.qpid.protonj2.client"><code>Delivery</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../Delivery.html" title="interface in org.apache.qpid.protonj2.client">Delivery</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#disposition(org.apache.qpid.protonj2.client.DeliveryState,boolean)">disposition</a></span>​(<a href="../DeliveryState.html" title="interface in org.apache.qpid.protonj2.client">DeliveryState</a> state, |
| boolean settle)</code></th> |
| <td class="colLast"> |
| <div class="block">Updates the DeliveryState, and optionally settle the delivery as well.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><E> <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a><E></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#message()">message</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Decode the <a href="../Delivery.html" title="interface in org.apache.qpid.protonj2.client"><code>Delivery</code></a> payload and return an <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a> object.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#messageFormat()">messageFormat</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Gets the message format for the current delivery.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="../Delivery.html" title="interface in org.apache.qpid.protonj2.client">Delivery</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#modified(boolean,boolean)">modified</a></span>​(boolean deliveryFailed, |
| boolean undeliverableHere)</code></th> |
| <td class="colLast"> |
| <div class="block">Modifies and settles the delivery.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>java.io.InputStream</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#rawInputStream()">rawInputStream</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Create and return an <code>InputStream</code> that reads the raw payload bytes of the given <a href="../Delivery.html" title="interface in org.apache.qpid.protonj2.client"><code>Delivery</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="../Receiver.html" title="interface in org.apache.qpid.protonj2.client">Receiver</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#receiver()">receiver</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="../Delivery.html" title="interface in org.apache.qpid.protonj2.client">Delivery</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#reject(java.lang.String,java.lang.String)">reject</a></span>​(java.lang.String condition, |
| java.lang.String description)</code></th> |
| <td class="colLast"> |
| <div class="block">Rejects and settles the delivery, sending supplied error information along |
| with the rejection.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="../Delivery.html" title="interface in org.apache.qpid.protonj2.client">Delivery</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#release()">release</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Releases and settles the delivery.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#remoteSettled()">remoteSettled</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Gets whether the delivery was settled by the remote peer yet.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code><a href="../DeliveryState.html" title="interface in org.apache.qpid.protonj2.client">DeliveryState</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#remoteState()">remoteState</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Gets the current remote state for the delivery.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code><a href="../Delivery.html" title="interface in org.apache.qpid.protonj2.client">Delivery</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#settle()">settle</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Settles the delivery locally.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#settled()">settled</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code><a href="../DeliveryState.html" title="interface in org.apache.qpid.protonj2.client">DeliveryState</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#state()">state</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Gets the current local state for the delivery.</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"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="message()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>message</h4> |
| <pre class="methodSignature">public <E> <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a><E> message() |
| throws <a href="../exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Delivery.html#message()">Delivery</a></code></span></div> |
| <div class="block">Decode the <a href="../Delivery.html" title="interface in org.apache.qpid.protonj2.client"><code>Delivery</code></a> payload and return an <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a> object. |
| <p> |
| If the incoming message carried any delivery annotations they can be accessed via the |
| <a href="../Delivery.html#annotations()"><code>Delivery.annotations()</code></a> method. Re-sending the returned message will not also |
| send the incoming delivery annotations, the sender must include them in the |
| <a href="../Sender.html#send(org.apache.qpid.protonj2.client.Message,java.util.Map)"><code>Sender.send(Message, Map)</code></a> call if they are to be forwarded onto the next recipient. |
| <p> |
| Calling this message claims the payload of the delivery for the returned <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a> and |
| excludes use of the <a href="../Delivery.html#rawInputStream()"><code>Delivery.rawInputStream()</code></a> method of the <a href="../Delivery.html" title="interface in org.apache.qpid.protonj2.client"><code>Delivery</code></a> object. Calling |
| the <a href="../Delivery.html#rawInputStream()"><code>Delivery.rawInputStream()</code></a> method after calling this method throws <a href="../exceptions/ClientIllegalStateException.html" title="class in org.apache.qpid.protonj2.client.exceptions"><code>ClientIllegalStateException</code></a>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Delivery.html#message()">message</a></code> in interface <code><a href="../Delivery.html" title="interface in org.apache.qpid.protonj2.client">Delivery</a></code></dd> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>E</code> - The type of message body that should be contained in the returned <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a>.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a> instance that wraps the decoded payload.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></code> - if an error occurs while decoding the payload.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="rawInputStream()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>rawInputStream</h4> |
| <pre class="methodSignature">public java.io.InputStream rawInputStream() |
| throws <a href="../exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Delivery.html#rawInputStream()">Delivery</a></code></span></div> |
| <div class="block">Create and return an <code>InputStream</code> that reads the raw payload bytes of the given <a href="../Delivery.html" title="interface in org.apache.qpid.protonj2.client"><code>Delivery</code></a>. |
| <p> |
| Calling this method claims the payload of the delivery for the returned <code>InputStream</code> and excludes |
| use of the <a href="../Delivery.html#message()"><code>Delivery.message()</code></a> and <a href="../Delivery.html#annotations()"><code>Delivery.annotations()</code></a> methods of the <a href="../Delivery.html" title="interface in org.apache.qpid.protonj2.client"><code>Delivery</code></a> object. Closing |
| the returned input stream discards any unread bytes from the delivery payload. Calling the <a href="../Delivery.html#message()"><code>Delivery.message()</code></a> |
| or <a href="../Delivery.html#annotations()"><code>Delivery.annotations()</code></a> methods after calling this method throws <a href="../exceptions/ClientIllegalStateException.html" title="class in org.apache.qpid.protonj2.client.exceptions"><code>ClientIllegalStateException</code></a>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Delivery.html#rawInputStream()">rawInputStream</a></code> in interface <code><a href="../Delivery.html" title="interface in org.apache.qpid.protonj2.client">Delivery</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an <code>InputStream</code> instance that can be used to read the raw delivery payload.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></code> - if an error occurs while decoding the payload.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="annotations()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>annotations</h4> |
| <pre class="methodSignature">public java.util.Map<java.lang.String,​java.lang.Object> annotations() |
| throws <a href="../exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Delivery.html#annotations()">Delivery</a></code></span></div> |
| <div class="block">Decodes the <a href="../Delivery.html" title="interface in org.apache.qpid.protonj2.client"><code>Delivery</code></a> payload and returns a <code>Map</code> containing a copy |
| of any associated <a href="../../types/messaging/DeliveryAnnotations.html" title="class in org.apache.qpid.protonj2.types.messaging"><code>DeliveryAnnotations</code></a> that were transmitted with the <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a> |
| payload of this <a href="../Delivery.html" title="interface in org.apache.qpid.protonj2.client"><code>Delivery</code></a>. |
| <p> |
| Calling this message claims the payload of the delivery for the returned <code>Map</code> and the decoded |
| <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a> that can be accessed via the <a href="../Delivery.html#message()"><code>Delivery.message()</code></a> method and excludes use of the |
| <a href="../Delivery.html#rawInputStream()"><code>Delivery.rawInputStream()</code></a> method of the <a href="../Delivery.html" title="interface in org.apache.qpid.protonj2.client"><code>Delivery</code></a> object. Calling the <a href="../Delivery.html#rawInputStream()"><code>Delivery.rawInputStream()</code></a> |
| method after calling this method throws <a href="../exceptions/ClientIllegalStateException.html" title="class in org.apache.qpid.protonj2.client.exceptions"><code>ClientIllegalStateException</code></a>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Delivery.html#annotations()">annotations</a></code> in interface <code><a href="../Delivery.html" title="interface in org.apache.qpid.protonj2.client">Delivery</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>copy of the delivery annotations that were transmitted with the <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a> payload.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></code> - if an error occurs while decoding the payload.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="accept()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>accept</h4> |
| <pre class="methodSignature">public <a href="../Delivery.html" title="interface in org.apache.qpid.protonj2.client">Delivery</a> accept() |
| throws <a href="../exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Delivery.html#accept()">Delivery</a></code></span></div> |
| <div class="block">Accepts and settles the delivery.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Delivery.html#accept()">accept</a></code> in interface <code><a href="../Delivery.html" title="interface in org.apache.qpid.protonj2.client">Delivery</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this <a href="../Delivery.html" title="interface in org.apache.qpid.protonj2.client"><code>Delivery</code></a> instance.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></code> - if an error occurs while sending the disposition</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="release()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>release</h4> |
| <pre class="methodSignature">public <a href="../Delivery.html" title="interface in org.apache.qpid.protonj2.client">Delivery</a> release() |
| throws <a href="../exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Delivery.html#release()">Delivery</a></code></span></div> |
| <div class="block">Releases and settles the delivery.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Delivery.html#release()">release</a></code> in interface <code><a href="../Delivery.html" title="interface in org.apache.qpid.protonj2.client">Delivery</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this <a href="../Delivery.html" title="interface in org.apache.qpid.protonj2.client"><code>Delivery</code></a> instance.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></code> - if an error occurs while sending the disposition</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="reject(java.lang.String,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>reject</h4> |
| <pre class="methodSignature">public <a href="../Delivery.html" title="interface in org.apache.qpid.protonj2.client">Delivery</a> reject​(java.lang.String condition, |
| java.lang.String description) |
| throws <a href="../exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Delivery.html#reject(java.lang.String,java.lang.String)">Delivery</a></code></span></div> |
| <div class="block">Rejects and settles the delivery, sending supplied error information along |
| with the rejection.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Delivery.html#reject(java.lang.String,java.lang.String)">reject</a></code> in interface <code><a href="../Delivery.html" title="interface in org.apache.qpid.protonj2.client">Delivery</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>condition</code> - The error condition value to supply with the rejection.</dd> |
| <dd><code>description</code> - The error description value to supply with the rejection.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this <a href="../Delivery.html" title="interface in org.apache.qpid.protonj2.client"><code>Delivery</code></a> instance.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></code> - if an error occurs while sending the disposition</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="modified(boolean,boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>modified</h4> |
| <pre class="methodSignature">public <a href="../Delivery.html" title="interface in org.apache.qpid.protonj2.client">Delivery</a> modified​(boolean deliveryFailed, |
| boolean undeliverableHere) |
| throws <a href="../exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Delivery.html#modified(boolean,boolean)">Delivery</a></code></span></div> |
| <div class="block">Modifies and settles the delivery.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Delivery.html#modified(boolean,boolean)">modified</a></code> in interface <code><a href="../Delivery.html" title="interface in org.apache.qpid.protonj2.client">Delivery</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>deliveryFailed</code> - Indicates if the modified delivery failed.</dd> |
| <dd><code>undeliverableHere</code> - Indicates if the modified delivery should not be returned here again.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this <a href="../Delivery.html" title="interface in org.apache.qpid.protonj2.client"><code>Delivery</code></a> instance.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></code> - if an error occurs while sending the disposition</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="disposition(org.apache.qpid.protonj2.client.DeliveryState,boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>disposition</h4> |
| <pre class="methodSignature">public <a href="../Delivery.html" title="interface in org.apache.qpid.protonj2.client">Delivery</a> disposition​(<a href="../DeliveryState.html" title="interface in org.apache.qpid.protonj2.client">DeliveryState</a> state, |
| boolean settle) |
| throws <a href="../exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Delivery.html#disposition(org.apache.qpid.protonj2.client.DeliveryState,boolean)">Delivery</a></code></span></div> |
| <div class="block">Updates the DeliveryState, and optionally settle the delivery as well.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Delivery.html#disposition(org.apache.qpid.protonj2.client.DeliveryState,boolean)">disposition</a></code> in interface <code><a href="../Delivery.html" title="interface in org.apache.qpid.protonj2.client">Delivery</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>state</code> - the delivery state to apply</dd> |
| <dd><code>settle</code> - whether to <a href="../Delivery.html#settle()"><code>Delivery.settle()</code></a> the delivery at the same time</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this <a href="../Delivery.html" title="interface in org.apache.qpid.protonj2.client"><code>Delivery</code></a> instance.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></code> - if an error occurs while sending the disposition</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="settle()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>settle</h4> |
| <pre class="methodSignature">public <a href="../Delivery.html" title="interface in org.apache.qpid.protonj2.client">Delivery</a> settle() |
| throws <a href="../exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Delivery.html#settle()">Delivery</a></code></span></div> |
| <div class="block">Settles the delivery locally.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Delivery.html#settle()">settle</a></code> in interface <code><a href="../Delivery.html" title="interface in org.apache.qpid.protonj2.client">Delivery</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the delivery</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></code> - if an error occurs while sending the disposition</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="state()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>state</h4> |
| <pre class="methodSignature">public <a href="../DeliveryState.html" title="interface in org.apache.qpid.protonj2.client">DeliveryState</a> state()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Delivery.html#state()">Delivery</a></code></span></div> |
| <div class="block">Gets the current local state for the delivery.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Delivery.html#state()">state</a></code> in interface <code><a href="../Delivery.html" title="interface in org.apache.qpid.protonj2.client">Delivery</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the delivery state</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="remoteState()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>remoteState</h4> |
| <pre class="methodSignature">public <a href="../DeliveryState.html" title="interface in org.apache.qpid.protonj2.client">DeliveryState</a> remoteState()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Delivery.html#remoteState()">Delivery</a></code></span></div> |
| <div class="block">Gets the current remote state for the delivery.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Delivery.html#remoteState()">remoteState</a></code> in interface <code><a href="../Delivery.html" title="interface in org.apache.qpid.protonj2.client">Delivery</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the remote delivery state</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="remoteSettled()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>remoteSettled</h4> |
| <pre class="methodSignature">public boolean remoteSettled()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Delivery.html#remoteSettled()">Delivery</a></code></span></div> |
| <div class="block">Gets whether the delivery was settled by the remote peer yet.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Delivery.html#remoteSettled()">remoteSettled</a></code> in interface <code><a href="../Delivery.html" title="interface in org.apache.qpid.protonj2.client">Delivery</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>whether the delivery is remotely settled</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="messageFormat()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>messageFormat</h4> |
| <pre class="methodSignature">public int messageFormat()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Delivery.html#messageFormat()">Delivery</a></code></span></div> |
| <div class="block">Gets the message format for the current delivery.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Delivery.html#messageFormat()">messageFormat</a></code> in interface <code><a href="../Delivery.html" title="interface in org.apache.qpid.protonj2.client">Delivery</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the message format</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="receiver()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>receiver</h4> |
| <pre class="methodSignature">public <a href="../Receiver.html" title="interface in org.apache.qpid.protonj2.client">Receiver</a> receiver()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Delivery.html#receiver()">receiver</a></code> in interface <code><a href="../Delivery.html" title="interface in org.apache.qpid.protonj2.client">Delivery</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the <a href="../Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a> that originated this <a href="../Delivery.html" title="interface in org.apache.qpid.protonj2.client"><code>Delivery</code></a>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="settled()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>settled</h4> |
| <pre class="methodSignature">public boolean settled()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Delivery.html#settled()">settled</a></code> in interface <code><a href="../Delivery.html" title="interface in org.apache.qpid.protonj2.client">Delivery</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if the delivery has been locally settled.</dd> |
| </dl> |
| </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/ClientDelivery.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>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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 © 2021 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |
