| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>Uses of Interface org.apache.qpid.protonj2.engine.sasl.SaslClientContext (Qpid ProtonJ2 Parent 1.0.0-M18 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="use: package: org.apache.qpid.protonj2.engine.sasl, interface: SaslClientContext"> |
| <meta name="generator" content="javadoc/ClassUseWriter"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../../script.js"></script> |
| </head> |
| <body class="class-use-page"> |
| <script type="text/javascript"></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><a href="../SaslClientContext.html" title="interface in org.apache.qpid.protonj2.engine.sasl">Class</a></li> |
| <li class="nav-bar-cell1-rev">Use</li> |
| <li><a href="../package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../../help-doc.html#use">Help</a></li> |
| </ul> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <div class="header"> |
| <h1 title="Uses of Interface org.apache.qpid.protonj2.engine.sasl.SaslClientContext" class="title">Uses of Interface<br>org.apache.qpid.protonj2.engine.sasl.SaslClientContext</h1> |
| </div> |
| <div class="caption"><span>Packages that use <a href="../SaslClientContext.html" title="interface in org.apache.qpid.protonj2.engine.sasl">SaslClientContext</a></span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Package</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><a href="#org.apache.qpid.protonj2.engine">org.apache.qpid.protonj2.engine</a></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><a href="#org.apache.qpid.protonj2.engine.impl">org.apache.qpid.protonj2.engine.impl</a></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><a href="#org.apache.qpid.protonj2.engine.sasl">org.apache.qpid.protonj2.engine.sasl</a></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><a href="#org.apache.qpid.protonj2.engine.sasl.client">org.apache.qpid.protonj2.engine.sasl.client</a></div> |
| <div class="col-last odd-row-color"> </div> |
| </div> |
| <section class="class-uses"> |
| <ul class="block-list"> |
| <li> |
| <section class="detail" id="org.apache.qpid.protonj2.engine"> |
| <h2>Uses of <a href="../SaslClientContext.html" title="interface in org.apache.qpid.protonj2.engine.sasl">SaslClientContext</a> in <a href="../../package-summary.html">org.apache.qpid.protonj2.engine</a></h2> |
| <div class="caption"><span>Methods in <a href="../../package-summary.html">org.apache.qpid.protonj2.engine</a> that return <a href="../SaslClientContext.html" title="interface in org.apache.qpid.protonj2.engine.sasl">SaslClientContext</a></span></div> |
| <div class="summary-table three-column-summary"> |
| <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"><code><a href="../SaslClientContext.html" title="interface in org.apache.qpid.protonj2.engine.sasl">SaslClientContext</a></code></div> |
| <div class="col-second even-row-color"><span class="type-name-label">EngineSaslDriver.</span><code><a href="../../EngineSaslDriver.html#client()" class="member-name-link">client</a>()</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Configure this <a href="../../EngineSaslDriver.html" title="interface in org.apache.qpid.protonj2.engine"><code>EngineSaslDriver</code></a> to operate in client mode and return the associated |
| <a href="../SaslClientContext.html" title="interface in org.apache.qpid.protonj2.engine.sasl"><code>SaslClientContext</code></a> instance that should be used to complete the SASL negotiation |
| with the server end.</div> |
| </div> |
| </div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="org.apache.qpid.protonj2.engine.impl"> |
| <h2>Uses of <a href="../SaslClientContext.html" title="interface in org.apache.qpid.protonj2.engine.sasl">SaslClientContext</a> in <a href="../../impl/package-summary.html">org.apache.qpid.protonj2.engine.impl</a></h2> |
| <div class="caption"><span>Methods in <a href="../../impl/package-summary.html">org.apache.qpid.protonj2.engine.impl</a> that return <a href="../SaslClientContext.html" title="interface in org.apache.qpid.protonj2.engine.sasl">SaslClientContext</a></span></div> |
| <div class="summary-table three-column-summary"> |
| <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"><code><a href="../SaslClientContext.html" title="interface in org.apache.qpid.protonj2.engine.sasl">SaslClientContext</a></code></div> |
| <div class="col-second even-row-color"><span class="type-name-label">ProtonEngineNoOpSaslDriver.</span><code><a href="../../impl/ProtonEngineNoOpSaslDriver.html#client()" class="member-name-link">client</a>()</code></div> |
| <div class="col-last even-row-color"> </div> |
| </div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="org.apache.qpid.protonj2.engine.sasl"> |
| <h2>Uses of <a href="../SaslClientContext.html" title="interface in org.apache.qpid.protonj2.engine.sasl">SaslClientContext</a> in <a href="../package-summary.html">org.apache.qpid.protonj2.engine.sasl</a></h2> |
| <div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.qpid.protonj2.engine.sasl</a> that return <a href="../SaslClientContext.html" title="interface in org.apache.qpid.protonj2.engine.sasl">SaslClientContext</a></span></div> |
| <div class="summary-table three-column-summary"> |
| <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"><code><a href="../SaslClientContext.html" title="interface in org.apache.qpid.protonj2.engine.sasl">SaslClientContext</a></code></div> |
| <div class="col-second even-row-color"><span class="type-name-label">SaslClientContext.</span><code><a href="../SaslClientContext.html#saslFailure(javax.security.sasl.SaslException)" class="member-name-link">saslFailure</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.security.sasl/javax/security/sasl/SaslException.html" title="class or interface in javax.security.sasl" class="external-link">SaslException</a> failure)</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Allows the client implementation to fail the SASL negotiation process due to some |
| unrecoverable error.</div> |
| </div> |
| <div class="col-first odd-row-color"><code>default <a href="../SaslClientContext.html" title="interface in org.apache.qpid.protonj2.engine.sasl">SaslClientContext</a></code></div> |
| <div class="col-second odd-row-color"><span class="type-name-label">SaslClientContext.</span><code><a href="../SaslClientContext.html#sendChosenMechanism(java.lang.String,java.lang.String,org.apache.qpid.protonj2.buffer.ProtonBuffer)" class="member-name-link">sendChosenMechanism</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> mechanism, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> host, |
| <a href="../../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a> initialResponse)</code></div> |
| <div class="col-last odd-row-color"> |
| <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> |
| </div> |
| <div class="col-first even-row-color"><code><a href="../SaslClientContext.html" title="interface in org.apache.qpid.protonj2.engine.sasl">SaslClientContext</a></code></div> |
| <div class="col-second even-row-color"><span class="type-name-label">SaslClientContext.</span><code><a href="../SaslClientContext.html#sendChosenMechanism(org.apache.qpid.protonj2.types.Symbol,java.lang.String,org.apache.qpid.protonj2.buffer.ProtonBuffer)" class="member-name-link">sendChosenMechanism</a><wbr>(<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" title="class or interface in java.lang" class="external-link">String</a> host, |
| <a href="../../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a> initialResponse)</code></div> |
| <div class="col-last even-row-color"> |
| <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> |
| </div> |
| <div class="col-first odd-row-color"><code><a href="../SaslClientContext.html" title="interface in org.apache.qpid.protonj2.engine.sasl">SaslClientContext</a></code></div> |
| <div class="col-second odd-row-color"><span class="type-name-label">SaslClientContext.</span><code><a href="../SaslClientContext.html#sendResponse(org.apache.qpid.protonj2.buffer.ProtonBuffer)" class="member-name-link">sendResponse</a><wbr>(<a href="../../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a> response)</code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Sends a response to a server side challenge that comprises the challenge / response |
| exchange for the chosen SASL mechanism.</div> |
| </div> |
| <div class="col-first even-row-color"><code><a href="../SaslClientContext.html" title="interface in org.apache.qpid.protonj2.engine.sasl">SaslClientContext</a></code></div> |
| <div class="col-second even-row-color"><span class="type-name-label">SaslClientContext.</span><code><a href="../SaslClientContext.html#sendSASLHeader()" class="member-name-link">sendSASLHeader</a>()</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Sends the AMQP Header indicating the desire for SASL negotiations to be commenced on |
| this connection.</div> |
| </div> |
| <div class="col-first odd-row-color"><code><a href="../SaslClientContext.html" title="interface in org.apache.qpid.protonj2.engine.sasl">SaslClientContext</a></code></div> |
| <div class="col-second odd-row-color"><span class="type-name-label">SaslClientContext.</span><code><a href="../SaslClientContext.html#setListener(org.apache.qpid.protonj2.engine.sasl.SaslClientListener)" class="member-name-link">setListener</a><wbr>(<a href="../SaslClientListener.html" title="interface in org.apache.qpid.protonj2.engine.sasl">SaslClientListener</a> listener)</code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Sets the <a href="../SaslClientListener.html" title="interface in org.apache.qpid.protonj2.engine.sasl"><code>SaslClientListener</code></a> that will be used to driver the client side SASL |
| negotiations with a connected "server".</div> |
| </div> |
| </div> |
| <div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.qpid.protonj2.engine.sasl</a> with parameters of type <a href="../SaslClientContext.html" title="interface in org.apache.qpid.protonj2.engine.sasl">SaslClientContext</a></span></div> |
| <div class="summary-table three-column-summary"> |
| <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"><code>void</code></div> |
| <div class="col-second even-row-color"><span class="type-name-label">SaslClientListener.</span><code><a href="../SaslClientListener.html#handleSaslChallenge(org.apache.qpid.protonj2.engine.sasl.SaslClientContext,org.apache.qpid.protonj2.buffer.ProtonBuffer)" class="member-name-link">handleSaslChallenge</a><wbr>(<a href="../SaslClientContext.html" title="interface in org.apache.qpid.protonj2.engine.sasl">SaslClientContext</a> context, |
| <a href="../../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a> challenge)</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Called when a SASL challenge frame has arrived and its effect applied, indicating the |
| challenge sent by the 'server' peer.</div> |
| </div> |
| <div class="col-first odd-row-color"><code>void</code></div> |
| <div class="col-second odd-row-color"><span class="type-name-label">SaslClientListener.</span><code><a href="../SaslClientListener.html#handleSaslMechanisms(org.apache.qpid.protonj2.engine.sasl.SaslClientContext,org.apache.qpid.protonj2.types.Symbol%5B%5D)" class="member-name-link">handleSaslMechanisms</a><wbr>(<a href="../SaslClientContext.html" title="interface in org.apache.qpid.protonj2.engine.sasl">SaslClientContext</a> context, |
| <a href="../../../types/Symbol.html" title="class in org.apache.qpid.protonj2.types">Symbol</a>[] mechanisms)</code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Called when a SASL mechanisms frame has arrived and its effect applied, indicating |
| the offered mechanisms sent by the 'server' peer.</div> |
| </div> |
| <div class="col-first even-row-color"><code>void</code></div> |
| <div class="col-second even-row-color"><span class="type-name-label">SaslClientListener.</span><code><a href="../SaslClientListener.html#handleSaslOutcome(org.apache.qpid.protonj2.engine.sasl.SaslClientContext,org.apache.qpid.protonj2.engine.sasl.SaslOutcome,org.apache.qpid.protonj2.buffer.ProtonBuffer)" class="member-name-link">handleSaslOutcome</a><wbr>(<a href="../SaslClientContext.html" title="interface in org.apache.qpid.protonj2.engine.sasl">SaslClientContext</a> context, |
| <a href="../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></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Called when a SASL outcome frame has arrived and its effect applied, indicating the outcome and |
| any success additional data sent by the 'server' peer.</div> |
| </div> |
| <div class="col-first odd-row-color"><code>default void</code></div> |
| <div class="col-second odd-row-color"><span class="type-name-label">SaslClientListener.</span><code><a href="../SaslClientListener.html#initialize(org.apache.qpid.protonj2.engine.sasl.SaslClientContext)" class="member-name-link">initialize</a><wbr>(<a href="../SaslClientContext.html" title="interface in org.apache.qpid.protonj2.engine.sasl">SaslClientContext</a> context)</code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Called to give the application code a clear point to initialize all the client side expectations.</div> |
| </div> |
| </div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="org.apache.qpid.protonj2.engine.sasl.client"> |
| <h2>Uses of <a href="../SaslClientContext.html" title="interface in org.apache.qpid.protonj2.engine.sasl">SaslClientContext</a> in <a href="../client/package-summary.html">org.apache.qpid.protonj2.engine.sasl.client</a></h2> |
| <div class="caption"><span>Methods in <a href="../client/package-summary.html">org.apache.qpid.protonj2.engine.sasl.client</a> with parameters of type <a href="../SaslClientContext.html" title="interface in org.apache.qpid.protonj2.engine.sasl">SaslClientContext</a></span></div> |
| <div class="summary-table three-column-summary"> |
| <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"><code>void</code></div> |
| <div class="col-second even-row-color"><span class="type-name-label">SaslAuthenticator.</span><code><a href="../client/SaslAuthenticator.html#handleSaslChallenge(org.apache.qpid.protonj2.engine.sasl.SaslClientContext,org.apache.qpid.protonj2.buffer.ProtonBuffer)" class="member-name-link">handleSaslChallenge</a><wbr>(<a href="../SaslClientContext.html" title="interface in org.apache.qpid.protonj2.engine.sasl">SaslClientContext</a> context, |
| <a href="../../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a> challenge)</code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>void</code></div> |
| <div class="col-second odd-row-color"><span class="type-name-label">SaslAuthenticator.</span><code><a href="../client/SaslAuthenticator.html#handleSaslMechanisms(org.apache.qpid.protonj2.engine.sasl.SaslClientContext,org.apache.qpid.protonj2.types.Symbol%5B%5D)" class="member-name-link">handleSaslMechanisms</a><wbr>(<a href="../SaslClientContext.html" title="interface in org.apache.qpid.protonj2.engine.sasl">SaslClientContext</a> context, |
| <a href="../../../types/Symbol.html" title="class in org.apache.qpid.protonj2.types">Symbol</a>[] mechanisms)</code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>void</code></div> |
| <div class="col-second even-row-color"><span class="type-name-label">SaslAuthenticator.</span><code><a href="../client/SaslAuthenticator.html#handleSaslOutcome(org.apache.qpid.protonj2.engine.sasl.SaslClientContext,org.apache.qpid.protonj2.engine.sasl.SaslOutcome,org.apache.qpid.protonj2.buffer.ProtonBuffer)" class="member-name-link">handleSaslOutcome</a><wbr>(<a href="../SaslClientContext.html" title="interface in org.apache.qpid.protonj2.engine.sasl">SaslClientContext</a> context, |
| <a href="../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></div> |
| <div class="col-last even-row-color"> </div> |
| </div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
