| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>Uses of Interface org.apache.qpid.protonj2.engine.sasl.client.SaslCredentialsProvider (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 Interface org.apache.qpid.protonj2.engine.sasl.client.SaslCredentialsProvider (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="../SaslCredentialsProvider.html" title="interface in org.apache.qpid.protonj2.engine.sasl.client">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 Interface org.apache.qpid.protonj2.engine.sasl.client.SaslCredentialsProvider" class="title">Uses of Interface<br>org.apache.qpid.protonj2.engine.sasl.client.SaslCredentialsProvider</h2> |
| </div> |
| <div class="classUseContainer"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <table class="useSummary"> |
| <caption><span>Packages that use <a href="../SaslCredentialsProvider.html" title="interface in org.apache.qpid.protonj2.engine.sasl.client">SaslCredentialsProvider</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.sasl.client">org.apache.qpid.protonj2.engine.sasl.client</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.sasl.client"> |
| <!-- --> |
| </a> |
| <h3>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></h3> |
| <table class="useSummary"> |
| <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><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>protected <a href="../Mechanism.html" title="interface in org.apache.qpid.protonj2.engine.sasl.client">Mechanism</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">SaslMechanismSelector.</span><code><span class="memberNameLink"><a href="../SaslMechanismSelector.html#createMechanism(org.apache.qpid.protonj2.types.Symbol,org.apache.qpid.protonj2.engine.sasl.client.SaslCredentialsProvider)">createMechanism</a></span>​(<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></th> |
| <td class="colLast"> |
| <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> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">AbstractMechanism.</span><code><span class="memberNameLink"><a href="../AbstractMechanism.html#getChallengeResponse(org.apache.qpid.protonj2.engine.sasl.client.SaslCredentialsProvider,org.apache.qpid.protonj2.buffer.ProtonBuffer)">getChallengeResponse</a></span>​(<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></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">CramMD5Mechanism.</span><code><span class="memberNameLink"><a href="../CramMD5Mechanism.html#getChallengeResponse(org.apache.qpid.protonj2.engine.sasl.client.SaslCredentialsProvider,org.apache.qpid.protonj2.buffer.ProtonBuffer)">getChallengeResponse</a></span>​(<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></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">Mechanism.</span><code><span class="memberNameLink"><a href="../Mechanism.html#getChallengeResponse(org.apache.qpid.protonj2.engine.sasl.client.SaslCredentialsProvider,org.apache.qpid.protonj2.buffer.ProtonBuffer)">getChallengeResponse</a></span>​(<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></th> |
| <td class="colLast"> |
| <div class="block">Create a response based on a given challenge from the remote peer.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">XOauth2Mechanism.</span><code><span class="memberNameLink"><a href="../XOauth2Mechanism.html#getChallengeResponse(org.apache.qpid.protonj2.engine.sasl.client.SaslCredentialsProvider,org.apache.qpid.protonj2.buffer.ProtonBuffer)">getChallengeResponse</a></span>​(<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></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">AbstractMechanism.</span><code><span class="memberNameLink"><a href="../AbstractMechanism.html#getInitialResponse(org.apache.qpid.protonj2.engine.sasl.client.SaslCredentialsProvider)">getInitialResponse</a></span>​(<a href="../SaslCredentialsProvider.html" title="interface in org.apache.qpid.protonj2.engine.sasl.client">SaslCredentialsProvider</a> credentials)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">CramMD5Mechanism.</span><code><span class="memberNameLink"><a href="../CramMD5Mechanism.html#getInitialResponse(org.apache.qpid.protonj2.engine.sasl.client.SaslCredentialsProvider)">getInitialResponse</a></span>​(<a href="../SaslCredentialsProvider.html" title="interface in org.apache.qpid.protonj2.engine.sasl.client">SaslCredentialsProvider</a> credentials)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">Mechanism.</span><code><span class="memberNameLink"><a href="../Mechanism.html#getInitialResponse(org.apache.qpid.protonj2.engine.sasl.client.SaslCredentialsProvider)">getInitialResponse</a></span>​(<a href="../SaslCredentialsProvider.html" title="interface in org.apache.qpid.protonj2.engine.sasl.client">SaslCredentialsProvider</a> credentials)</code></th> |
| <td class="colLast"> |
| <div class="block">Create an initial response based on selected mechanism.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">PlainMechanism.</span><code><span class="memberNameLink"><a href="../PlainMechanism.html#getInitialResponse(org.apache.qpid.protonj2.engine.sasl.client.SaslCredentialsProvider)">getInitialResponse</a></span>​(<a href="../SaslCredentialsProvider.html" title="interface in org.apache.qpid.protonj2.engine.sasl.client">SaslCredentialsProvider</a> credentials)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">XOauth2Mechanism.</span><code><span class="memberNameLink"><a href="../XOauth2Mechanism.html#getInitialResponse(org.apache.qpid.protonj2.engine.sasl.client.SaslCredentialsProvider)">getInitialResponse</a></span>​(<a href="../SaslCredentialsProvider.html" title="interface in org.apache.qpid.protonj2.engine.sasl.client">SaslCredentialsProvider</a> credentials)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">AnonymousMechanism.</span><code><span class="memberNameLink"><a href="../AnonymousMechanism.html#isApplicable(org.apache.qpid.protonj2.engine.sasl.client.SaslCredentialsProvider)">isApplicable</a></span>​(<a href="../SaslCredentialsProvider.html" title="interface in org.apache.qpid.protonj2.engine.sasl.client">SaslCredentialsProvider</a> credentials)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">CramMD5Mechanism.</span><code><span class="memberNameLink"><a href="../CramMD5Mechanism.html#isApplicable(org.apache.qpid.protonj2.engine.sasl.client.SaslCredentialsProvider)">isApplicable</a></span>​(<a href="../SaslCredentialsProvider.html" title="interface in org.apache.qpid.protonj2.engine.sasl.client">SaslCredentialsProvider</a> credentials)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">ExternalMechanism.</span><code><span class="memberNameLink"><a href="../ExternalMechanism.html#isApplicable(org.apache.qpid.protonj2.engine.sasl.client.SaslCredentialsProvider)">isApplicable</a></span>​(<a href="../SaslCredentialsProvider.html" title="interface in org.apache.qpid.protonj2.engine.sasl.client">SaslCredentialsProvider</a> credentials)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">Mechanism.</span><code><span class="memberNameLink"><a href="../Mechanism.html#isApplicable(org.apache.qpid.protonj2.engine.sasl.client.SaslCredentialsProvider)">isApplicable</a></span>​(<a href="../SaslCredentialsProvider.html" title="interface in org.apache.qpid.protonj2.engine.sasl.client">SaslCredentialsProvider</a> credentials)</code></th> |
| <td class="colLast"> |
| <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> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">PlainMechanism.</span><code><span class="memberNameLink"><a href="../PlainMechanism.html#isApplicable(org.apache.qpid.protonj2.engine.sasl.client.SaslCredentialsProvider)">isApplicable</a></span>​(<a href="../SaslCredentialsProvider.html" title="interface in org.apache.qpid.protonj2.engine.sasl.client">SaslCredentialsProvider</a> credentials)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">SaslMechanismSelector.</span><code><span class="memberNameLink"><a href="../SaslMechanismSelector.html#isApplicable(org.apache.qpid.protonj2.engine.sasl.client.Mechanism,org.apache.qpid.protonj2.engine.sasl.client.SaslCredentialsProvider)">isApplicable</a></span>​(<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></th> |
| <td class="colLast"> |
| <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> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">XOauth2Mechanism.</span><code><span class="memberNameLink"><a href="../XOauth2Mechanism.html#isApplicable(org.apache.qpid.protonj2.engine.sasl.client.SaslCredentialsProvider)">isApplicable</a></span>​(<a href="../SaslCredentialsProvider.html" title="interface in org.apache.qpid.protonj2.engine.sasl.client">SaslCredentialsProvider</a> credentials)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../Mechanism.html" title="interface in org.apache.qpid.protonj2.engine.sasl.client">Mechanism</a></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">SaslMechanismSelector.</span><code><span class="memberNameLink"><a href="../SaslMechanismSelector.html#select(org.apache.qpid.protonj2.types.Symbol%5B%5D,org.apache.qpid.protonj2.engine.sasl.client.SaslCredentialsProvider)">select</a></span>​(<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></th> |
| <td class="colLast"> |
| <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> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <table class="useSummary"> |
| <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><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Constructor</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../SaslAuthenticator.html#%3Cinit%3E(org.apache.qpid.protonj2.engine.sasl.client.SaslCredentialsProvider)">SaslAuthenticator</a></span>​(<a href="../SaslCredentialsProvider.html" title="interface in org.apache.qpid.protonj2.engine.sasl.client">SaslCredentialsProvider</a> credentials)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a new SASL Authenticator initialized with the given credentials provider instance.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../SaslAuthenticator.html#%3Cinit%3E(org.apache.qpid.protonj2.engine.sasl.client.SaslMechanismSelector,org.apache.qpid.protonj2.engine.sasl.client.SaslCredentialsProvider)">SaslAuthenticator</a></span>​(<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></th> |
| <td class="colLast"> |
| <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> |
| </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="../SaslCredentialsProvider.html" title="interface in org.apache.qpid.protonj2.engine.sasl.client">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> |
