| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>Endpoint (Qpid ProtonJ2 Parent 1.0.0-M19 API)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: package: org.apache.qpid.protonj2.engine, interface: Endpoint"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">Class</li> |
| <li><a href="class-use/Endpoint.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../help-doc.html#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.qpid.protonj2.engine</a></div> |
| <h1 title="Interface Endpoint" class="title">Interface Endpoint<E extends Endpoint<E>></h1> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>Type Parameters:</dt> |
| <dd><code>E</code> - The <a href="Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> type</dd> |
| </dl> |
| <dl class="notes"> |
| <dt>All Known Subinterfaces:</dt> |
| <dd><code><a href="Connection.html" title="interface in org.apache.qpid.protonj2.engine">Connection</a></code>, <code><a href="Link.html" title="interface in org.apache.qpid.protonj2.engine">Link</a><L></code>, <code><a href="Receiver.html" title="interface in org.apache.qpid.protonj2.engine">Receiver</a></code>, <code><a href="Sender.html" title="interface in org.apache.qpid.protonj2.engine">Sender</a></code>, <code><a href="Session.html" title="interface in org.apache.qpid.protonj2.engine">Session</a></code>, <code><a href="TransactionController.html" title="interface in org.apache.qpid.protonj2.engine">TransactionController</a></code>, <code><a href="TransactionManager.html" title="interface in org.apache.qpid.protonj2.engine">TransactionManager</a></code></dd> |
| </dl> |
| <dl class="notes"> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="impl/ProtonConnection.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonConnection</a></code>, <code><a href="impl/ProtonEndpoint.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonEndpoint</a></code>, <code><a href="impl/ProtonLink.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonLink</a></code>, <code><a href="impl/ProtonReceiver.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonReceiver</a></code>, <code><a href="impl/ProtonSender.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonSender</a></code>, <code><a href="impl/ProtonSession.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonSession</a></code>, <code><a href="impl/ProtonTransactionController.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonTransactionController</a></code>, <code><a href="impl/ProtonTransactionManager.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonTransactionManager</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">Endpoint<E extends Endpoint<E>></span></div> |
| <div class="block">Represents a conceptual endpoint type used to provide common operations that |
| all the endpoint types will share.</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="Endpoint.html" title="type parameter in Endpoint">E</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#close()" class="member-name-link">close</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Close the end point locally and send the closing performative immediately if possible or |
| holds it until the Connection / Engine state allows it.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="Endpoint.html" title="type parameter in Endpoint">E</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#closeHandler(org.apache.qpid.protonj2.engine.EventHandler)" class="member-name-link">closeHandler</a><wbr>(<a href="EventHandler.html" title="interface in org.apache.qpid.protonj2.engine">EventHandler</a><<a href="Endpoint.html" title="type parameter in Endpoint">E</a>> remoteCloseEventHandler)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Sets a EventHandler for when an AMQP Close frame is received from the remote peer.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="Endpoint.html" title="type parameter in Endpoint">E</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#engineShutdownHandler(org.apache.qpid.protonj2.engine.EventHandler)" class="member-name-link">engineShutdownHandler</a><wbr>(<a href="EventHandler.html" title="interface in org.apache.qpid.protonj2.engine">EventHandler</a><<a href="Engine.html" title="interface in org.apache.qpid.protonj2.engine">Engine</a>> engineShutdownEventHandler)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Sets an <a href="EventHandler.html" title="interface in org.apache.qpid.protonj2.engine"><code>EventHandler</code></a> that is invoked when the engine that supports this <a href="Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> is shutdown |
| via a call to <a href="Engine.html#shutdown()"><code>Engine.shutdown()</code></a> which indicates a desire to terminate all engine operations.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="Attachments.html" title="interface in org.apache.qpid.protonj2.engine">Attachments</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getAttachments()" class="member-name-link">getAttachments</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="../types/transport/ErrorCondition.html" title="class in org.apache.qpid.protonj2.types.transport">ErrorCondition</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getCondition()" class="member-name-link">getCondition</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="../types/Symbol.html" title="class in org.apache.qpid.protonj2.types">Symbol</a>[]</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getDesiredCapabilities()" class="member-name-link">getDesiredCapabilities</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="Engine.html" title="interface in org.apache.qpid.protonj2.engine">Engine</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getEngine()" class="member-name-link">getEngine</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><T> T</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getLinkedResource()" class="member-name-link">getLinkedResource</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><T> T</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getLinkedResource(java.lang.Class)" class="member-name-link">getLinkedResource</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><T> typeClass)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Gets the linked resource (if set) and returns it using the type information |
| provided to cast the returned value.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="../types/Symbol.html" title="class in org.apache.qpid.protonj2.types">Symbol</a>[]</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getOfferedCapabilities()" class="member-name-link">getOfferedCapabilities</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="Endpoint.html" title="interface in org.apache.qpid.protonj2.engine">Endpoint</a><?></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getParent()" class="member-name-link">getParent</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Gets the parent of this <a href="Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> which can be itself for <a href="Connection.html" title="interface in org.apache.qpid.protonj2.engine"><code>Connection</code></a> instance.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="../types/Symbol.html" title="class in org.apache.qpid.protonj2.types">Symbol</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getProperties()" class="member-name-link">getProperties</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="../types/transport/ErrorCondition.html" title="class in org.apache.qpid.protonj2.types.transport">ErrorCondition</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getRemoteCondition()" class="member-name-link">getRemoteCondition</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">If the remote has closed this <a href="Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> and provided an <a href="../types/transport/ErrorCondition.html" title="class in org.apache.qpid.protonj2.types.transport"><code>ErrorCondition</code></a> as part |
| of the closing AMQP performative then this method will return it.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="../types/Symbol.html" title="class in org.apache.qpid.protonj2.types">Symbol</a>[]</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getRemoteDesiredCapabilities()" class="member-name-link">getRemoteDesiredCapabilities</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="../types/Symbol.html" title="class in org.apache.qpid.protonj2.types">Symbol</a>[]</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getRemoteOfferedCapabilities()" class="member-name-link">getRemoteOfferedCapabilities</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="../types/Symbol.html" title="class in org.apache.qpid.protonj2.types">Symbol</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getRemoteProperties()" class="member-name-link">getRemoteProperties</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#isLocallyClosed()" class="member-name-link">isLocallyClosed</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns true if this <a href="Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> is currently locally closed meaning that a call to the |
| <a href="#close()"><code>close()</code></a> method has occurred.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#isLocallyOpen()" class="member-name-link">isLocallyOpen</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns true if this <a href="Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> is currently locally open meaning that the <a href="#open()"><code>open()</code></a> |
| has been called but the <a href="#close()"><code>close()</code></a> has not.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#isRemotelyClosed()" class="member-name-link">isRemotelyClosed</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns true if this <a href="Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> is currently remotely closed meaning that the AMQP performative |
| that completes the close phase of this <a href="Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a>'s lifetime has arrived.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#isRemotelyOpen()" class="member-name-link">isRemotelyOpen</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns true if this <a href="Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> is currently remotely open meaning that the AMQP performative |
| that completes the open phase of this <a href="Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a>'s lifetime has arrived but the performative |
| that closes it has not.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="Endpoint.html" title="type parameter in Endpoint">E</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#localCloseHandler(org.apache.qpid.protonj2.engine.EventHandler)" class="member-name-link">localCloseHandler</a><wbr>(<a href="EventHandler.html" title="interface in org.apache.qpid.protonj2.engine">EventHandler</a><<a href="Endpoint.html" title="type parameter in Endpoint">E</a>> localCloseHandler)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Sets a <a href="EventHandler.html" title="interface in org.apache.qpid.protonj2.engine"><code>EventHandler</code></a> for when an this <a href="Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> is closed locally via a call to <a href="#close()"><code>close()</code></a> |
| |
| Typically used by clients for logging or other state update event processing.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="Endpoint.html" title="type parameter in Endpoint">E</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#localOpenHandler(org.apache.qpid.protonj2.engine.EventHandler)" class="member-name-link">localOpenHandler</a><wbr>(<a href="EventHandler.html" title="interface in org.apache.qpid.protonj2.engine">EventHandler</a><<a href="Endpoint.html" title="type parameter in Endpoint">E</a>> localOpenHandler)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Sets a <a href="EventHandler.html" title="interface in org.apache.qpid.protonj2.engine"><code>EventHandler</code></a> for when an this <a href="Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> is opened locally via a call to <a href="#open()"><code>open()</code></a> |
| |
| Typically used by clients for logging or other state update event processing.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="Endpoint.html" title="type parameter in Endpoint">E</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#open()" class="member-name-link">open</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Open the end point locally, sending the Open performative immediately if possible or holding |
| it until SASL negotiations or the AMQP header exchange and other required performative exchanges |
| has completed.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="Endpoint.html" title="type parameter in Endpoint">E</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#openHandler(org.apache.qpid.protonj2.engine.EventHandler)" class="member-name-link">openHandler</a><wbr>(<a href="EventHandler.html" title="interface in org.apache.qpid.protonj2.engine">EventHandler</a><<a href="Endpoint.html" title="type parameter in Endpoint">E</a>> remoteOpenEventHandler)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Sets a EventHandler for when an AMQP Open frame is received from the remote peer.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="Endpoint.html" title="type parameter in Endpoint">E</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setCondition(org.apache.qpid.protonj2.types.transport.ErrorCondition)" class="member-name-link">setCondition</a><wbr>(<a href="../types/transport/ErrorCondition.html" title="class in org.apache.qpid.protonj2.types.transport">ErrorCondition</a> condition)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Sets the local <a href="../types/transport/ErrorCondition.html" title="class in org.apache.qpid.protonj2.types.transport"><code>ErrorCondition</code></a> to be applied to a <a href="Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> close.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="Endpoint.html" title="type parameter in Endpoint">E</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setDesiredCapabilities(org.apache.qpid.protonj2.types.Symbol...)" class="member-name-link">setDesiredCapabilities</a><wbr>(<a href="../types/Symbol.html" title="class in org.apache.qpid.protonj2.types">Symbol</a>... capabilities)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Sets the capabilities that are desired from the remote when this <a href="Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> is |
| opened.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="Endpoint.html" title="type parameter in Endpoint">E</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setLinkedResource(java.lang.Object)" class="member-name-link">setLinkedResource</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> resource)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Links a given resource to this <a href="Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a>.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="Endpoint.html" title="type parameter in Endpoint">E</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setOfferedCapabilities(org.apache.qpid.protonj2.types.Symbol...)" class="member-name-link">setOfferedCapabilities</a><wbr>(<a href="../types/Symbol.html" title="class in org.apache.qpid.protonj2.types">Symbol</a>... capabilities)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Sets the capabilities to be offered on to the remote when this <a href="Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> is |
| opened.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="Endpoint.html" title="type parameter in Endpoint">E</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setProperties(java.util.Map)" class="member-name-link">setProperties</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="../types/Symbol.html" title="class in org.apache.qpid.protonj2.types">Symbol</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>> properties)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Sets the properties to be sent to the remote when this <a href="Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> is Opened.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="open()"> |
| <h3>open</h3> |
| <div class="member-signature"><span class="return-type"><a href="Endpoint.html" title="type parameter in Endpoint">E</a></span> <span class="element-name">open</span>() |
| throws <span class="exceptions"><a href="exceptions/EngineStateException.html" title="class in org.apache.qpid.protonj2.engine.exceptions">EngineStateException</a></span></div> |
| <div class="block">Open the end point locally, sending the Open performative immediately if possible or holding |
| it until SASL negotiations or the AMQP header exchange and other required performative exchanges |
| has completed. |
| |
| The end point will signal any registered handler of the remote opening the Connection |
| once the remote performative that signals open completion arrives.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>this <a href="Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> instance.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="exceptions/EngineStateException.html" title="class in org.apache.qpid.protonj2.engine.exceptions">EngineStateException</a></code> - if an error occurs opening the Connection or the Engine is shutdown.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="close()"> |
| <h3>close</h3> |
| <div class="member-signature"><span class="return-type"><a href="Endpoint.html" title="type parameter in Endpoint">E</a></span> <span class="element-name">close</span>() |
| throws <span class="exceptions"><a href="exceptions/EngineFailedException.html" title="class in org.apache.qpid.protonj2.engine.exceptions">EngineFailedException</a></span></div> |
| <div class="block">Close the end point locally and send the closing performative immediately if possible or |
| holds it until the Connection / Engine state allows it. If the engine encounters an error writing |
| the performative or the engine is in a failed state from a previous error then this method will |
| throw an exception. If the engine has been shutdown then this method will close out the local |
| end of the <a href="Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> and clean up any local resources before returning normally.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>this <a href="Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> instance.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="exceptions/EngineFailedException.html" title="class in org.apache.qpid.protonj2.engine.exceptions">EngineFailedException</a></code> - if an error occurs closing the end point or the Engine is in a failed state.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getAttachments()"> |
| <h3>getAttachments</h3> |
| <div class="member-signature"><span class="return-type"><a href="Attachments.html" title="interface in org.apache.qpid.protonj2.engine">Attachments</a></span> <span class="element-name">getAttachments</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the <a href="Attachments.html" title="interface in org.apache.qpid.protonj2.engine"><code>Attachments</code></a> instance that is associated with this <a href="Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getEngine()"> |
| <h3>getEngine</h3> |
| <div class="member-signature"><span class="return-type"><a href="Engine.html" title="interface in org.apache.qpid.protonj2.engine">Engine</a></span> <span class="element-name">getEngine</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the <a href="Engine.html" title="interface in org.apache.qpid.protonj2.engine"><code>Engine</code></a> which created this <a href="Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> instance.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getParent()"> |
| <h3>getParent</h3> |
| <div class="member-signature"><span class="return-type"><a href="Endpoint.html" title="interface in org.apache.qpid.protonj2.engine">Endpoint</a><?></span> <span class="element-name">getParent</span>()</div> |
| <div class="block">Gets the parent of this <a href="Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> which can be itself for <a href="Connection.html" title="interface in org.apache.qpid.protonj2.engine"><code>Connection</code></a> instance.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the parent of this <a href="Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> or itself if this is a <a href="Connection.html" title="interface in org.apache.qpid.protonj2.engine"><code>Connection</code></a>;</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setLinkedResource(java.lang.Object)"> |
| <h3>setLinkedResource</h3> |
| <div class="member-signature"><span class="return-type"><a href="Endpoint.html" title="type parameter in Endpoint">E</a></span> <span class="element-name">setLinkedResource</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> resource)</span></div> |
| <div class="block">Links a given resource to this <a href="Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a>.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>resource</code> - The resource to link to this <a href="Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a>.</dd> |
| <dt>Returns:</dt> |
| <dd>this <a href="Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> instance.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getLinkedResource()"> |
| <h3>getLinkedResource</h3> |
| <div class="member-signature"><span class="type-parameters"><T></span> <span class="return-type">T</span> <span class="element-name">getLinkedResource</span>()</div> |
| <dl class="notes"> |
| <dt>Type Parameters:</dt> |
| <dd><code>T</code> - The type that the linked resource should be cast to on return.</dd> |
| <dt>Returns:</dt> |
| <dd>the user set linked resource for this <a href="Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> instance.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getLinkedResource(java.lang.Class)"> |
| <h3>getLinkedResource</h3> |
| <div class="member-signature"><span class="type-parameters"><T></span> <span class="return-type">T</span> <span class="element-name">getLinkedResource</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><T> typeClass)</span></div> |
| <div class="block">Gets the linked resource (if set) and returns it using the type information |
| provided to cast the returned value.</div> |
| <dl class="notes"> |
| <dt>Type Parameters:</dt> |
| <dd><code>T</code> - The type to cast the linked resource to if one is set.</dd> |
| <dt>Parameters:</dt> |
| <dd><code>typeClass</code> - the type's Class which is used for casting the returned value.</dd> |
| <dt>Returns:</dt> |
| <dd>the user set linked resource for this Context instance.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/ClassCastException.html" title="class or interface in java.lang" class="external-link">ClassCastException</a></code> - if the linked resource cannot be cast to the type requested.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getCondition()"> |
| <h3>getCondition</h3> |
| <div class="member-signature"><span class="return-type"><a href="../types/transport/ErrorCondition.html" title="class in org.apache.qpid.protonj2.types.transport">ErrorCondition</a></span> <span class="element-name">getCondition</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the local <a href="Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> error, or null if there is none</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setCondition(org.apache.qpid.protonj2.types.transport.ErrorCondition)"> |
| <h3>setCondition</h3> |
| <div class="member-signature"><span class="return-type"><a href="Endpoint.html" title="type parameter in Endpoint">E</a></span> <span class="element-name">setCondition</span><wbr><span class="parameters">(<a href="../types/transport/ErrorCondition.html" title="class in org.apache.qpid.protonj2.types.transport">ErrorCondition</a> condition)</span></div> |
| <div class="block">Sets the local <a href="../types/transport/ErrorCondition.html" title="class in org.apache.qpid.protonj2.types.transport"><code>ErrorCondition</code></a> to be applied to a <a href="Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> close.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>condition</code> - The error condition to convey to the remote peer on close of this end point.</dd> |
| <dt>Returns:</dt> |
| <dd>this <a href="Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> instance.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isLocallyOpen()"> |
| <h3>isLocallyOpen</h3> |
| <div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">isLocallyOpen</span>()</div> |
| <div class="block">Returns true if this <a href="Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> is currently locally open meaning that the <a href="#open()"><code>open()</code></a> |
| has been called but the <a href="#close()"><code>close()</code></a> has not.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd><code>true</code> if the <a href="Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> is locally open.</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="#isLocallyClosed()"><code>isLocallyClosed()</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isLocallyClosed()"> |
| <h3>isLocallyClosed</h3> |
| <div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">isLocallyClosed</span>()</div> |
| <div class="block">Returns true if this <a href="Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> is currently locally closed meaning that a call to the |
| <a href="#close()"><code>close()</code></a> method has occurred.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd><code>true</code> if the <a href="Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> is locally closed.</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="#isLocallyOpen()"><code>isLocallyOpen()</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setOfferedCapabilities(org.apache.qpid.protonj2.types.Symbol...)"> |
| <h3>setOfferedCapabilities</h3> |
| <div class="member-signature"><span class="return-type"><a href="Endpoint.html" title="type parameter in Endpoint">E</a></span> <span class="element-name">setOfferedCapabilities</span><wbr><span class="parameters">(<a href="../types/Symbol.html" title="class in org.apache.qpid.protonj2.types">Symbol</a>... capabilities)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalStateException.html" title="class or interface in java.lang" class="external-link">IllegalStateException</a></span></div> |
| <div class="block">Sets the capabilities to be offered on to the remote when this <a href="Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> is |
| opened. |
| |
| The offered capabilities value can only be modified prior to a call to <a href="#open()"><code>open()</code></a>, |
| once the <a href="Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> has been opened locally an error will be thrown if this method |
| is called.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>capabilities</code> - The capabilities to be offered to the remote when the <a href="Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> is opened.</dd> |
| <dt>Returns:</dt> |
| <dd>this <a href="Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> instance.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalStateException.html" title="class or interface in java.lang" class="external-link">IllegalStateException</a></code> - if the <a href="Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> has already been opened.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getOfferedCapabilities()"> |
| <h3>getOfferedCapabilities</h3> |
| <div class="member-signature"><span class="return-type"><a href="../types/Symbol.html" title="class in org.apache.qpid.protonj2.types">Symbol</a>[]</span> <span class="element-name">getOfferedCapabilities</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the configured capabilities that are offered to the remote when the <a href="Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> is opened.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setDesiredCapabilities(org.apache.qpid.protonj2.types.Symbol...)"> |
| <h3>setDesiredCapabilities</h3> |
| <div class="member-signature"><span class="return-type"><a href="Endpoint.html" title="type parameter in Endpoint">E</a></span> <span class="element-name">setDesiredCapabilities</span><wbr><span class="parameters">(<a href="../types/Symbol.html" title="class in org.apache.qpid.protonj2.types">Symbol</a>... capabilities)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalStateException.html" title="class or interface in java.lang" class="external-link">IllegalStateException</a></span></div> |
| <div class="block">Sets the capabilities that are desired from the remote when this <a href="Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> is |
| opened. |
| |
| The desired capabilities value can only be modified prior to a call to <a href="#open()"><code>open()</code></a>, |
| once the <a href="Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> has been opened locally an error will be thrown if this method |
| is called.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>capabilities</code> - The capabilities desired from the remote when the <a href="Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> is opened.</dd> |
| <dt>Returns:</dt> |
| <dd>this <a href="Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> instance.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalStateException.html" title="class or interface in java.lang" class="external-link">IllegalStateException</a></code> - if the <a href="Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> has already been opened.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getDesiredCapabilities()"> |
| <h3>getDesiredCapabilities</h3> |
| <div class="member-signature"><span class="return-type"><a href="../types/Symbol.html" title="class in org.apache.qpid.protonj2.types">Symbol</a>[]</span> <span class="element-name">getDesiredCapabilities</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the configured desired capabilities that are sent to the remote when the Connection is opened.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setProperties(java.util.Map)"> |
| <h3>setProperties</h3> |
| <div class="member-signature"><span class="return-type"><a href="Endpoint.html" title="type parameter in Endpoint">E</a></span> <span class="element-name">setProperties</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="../types/Symbol.html" title="class in org.apache.qpid.protonj2.types">Symbol</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>> properties)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalStateException.html" title="class or interface in java.lang" class="external-link">IllegalStateException</a></span></div> |
| <div class="block">Sets the properties to be sent to the remote when this <a href="Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> is Opened. |
| |
| The <a href="Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> properties value can only be modified prior to a call to <a href="#open()"><code>open()</code></a>, |
| once the <a href="Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> has been opened locally an error will be thrown if this method |
| is called.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>properties</code> - The properties that will be sent to the remote when this Connection is opened.</dd> |
| <dt>Returns:</dt> |
| <dd>this <a href="Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> instance.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalStateException.html" title="class or interface in java.lang" class="external-link">IllegalStateException</a></code> - if the <a href="Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> has already been opened.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getProperties()"> |
| <h3>getProperties</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="../types/Symbol.html" title="class in org.apache.qpid.protonj2.types">Symbol</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>></span> <span class="element-name">getProperties</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the configured properties sent to the remote when this Connection is opened.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isRemotelyOpen()"> |
| <h3>isRemotelyOpen</h3> |
| <div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">isRemotelyOpen</span>()</div> |
| <div class="block">Returns true if this <a href="Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> is currently remotely open meaning that the AMQP performative |
| that completes the open phase of this <a href="Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a>'s lifetime has arrived but the performative |
| that closes it has not.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd><code>true</code> if the <a href="Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> is remotely open.</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="#isRemotelyClosed()"><code>isRemotelyClosed()</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isRemotelyClosed()"> |
| <h3>isRemotelyClosed</h3> |
| <div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">isRemotelyClosed</span>()</div> |
| <div class="block">Returns true if this <a href="Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> is currently remotely closed meaning that the AMQP performative |
| that completes the close phase of this <a href="Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a>'s lifetime has arrived.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd><code>true</code> if the <a href="Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> is remotely closed.</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="#isRemotelyOpen()"><code>isRemotelyOpen()</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getRemoteCondition()"> |
| <h3>getRemoteCondition</h3> |
| <div class="member-signature"><span class="return-type"><a href="../types/transport/ErrorCondition.html" title="class in org.apache.qpid.protonj2.types.transport">ErrorCondition</a></span> <span class="element-name">getRemoteCondition</span>()</div> |
| <div class="block">If the remote has closed this <a href="Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> and provided an <a href="../types/transport/ErrorCondition.html" title="class in org.apache.qpid.protonj2.types.transport"><code>ErrorCondition</code></a> as part |
| of the closing AMQP performative then this method will return it.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the remote supplied <a href="../types/transport/ErrorCondition.html" title="class in org.apache.qpid.protonj2.types.transport"><code>ErrorCondition</code></a>, or null if there is none.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getRemoteOfferedCapabilities()"> |
| <h3>getRemoteOfferedCapabilities</h3> |
| <div class="member-signature"><span class="return-type"><a href="../types/Symbol.html" title="class in org.apache.qpid.protonj2.types">Symbol</a>[]</span> <span class="element-name">getRemoteOfferedCapabilities</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the capabilities offered by the remote when it opened its end of the <a href="Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a>.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getRemoteDesiredCapabilities()"> |
| <h3>getRemoteDesiredCapabilities</h3> |
| <div class="member-signature"><span class="return-type"><a href="../types/Symbol.html" title="class in org.apache.qpid.protonj2.types">Symbol</a>[]</span> <span class="element-name">getRemoteDesiredCapabilities</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the capabilities desired by the remote when it opened its end of the <a href="Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a>.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getRemoteProperties()"> |
| <h3>getRemoteProperties</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="../types/Symbol.html" title="class in org.apache.qpid.protonj2.types">Symbol</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>></span> <span class="element-name">getRemoteProperties</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the properties sent by the remote when it opened its end of the <a href="Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a>.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="localOpenHandler(org.apache.qpid.protonj2.engine.EventHandler)"> |
| <h3>localOpenHandler</h3> |
| <div class="member-signature"><span class="return-type"><a href="Endpoint.html" title="type parameter in Endpoint">E</a></span> <span class="element-name">localOpenHandler</span><wbr><span class="parameters">(<a href="EventHandler.html" title="interface in org.apache.qpid.protonj2.engine">EventHandler</a><<a href="Endpoint.html" title="type parameter in Endpoint">E</a>> localOpenHandler)</span></div> |
| <div class="block">Sets a <a href="EventHandler.html" title="interface in org.apache.qpid.protonj2.engine"><code>EventHandler</code></a> for when an this <a href="Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> is opened locally via a call to <a href="#open()"><code>open()</code></a> |
| |
| Typically used by clients for logging or other state update event processing. Clients should not perform any |
| blocking calls within this context. It is an error for the handler to throw an exception and the outcome of |
| doing so is undefined.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>localOpenHandler</code> - The <a href="EventHandler.html" title="interface in org.apache.qpid.protonj2.engine"><code>EventHandler</code></a> to notify when this <a href="Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> is locally opened.</dd> |
| <dt>Returns:</dt> |
| <dd>this <a href="Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> instance.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="localCloseHandler(org.apache.qpid.protonj2.engine.EventHandler)"> |
| <h3>localCloseHandler</h3> |
| <div class="member-signature"><span class="return-type"><a href="Endpoint.html" title="type parameter in Endpoint">E</a></span> <span class="element-name">localCloseHandler</span><wbr><span class="parameters">(<a href="EventHandler.html" title="interface in org.apache.qpid.protonj2.engine">EventHandler</a><<a href="Endpoint.html" title="type parameter in Endpoint">E</a>> localCloseHandler)</span></div> |
| <div class="block">Sets a <a href="EventHandler.html" title="interface in org.apache.qpid.protonj2.engine"><code>EventHandler</code></a> for when an this <a href="Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> is closed locally via a call to <a href="#close()"><code>close()</code></a> |
| |
| Typically used by clients for logging or other state update event processing. Clients should not perform any |
| blocking calls within this context. It is an error for the handler to throw an exception and the outcome of |
| doing so is undefined.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>localCloseHandler</code> - The <a href="EventHandler.html" title="interface in org.apache.qpid.protonj2.engine"><code>EventHandler</code></a> to notify when this <a href="Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> is locally closed.</dd> |
| <dt>Returns:</dt> |
| <dd>this <a href="Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> instance.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="openHandler(org.apache.qpid.protonj2.engine.EventHandler)"> |
| <h3>openHandler</h3> |
| <div class="member-signature"><span class="return-type"><a href="Endpoint.html" title="type parameter in Endpoint">E</a></span> <span class="element-name">openHandler</span><wbr><span class="parameters">(<a href="EventHandler.html" title="interface in org.apache.qpid.protonj2.engine">EventHandler</a><<a href="Endpoint.html" title="type parameter in Endpoint">E</a>> remoteOpenEventHandler)</span></div> |
| <div class="block">Sets a EventHandler for when an AMQP Open frame is received from the remote peer. |
| |
| Used to process remotely initiated Connections. Locally initiated sessions have their own EventHandler |
| invoked instead. This method is typically used by servers to listen for the remote peer to open its |
| <a href="Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a>, while a client would listen for the server to open its end of the <a href="Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> once |
| a local open has been performed. |
| |
| Typically used by clients as servers will typically listen to some parent resource event handler |
| to determine if the remote is initiating a resource open.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>remoteOpenEventHandler</code> - the EventHandler that will be signaled when the <a href="Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> has been remotely opened</dd> |
| <dt>Returns:</dt> |
| <dd>this <a href="Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> instance.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="closeHandler(org.apache.qpid.protonj2.engine.EventHandler)"> |
| <h3>closeHandler</h3> |
| <div class="member-signature"><span class="return-type"><a href="Endpoint.html" title="type parameter in Endpoint">E</a></span> <span class="element-name">closeHandler</span><wbr><span class="parameters">(<a href="EventHandler.html" title="interface in org.apache.qpid.protonj2.engine">EventHandler</a><<a href="Endpoint.html" title="type parameter in Endpoint">E</a>> remoteCloseEventHandler)</span></div> |
| <div class="block">Sets a EventHandler for when an AMQP Close frame is received from the remote peer.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>remoteCloseEventHandler</code> - the EventHandler that will be signaled when the <a href="Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> is remotely closed.</dd> |
| <dt>Returns:</dt> |
| <dd>this <a href="Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> instance.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="engineShutdownHandler(org.apache.qpid.protonj2.engine.EventHandler)"> |
| <h3>engineShutdownHandler</h3> |
| <div class="member-signature"><span class="return-type"><a href="Endpoint.html" title="type parameter in Endpoint">E</a></span> <span class="element-name">engineShutdownHandler</span><wbr><span class="parameters">(<a href="EventHandler.html" title="interface in org.apache.qpid.protonj2.engine">EventHandler</a><<a href="Engine.html" title="interface in org.apache.qpid.protonj2.engine">Engine</a>> engineShutdownEventHandler)</span></div> |
| <div class="block">Sets an <a href="EventHandler.html" title="interface in org.apache.qpid.protonj2.engine"><code>EventHandler</code></a> that is invoked when the engine that supports this <a href="Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> is shutdown |
| via a call to <a href="Engine.html#shutdown()"><code>Engine.shutdown()</code></a> which indicates a desire to terminate all engine operations. Any |
| <a href="Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> that has been both locally and remotely closed will not receive this event as it will no longer |
| be tracked by the parent its parent <a href="Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a>. |
| |
| A typical use of this event would be from a locally closed <a href="Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> that is awaiting response from |
| the remote. If this event fires then there will never be a remote response to any pending operations and |
| the client or server instance should react accordingly to clean up any related resources etc.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>engineShutdownEventHandler</code> - the EventHandler that will be signaled when this <a href="Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a>'s engine is explicitly shutdown.</dd> |
| <dt>Returns:</dt> |
| <dd>this <a href="Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> instance.</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
