| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>Uses of Interface org.apache.qpid.protonj2.engine.sasl.client.SaslCredentialsProvider (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="use: package: org.apache.qpid.protonj2.engine.sasl.client, interface: SaslCredentialsProvider"> |
| <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="../SaslCredentialsProvider.html" title="interface in org.apache.qpid.protonj2.engine.sasl.client">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.client.SaslCredentialsProvider" class="title">Uses of Interface<br>org.apache.qpid.protonj2.engine.sasl.client.SaslCredentialsProvider</h1> |
| </div> |
| <div class="caption"><span>Packages that use <a href="../SaslCredentialsProvider.html" title="interface in org.apache.qpid.protonj2.engine.sasl.client">SaslCredentialsProvider</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.sasl.client">org.apache.qpid.protonj2.engine.sasl.client</a></div> |
| <div class="col-last even-row-color"> </div> |
| </div> |
| <section class="class-uses"> |
| <ul class="block-list"> |
| <li> |
| <section class="detail" id="org.apache.qpid.protonj2.engine.sasl.client"> |
| <h2>Uses of <a href="../SaslCredentialsProvider.html" title="interface in org.apache.qpid.protonj2.engine.sasl.client">SaslCredentialsProvider</a> in <a href="../package-summary.html">org.apache.qpid.protonj2.engine.sasl.client</a></h2> |
| <div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.qpid.protonj2.engine.sasl.client</a> with parameters of type <a href="../SaslCredentialsProvider.html" title="interface in org.apache.qpid.protonj2.engine.sasl.client">SaslCredentialsProvider</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>protected <a href="../Mechanism.html" title="interface in org.apache.qpid.protonj2.engine.sasl.client">Mechanism</a></code></div> |
| <div class="col-second even-row-color"><span class="type-name-label">SaslMechanismSelector.</span><code><a href="../SaslMechanismSelector.html#createMechanism(org.apache.qpid.protonj2.types.Symbol,org.apache.qpid.protonj2.engine.sasl.client.SaslCredentialsProvider)" class="member-name-link">createMechanism</a><wbr>(<a href="../../../../types/Symbol.html" title="class in org.apache.qpid.protonj2.types">Symbol</a> name, |
| <a href="../SaslCredentialsProvider.html" title="interface in org.apache.qpid.protonj2.engine.sasl.client">SaslCredentialsProvider</a> credentials)</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Using the given <a href="../Mechanism.html" title="interface in org.apache.qpid.protonj2.engine.sasl.client"><code>Mechanism</code></a> name and the provided credentials create and configure a |
| <a href="../Mechanism.html" title="interface in org.apache.qpid.protonj2.engine.sasl.client"><code>Mechanism</code></a> for evaluation by the selector.</div> |
| </div> |
| <div class="col-first odd-row-color"><code><a href="../../../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a></code></div> |
| <div class="col-second odd-row-color"><span class="type-name-label">AbstractMechanism.</span><code><a href="../AbstractMechanism.html#getChallengeResponse(org.apache.qpid.protonj2.engine.sasl.client.SaslCredentialsProvider,org.apache.qpid.protonj2.buffer.ProtonBuffer)" class="member-name-link">getChallengeResponse</a><wbr>(<a href="../SaslCredentialsProvider.html" title="interface in org.apache.qpid.protonj2.engine.sasl.client">SaslCredentialsProvider</a> credentials, |
| <a href="../../../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a> challenge)</code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code><a href="../../../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a></code></div> |
| <div class="col-second even-row-color"><span class="type-name-label">CramMD5Mechanism.</span><code><a href="../CramMD5Mechanism.html#getChallengeResponse(org.apache.qpid.protonj2.engine.sasl.client.SaslCredentialsProvider,org.apache.qpid.protonj2.buffer.ProtonBuffer)" class="member-name-link">getChallengeResponse</a><wbr>(<a href="../SaslCredentialsProvider.html" title="interface in org.apache.qpid.protonj2.engine.sasl.client">SaslCredentialsProvider</a> credentials, |
| <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><a href="../../../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a></code></div> |
| <div class="col-second odd-row-color"><span class="type-name-label">Mechanism.</span><code><a href="../Mechanism.html#getChallengeResponse(org.apache.qpid.protonj2.engine.sasl.client.SaslCredentialsProvider,org.apache.qpid.protonj2.buffer.ProtonBuffer)" class="member-name-link">getChallengeResponse</a><wbr>(<a href="../SaslCredentialsProvider.html" title="interface in org.apache.qpid.protonj2.engine.sasl.client">SaslCredentialsProvider</a> credentials, |
| <a href="../../../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a> challenge)</code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Create a response based on a given challenge from the remote peer.</div> |
| </div> |
| <div class="col-first even-row-color"><code><a href="../../../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a></code></div> |
| <div class="col-second even-row-color"><span class="type-name-label">XOauth2Mechanism.</span><code><a href="../XOauth2Mechanism.html#getChallengeResponse(org.apache.qpid.protonj2.engine.sasl.client.SaslCredentialsProvider,org.apache.qpid.protonj2.buffer.ProtonBuffer)" class="member-name-link">getChallengeResponse</a><wbr>(<a href="../SaslCredentialsProvider.html" title="interface in org.apache.qpid.protonj2.engine.sasl.client">SaslCredentialsProvider</a> credentials, |
| <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><a href="../../../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a></code></div> |
| <div class="col-second odd-row-color"><span class="type-name-label">AbstractMechanism.</span><code><a href="../AbstractMechanism.html#getInitialResponse(org.apache.qpid.protonj2.engine.sasl.client.SaslCredentialsProvider)" class="member-name-link">getInitialResponse</a><wbr>(<a href="../SaslCredentialsProvider.html" title="interface in org.apache.qpid.protonj2.engine.sasl.client">SaslCredentialsProvider</a> credentials)</code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code><a href="../../../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a></code></div> |
| <div class="col-second even-row-color"><span class="type-name-label">CramMD5Mechanism.</span><code><a href="../CramMD5Mechanism.html#getInitialResponse(org.apache.qpid.protonj2.engine.sasl.client.SaslCredentialsProvider)" class="member-name-link">getInitialResponse</a><wbr>(<a href="../SaslCredentialsProvider.html" title="interface in org.apache.qpid.protonj2.engine.sasl.client">SaslCredentialsProvider</a> credentials)</code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code><a href="../../../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a></code></div> |
| <div class="col-second odd-row-color"><span class="type-name-label">Mechanism.</span><code><a href="../Mechanism.html#getInitialResponse(org.apache.qpid.protonj2.engine.sasl.client.SaslCredentialsProvider)" class="member-name-link">getInitialResponse</a><wbr>(<a href="../SaslCredentialsProvider.html" title="interface in org.apache.qpid.protonj2.engine.sasl.client">SaslCredentialsProvider</a> credentials)</code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Create an initial response based on selected mechanism.</div> |
| </div> |
| <div class="col-first even-row-color"><code><a href="../../../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a></code></div> |
| <div class="col-second even-row-color"><span class="type-name-label">PlainMechanism.</span><code><a href="../PlainMechanism.html#getInitialResponse(org.apache.qpid.protonj2.engine.sasl.client.SaslCredentialsProvider)" class="member-name-link">getInitialResponse</a><wbr>(<a href="../SaslCredentialsProvider.html" title="interface in org.apache.qpid.protonj2.engine.sasl.client">SaslCredentialsProvider</a> credentials)</code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code><a href="../../../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a></code></div> |
| <div class="col-second odd-row-color"><span class="type-name-label">XOauth2Mechanism.</span><code><a href="../XOauth2Mechanism.html#getInitialResponse(org.apache.qpid.protonj2.engine.sasl.client.SaslCredentialsProvider)" class="member-name-link">getInitialResponse</a><wbr>(<a href="../SaslCredentialsProvider.html" title="interface in org.apache.qpid.protonj2.engine.sasl.client">SaslCredentialsProvider</a> credentials)</code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>boolean</code></div> |
| <div class="col-second even-row-color"><span class="type-name-label">AnonymousMechanism.</span><code><a href="../AnonymousMechanism.html#isApplicable(org.apache.qpid.protonj2.engine.sasl.client.SaslCredentialsProvider)" class="member-name-link">isApplicable</a><wbr>(<a href="../SaslCredentialsProvider.html" title="interface in org.apache.qpid.protonj2.engine.sasl.client">SaslCredentialsProvider</a> credentials)</code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>boolean</code></div> |
| <div class="col-second odd-row-color"><span class="type-name-label">CramMD5Mechanism.</span><code><a href="../CramMD5Mechanism.html#isApplicable(org.apache.qpid.protonj2.engine.sasl.client.SaslCredentialsProvider)" class="member-name-link">isApplicable</a><wbr>(<a href="../SaslCredentialsProvider.html" title="interface in org.apache.qpid.protonj2.engine.sasl.client">SaslCredentialsProvider</a> credentials)</code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>boolean</code></div> |
| <div class="col-second even-row-color"><span class="type-name-label">ExternalMechanism.</span><code><a href="../ExternalMechanism.html#isApplicable(org.apache.qpid.protonj2.engine.sasl.client.SaslCredentialsProvider)" class="member-name-link">isApplicable</a><wbr>(<a href="../SaslCredentialsProvider.html" title="interface in org.apache.qpid.protonj2.engine.sasl.client">SaslCredentialsProvider</a> credentials)</code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>boolean</code></div> |
| <div class="col-second odd-row-color"><span class="type-name-label">Mechanism.</span><code><a href="../Mechanism.html#isApplicable(org.apache.qpid.protonj2.engine.sasl.client.SaslCredentialsProvider)" class="member-name-link">isApplicable</a><wbr>(<a href="../SaslCredentialsProvider.html" title="interface in org.apache.qpid.protonj2.engine.sasl.client">SaslCredentialsProvider</a> credentials)</code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Allows the Mechanism to determine if it is a valid choice based on the configured |
| credentials at the time of selection.</div> |
| </div> |
| <div class="col-first even-row-color"><code>boolean</code></div> |
| <div class="col-second even-row-color"><span class="type-name-label">PlainMechanism.</span><code><a href="../PlainMechanism.html#isApplicable(org.apache.qpid.protonj2.engine.sasl.client.SaslCredentialsProvider)" class="member-name-link">isApplicable</a><wbr>(<a href="../SaslCredentialsProvider.html" title="interface in org.apache.qpid.protonj2.engine.sasl.client">SaslCredentialsProvider</a> credentials)</code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>protected boolean</code></div> |
| <div class="col-second odd-row-color"><span class="type-name-label">SaslMechanismSelector.</span><code><a href="../SaslMechanismSelector.html#isApplicable(org.apache.qpid.protonj2.engine.sasl.client.Mechanism,org.apache.qpid.protonj2.engine.sasl.client.SaslCredentialsProvider)" class="member-name-link">isApplicable</a><wbr>(<a href="../Mechanism.html" title="interface in org.apache.qpid.protonj2.engine.sasl.client">Mechanism</a> candidate, |
| <a href="../SaslCredentialsProvider.html" title="interface in org.apache.qpid.protonj2.engine.sasl.client">SaslCredentialsProvider</a> credentials)</code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Tests a given <a href="../Mechanism.html" title="interface in org.apache.qpid.protonj2.engine.sasl.client"><code>Mechanism</code></a> instance to determine if it is applicable given the selector |
| configuration and the provided credentials.</div> |
| </div> |
| <div class="col-first even-row-color"><code>boolean</code></div> |
| <div class="col-second even-row-color"><span class="type-name-label">XOauth2Mechanism.</span><code><a href="../XOauth2Mechanism.html#isApplicable(org.apache.qpid.protonj2.engine.sasl.client.SaslCredentialsProvider)" class="member-name-link">isApplicable</a><wbr>(<a href="../SaslCredentialsProvider.html" title="interface in org.apache.qpid.protonj2.engine.sasl.client">SaslCredentialsProvider</a> credentials)</code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code><a href="../Mechanism.html" title="interface in org.apache.qpid.protonj2.engine.sasl.client">Mechanism</a></code></div> |
| <div class="col-second odd-row-color"><span class="type-name-label">SaslMechanismSelector.</span><code><a href="../SaslMechanismSelector.html#select(org.apache.qpid.protonj2.types.Symbol%5B%5D,org.apache.qpid.protonj2.engine.sasl.client.SaslCredentialsProvider)" class="member-name-link">select</a><wbr>(<a href="../../../../types/Symbol.html" title="class in org.apache.qpid.protonj2.types">Symbol</a>[] serverMechs, |
| <a href="../SaslCredentialsProvider.html" title="interface in org.apache.qpid.protonj2.engine.sasl.client">SaslCredentialsProvider</a> credentials)</code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Given a list of SASL mechanism names select a match from the supported types using the |
| configured allowed list and the given credentials.</div> |
| </div> |
| </div> |
| <div class="caption"><span>Constructors in <a href="../package-summary.html">org.apache.qpid.protonj2.engine.sasl.client</a> with parameters of type <a href="../SaslCredentialsProvider.html" title="interface in org.apache.qpid.protonj2.engine.sasl.client">SaslCredentialsProvider</a></span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier</div> |
| <div class="table-header col-second">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code> </code></div> |
| <div class="col-second even-row-color"><code><a href="../SaslAuthenticator.html#%3Cinit%3E(org.apache.qpid.protonj2.engine.sasl.client.SaslCredentialsProvider)" class="member-name-link">SaslAuthenticator</a><wbr>(<a href="../SaslCredentialsProvider.html" title="interface in org.apache.qpid.protonj2.engine.sasl.client">SaslCredentialsProvider</a> credentials)</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Creates a new SASL Authenticator initialized with the given credentials provider instance.</div> |
| </div> |
| <div class="col-first odd-row-color"><code> </code></div> |
| <div class="col-second odd-row-color"><code><a href="../SaslAuthenticator.html#%3Cinit%3E(org.apache.qpid.protonj2.engine.sasl.client.SaslMechanismSelector,org.apache.qpid.protonj2.engine.sasl.client.SaslCredentialsProvider)" class="member-name-link">SaslAuthenticator</a><wbr>(<a href="../SaslMechanismSelector.html" title="class in org.apache.qpid.protonj2.engine.sasl.client">SaslMechanismSelector</a> selector, |
| <a href="../SaslCredentialsProvider.html" title="interface in org.apache.qpid.protonj2.engine.sasl.client">SaslCredentialsProvider</a> credentials)</code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Creates a new client SASL Authenticator with the given <a href="../Mechanism.html" title="interface in org.apache.qpid.protonj2.engine.sasl.client"><code>Mechanism</code></a> and client credentials |
| provider instances.</div> |
| </div> |
| </div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </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> |
