| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>Uses of Class org.apache.qpid.protonj2.engine.exceptions.EngineStateException (Qpid ProtonJ2 Parent 1.0.0-M9 API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="Uses of Class org.apache.qpid.protonj2.engine.exceptions.EngineStateException (Qpid ProtonJ2 Parent 1.0.0-M9 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| </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><a href="../EngineStateException.html" title="class in org.apache.qpid.protonj2.engine.exceptions">Class</a></li> |
| <li class="navBarCell1Rev">Use</li> |
| <li><a href="../package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../../deprecated-list.html">Deprecated</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> |
| <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> |
| <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> |
| <main role="main"> |
| <div class="header"> |
| <h2 title="Uses of Class org.apache.qpid.protonj2.engine.exceptions.EngineStateException" class="title">Uses of Class<br>org.apache.qpid.protonj2.engine.exceptions.EngineStateException</h2> |
| </div> |
| <div class="classUseContainer"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <table class="useSummary"> |
| <caption><span>Packages that use <a href="../EngineStateException.html" title="class in org.apache.qpid.protonj2.engine.exceptions">EngineStateException</a></span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Package</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="#org.apache.qpid.protonj2.engine">org.apache.qpid.protonj2.engine</a></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="#org.apache.qpid.protonj2.engine.exceptions">org.apache.qpid.protonj2.engine.exceptions</a></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="#org.apache.qpid.protonj2.engine.impl">org.apache.qpid.protonj2.engine.impl</a></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="#org.apache.qpid.protonj2.engine.sasl">org.apache.qpid.protonj2.engine.sasl</a></th> |
| <td class="colLast"> </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <section role="region"><a id="org.apache.qpid.protonj2.engine"> |
| <!-- --> |
| </a> |
| <h3>Uses of <a href="../EngineStateException.html" title="class in org.apache.qpid.protonj2.engine.exceptions">EngineStateException</a> in <a href="../../package-summary.html">org.apache.qpid.protonj2.engine</a></h3> |
| <table class="useSummary"> |
| <caption><span>Methods in <a href="../../package-summary.html">org.apache.qpid.protonj2.engine</a> that return <a href="../EngineStateException.html" title="class in org.apache.qpid.protonj2.engine.exceptions">EngineStateException</a></span><span class="tabEnd"> </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> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../EngineStateException.html" title="class in org.apache.qpid.protonj2.engine.exceptions">EngineStateException</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">Engine.</span><code><span class="memberNameLink"><a href="../../Engine.html#engineFailed(java.lang.Throwable)">engineFailed</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Throwable</a> cause)</code></th> |
| <td class="colLast"> |
| <div class="block">Transition the <a href="../../Engine.html" title="interface in org.apache.qpid.protonj2.engine"><code>Engine</code></a> to a failed state if not already closed or closing.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <table class="useSummary"> |
| <caption><span>Methods in <a href="../../package-summary.html">org.apache.qpid.protonj2.engine</a> that throw <a href="../EngineStateException.html" title="class in org.apache.qpid.protonj2.engine.exceptions">EngineStateException</a></span><span class="tabEnd"> </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> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><code>default void</code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">Engine.</span><code><span class="memberNameLink"><a href="../../Engine.html#accept(org.apache.qpid.protonj2.buffer.ProtonBuffer)">accept</a></span>​(<a href="../../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a> input)</code></th> |
| <td class="colLast"> |
| <div class="block">Provide data input for this Engine from some external source.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../Engine.html" title="interface in org.apache.qpid.protonj2.engine">Engine</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">Engine.</span><code><span class="memberNameLink"><a href="../../Engine.html#ingest(org.apache.qpid.protonj2.buffer.ProtonBuffer)">ingest</a></span>​(<a href="../../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a> input)</code></th> |
| <td class="colLast"> |
| <div class="block">Provide data input for this Engine from some external source.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../Connection.html" title="interface in org.apache.qpid.protonj2.engine">Connection</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">Connection.</span><code><span class="memberNameLink"><a href="../../Connection.html#negotiate()">negotiate</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">If not already negotiated this method initiates the AMQP protocol negotiation phase of |
| the connection process sending the <a href="../../../types/transport/AMQPHeader.html" title="class in org.apache.qpid.protonj2.types.transport"><code>AMQPHeader</code></a> to the remote peer.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../Connection.html" title="interface in org.apache.qpid.protonj2.engine">Connection</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">Connection.</span><code><span class="memberNameLink"><a href="../../Connection.html#negotiate(org.apache.qpid.protonj2.engine.EventHandler)">negotiate</a></span>​(<a href="../../EventHandler.html" title="interface in org.apache.qpid.protonj2.engine">EventHandler</a><<a href="../../../types/transport/AMQPHeader.html" title="class in org.apache.qpid.protonj2.types.transport">AMQPHeader</a>> remoteAMQPHeaderHandler)</code></th> |
| <td class="colLast"> |
| <div class="block">If not already negotiated this method initiates the AMQP protocol negotiation phase of |
| the connection process sending the <a href="../../../types/transport/AMQPHeader.html" title="class in org.apache.qpid.protonj2.types.transport"><code>AMQPHeader</code></a> to the remote peer.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../Endpoint.html" title="type parameter in Endpoint">E</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">Endpoint.</span><code><span class="memberNameLink"><a href="../../Endpoint.html#open()">open</a></span>()</code></th> |
| <td class="colLast"> |
| <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> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../Connection.html" title="interface in org.apache.qpid.protonj2.engine">Connection</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">Engine.</span><code><span class="memberNameLink"><a href="../../Engine.html#start()">start</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Starts the engine and returns the <a href="../../Connection.html" title="interface in org.apache.qpid.protonj2.engine"><code>Connection</code></a> instance that is bound to this Engine.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">Connection.</span><code><span class="memberNameLink"><a href="../../Connection.html#tick(long)">tick</a></span>​(long current)</code></th> |
| <td class="colLast"> |
| <div class="block">Performs a tick operation on the connection which checks that Connection Idle timeout processing |
| is run.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">Engine.</span><code><span class="memberNameLink"><a href="../../Engine.html#tick(long)">tick</a></span>​(long currentTime)</code></th> |
| <td class="colLast"> |
| <div class="block">Prompt the engine to perform idle-timeout/heartbeat handling, and return an absolute |
| deadline in milliseconds that tick must again be called by/at, based on the provided |
| current time in milliseconds, to ensure the periodic work is carried out as necessary.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../Engine.html" title="interface in org.apache.qpid.protonj2.engine">Engine</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">Engine.</span><code><span class="memberNameLink"><a href="../../Engine.html#tickAuto(java.util.concurrent.ScheduledExecutorService)">tickAuto</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/ScheduledExecutorService.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink">ScheduledExecutorService</a> executor)</code></th> |
| <td class="colLast"> |
| <div class="block">Allows the engine to manage idle timeout processing by providing it the single threaded executor |
| context where all transport work is done which ensures singled threaded access while removing the |
| need for the client library or server application to manage calls to the <a href="../../Engine.html#tick(long)"><code>Engine.tick(long)</code></a> methods.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section role="region"><a id="org.apache.qpid.protonj2.engine.exceptions"> |
| <!-- --> |
| </a> |
| <h3>Uses of <a href="../EngineStateException.html" title="class in org.apache.qpid.protonj2.engine.exceptions">EngineStateException</a> in <a href="../package-summary.html">org.apache.qpid.protonj2.engine.exceptions</a></h3> |
| <table class="useSummary"> |
| <caption><span>Subclasses of <a href="../EngineStateException.html" title="class in org.apache.qpid.protonj2.engine.exceptions">EngineStateException</a> in <a href="../package-summary.html">org.apache.qpid.protonj2.engine.exceptions</a></span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Class</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><code>class </code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../EngineFailedException.html" title="class in org.apache.qpid.protonj2.engine.exceptions">EngineFailedException</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Thrown from Engine API methods that attempted an operation what would have |
| resulted in a write of data or other state modification after the engine has |
| entered the the failed state.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>class </code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../EngineNotStartedException.html" title="class in org.apache.qpid.protonj2.engine.exceptions">EngineNotStartedException</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Thrown when a read or write operation is attempted on the engine before |
| it has been properly started.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>class </code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../EngineNotWritableException.html" title="class in org.apache.qpid.protonj2.engine.exceptions">EngineNotWritableException</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Exception indicating that the engine is not currently accepting input of data</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>class </code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../EngineShutdownException.html" title="class in org.apache.qpid.protonj2.engine.exceptions">EngineShutdownException</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Exception thrown when an option is performed on a closed engine.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>class </code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../EngineStartedException.html" title="class in org.apache.qpid.protonj2.engine.exceptions">EngineStartedException</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Thrown when an API method has been called which cannot be allowed to proceed |
| due to the engine having already been started and doesn't allow modification to |
| the resource in question after that point.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section role="region"><a id="org.apache.qpid.protonj2.engine.impl"> |
| <!-- --> |
| </a> |
| <h3>Uses of <a href="../EngineStateException.html" title="class in org.apache.qpid.protonj2.engine.exceptions">EngineStateException</a> in <a href="../../impl/package-summary.html">org.apache.qpid.protonj2.engine.impl</a></h3> |
| <table class="useSummary"> |
| <caption><span>Methods in <a href="../../impl/package-summary.html">org.apache.qpid.protonj2.engine.impl</a> that return <a href="../EngineStateException.html" title="class in org.apache.qpid.protonj2.engine.exceptions">EngineStateException</a></span><span class="tabEnd"> </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> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../EngineStateException.html" title="class in org.apache.qpid.protonj2.engine.exceptions">EngineStateException</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">ProtonEngine.</span><code><span class="memberNameLink"><a href="../../impl/ProtonEngine.html#engineFailed(java.lang.Throwable)">engineFailed</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Throwable</a> cause)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </tbody> |
| </table> |
| <table class="useSummary"> |
| <caption><span>Methods in <a href="../../impl/package-summary.html">org.apache.qpid.protonj2.engine.impl</a> that throw <a href="../EngineStateException.html" title="class in org.apache.qpid.protonj2.engine.exceptions">EngineStateException</a></span><span class="tabEnd"> </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> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../impl/ProtonEngine.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonEngine</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">ProtonEngine.</span><code><span class="memberNameLink"><a href="../../impl/ProtonEngine.html#ingest(org.apache.qpid.protonj2.buffer.ProtonBuffer)">ingest</a></span>​(<a href="../../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a> input)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../impl/ProtonConnection.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonConnection</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">ProtonConnection.</span><code><span class="memberNameLink"><a href="../../impl/ProtonConnection.html#open()">open</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../impl/ProtonSession.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonSession</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">ProtonSession.</span><code><span class="memberNameLink"><a href="../../impl/ProtonSession.html#open()">open</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../TransactionController.html" title="interface in org.apache.qpid.protonj2.engine">TransactionController</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">ProtonTransactionController.</span><code><span class="memberNameLink"><a href="../../impl/ProtonTransactionController.html#open()">open</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../TransactionManager.html" title="interface in org.apache.qpid.protonj2.engine">TransactionManager</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">ProtonTransactionManager.</span><code><span class="memberNameLink"><a href="../../impl/ProtonTransactionManager.html#open()">open</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">ProtonEngine.</span><code><span class="memberNameLink"><a href="../../impl/ProtonEngine.html#registerSaslDriver(org.apache.qpid.protonj2.engine.EngineSaslDriver)">registerSaslDriver</a></span>​(<a href="../../EngineSaslDriver.html" title="interface in org.apache.qpid.protonj2.engine">EngineSaslDriver</a> saslDriver)</code></th> |
| <td class="colLast"> |
| <div class="block">Allows for registration of a custom <a href="../../EngineSaslDriver.html" title="interface in org.apache.qpid.protonj2.engine"><code>EngineSaslDriver</code></a> that will convey |
| SASL state and configuration for this engine.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../impl/ProtonConnection.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonConnection</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">ProtonEngine.</span><code><span class="memberNameLink"><a href="../../impl/ProtonEngine.html#start()">start</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">ProtonEngine.</span><code><span class="memberNameLink"><a href="../../impl/ProtonEngine.html#tick(long)">tick</a></span>​(long currentTime)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../impl/ProtonEngine.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonEngine</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">ProtonEngine.</span><code><span class="memberNameLink"><a href="../../impl/ProtonEngine.html#tickAuto(java.util.concurrent.ScheduledExecutorService)">tickAuto</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/ScheduledExecutorService.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink">ScheduledExecutorService</a> executor)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </tbody> |
| </table> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section role="region"><a id="org.apache.qpid.protonj2.engine.sasl"> |
| <!-- --> |
| </a> |
| <h3>Uses of <a href="../EngineStateException.html" title="class in org.apache.qpid.protonj2.engine.exceptions">EngineStateException</a> in <a href="../../sasl/package-summary.html">org.apache.qpid.protonj2.engine.sasl</a></h3> |
| <table class="useSummary"> |
| <caption><span>Methods in <a href="../../sasl/package-summary.html">org.apache.qpid.protonj2.engine.sasl</a> that throw <a href="../EngineStateException.html" title="class in org.apache.qpid.protonj2.engine.exceptions">EngineStateException</a></span><span class="tabEnd"> </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> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../sasl/SaslServerContext.html" title="interface in org.apache.qpid.protonj2.engine.sasl">SaslServerContext</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">SaslServerContext.</span><code><span class="memberNameLink"><a href="../../sasl/SaslServerContext.html#sendChallenge(org.apache.qpid.protonj2.buffer.ProtonBuffer)">sendChallenge</a></span>​(<a href="../../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a> challenge)</code></th> |
| <td class="colLast"> |
| <div class="block">Sends the SASL challenge defined by the SASL mechanism that is in use during |
| this SASL negotiation.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../sasl/SaslClientContext.html" title="interface in org.apache.qpid.protonj2.engine.sasl">SaslClientContext</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">SaslClientContext.</span><code><span class="memberNameLink"><a href="../../sasl/SaslClientContext.html#sendChosenMechanism(org.apache.qpid.protonj2.types.Symbol,java.lang.String,org.apache.qpid.protonj2.buffer.ProtonBuffer)">sendChosenMechanism</a></span>​(<a href="../../../types/Symbol.html" title="class in org.apache.qpid.protonj2.types">Symbol</a> mechanism, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> host, |
| <a href="../../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a> initialResponse)</code></th> |
| <td class="colLast"> |
| <div class="block">Sends a response to the SASL server indicating the chosen mechanism for this |
| client and the host name that this client is identifying itself as.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../sasl/SaslServerContext.html" title="interface in org.apache.qpid.protonj2.engine.sasl">SaslServerContext</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">SaslServerContext.</span><code><span class="memberNameLink"><a href="../../sasl/SaslServerContext.html#sendMechanisms(org.apache.qpid.protonj2.types.Symbol%5B%5D)">sendMechanisms</a></span>​(<a href="../../../types/Symbol.html" title="class in org.apache.qpid.protonj2.types">Symbol</a>[] mechanisms)</code></th> |
| <td class="colLast"> |
| <div class="block">Sends the set of supported mechanisms to the SASL client from which it must |
| choose and return one mechanism which will then be the basis for the SASL |
| authentication negotiation.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../sasl/SaslServerContext.html" title="interface in org.apache.qpid.protonj2.engine.sasl">SaslServerContext</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">SaslServerContext.</span><code><span class="memberNameLink"><a href="../../sasl/SaslServerContext.html#sendOutcome(org.apache.qpid.protonj2.engine.sasl.SaslOutcome,org.apache.qpid.protonj2.buffer.ProtonBuffer)">sendOutcome</a></span>​(<a href="../../sasl/SaslOutcome.html" title="enum in org.apache.qpid.protonj2.engine.sasl">SaslOutcome</a> outcome, |
| <a href="../../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a> additional)</code></th> |
| <td class="colLast"> |
| <div class="block">Sends a response to a server side challenge that comprises the challenge / response |
| exchange for the chosen SASL mechanism.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../sasl/SaslClientContext.html" title="interface in org.apache.qpid.protonj2.engine.sasl">SaslClientContext</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">SaslClientContext.</span><code><span class="memberNameLink"><a href="../../sasl/SaslClientContext.html#sendResponse(org.apache.qpid.protonj2.buffer.ProtonBuffer)">sendResponse</a></span>​(<a href="../../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a> response)</code></th> |
| <td class="colLast"> |
| <div class="block">Sends a response to a server side challenge that comprises the challenge / response |
| exchange for the chosen SASL mechanism.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../sasl/SaslClientContext.html" title="interface in org.apache.qpid.protonj2.engine.sasl">SaslClientContext</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">SaslClientContext.</span><code><span class="memberNameLink"><a href="../../sasl/SaslClientContext.html#sendSASLHeader()">sendSASLHeader</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Sends the AMQP Header indicating the desire for SASL negotiations to be commenced on |
| this connection.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </section> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </main> |
| <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><a href="../EngineStateException.html" title="class in org.apache.qpid.protonj2.engine.exceptions">Class</a></li> |
| <li class="navBarCell1Rev">Use</li> |
| <li><a href="../package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../../deprecated-list.html">Deprecated</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> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |
