| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>Mechanism (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="declaration: package: org.apache.qpid.protonj2.engine.sasl.client, interface: Mechanism"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../../script.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">Class</li> |
| <li><a href="class-use/Mechanism.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../../help-doc.html#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.qpid.protonj2.engine.sasl.client</a></div> |
| <h1 title="Interface Mechanism" class="title">Interface Mechanism</h1> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="AbstractMechanism.html" title="class in org.apache.qpid.protonj2.engine.sasl.client">AbstractMechanism</a></code>, <code><a href="AnonymousMechanism.html" title="class in org.apache.qpid.protonj2.engine.sasl.client">AnonymousMechanism</a></code>, <code><a href="CramMD5Mechanism.html" title="class in org.apache.qpid.protonj2.engine.sasl.client">CramMD5Mechanism</a></code>, <code><a href="ExternalMechanism.html" title="class in org.apache.qpid.protonj2.engine.sasl.client">ExternalMechanism</a></code>, <code><a href="PlainMechanism.html" title="class in org.apache.qpid.protonj2.engine.sasl.client">PlainMechanism</a></code>, <code><a href="ScramSHA1Mechanism.html" title="class in org.apache.qpid.protonj2.engine.sasl.client">ScramSHA1Mechanism</a></code>, <code><a href="ScramSHA256Mechanism.html" title="class in org.apache.qpid.protonj2.engine.sasl.client">ScramSHA256Mechanism</a></code>, <code><a href="ScramSHA512Mechanism.html" title="class in org.apache.qpid.protonj2.engine.sasl.client">ScramSHA512Mechanism</a></code>, <code><a href="XOauth2Mechanism.html" title="class in org.apache.qpid.protonj2.engine.sasl.client">XOauth2Mechanism</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">Mechanism</span></div> |
| <div class="block">Interface for all SASL authentication mechanism implementations.</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="../../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#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 method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Create a response based on a given challenge from the remote peer.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><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 method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#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 method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Create an initial response based on selected mechanism.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="../../../types/Symbol.html" title="class in org.apache.qpid.protonj2.types">Symbol</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getName()" class="member-name-link">getName</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#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 method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <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 method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#isEnabledByDefault()" class="member-name-link">isEnabledByDefault</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Allows the mechanism to indicate if it is enabled by default, or only when explicitly enabled |
| through configuring the permitted SASL mechanisms.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#verifyCompletion()" class="member-name-link">verifyCompletion</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Verifies that the SASL exchange has completed successfully.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="getName()"> |
| <h3>getName</h3> |
| <div class="member-signature"><span class="return-type"><a href="../../../types/Symbol.html" title="class in org.apache.qpid.protonj2.types">Symbol</a></span> <span class="element-name">getName</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the well known name of this SASL mechanism.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getInitialResponse(org.apache.qpid.protonj2.engine.sasl.client.SaslCredentialsProvider)"> |
| <h3>getInitialResponse</h3> |
| <div class="member-signature"><span class="return-type"><a href="../../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a></span> <span class="element-name">getInitialResponse</span><wbr><span class="parameters">(<a href="SaslCredentialsProvider.html" title="interface in org.apache.qpid.protonj2.engine.sasl.client">SaslCredentialsProvider</a> credentials)</span> |
| throws <span class="exceptions"><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></span></div> |
| <div class="block">Create an initial response based on selected mechanism. |
| |
| May be null if there is no initial response.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>credentials</code> - The credentials that are supplied for this SASL negotiation.</dd> |
| <dt>Returns:</dt> |
| <dd>the initial response, or null if there isn't one.</dd> |
| <dt>Throws:</dt> |
| <dd><code><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></code> - if an error occurs generating the initial response.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getChallengeResponse(org.apache.qpid.protonj2.engine.sasl.client.SaslCredentialsProvider,org.apache.qpid.protonj2.buffer.ProtonBuffer)"> |
| <h3>getChallengeResponse</h3> |
| <div class="member-signature"><span class="return-type"><a href="../../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a></span> <span class="element-name">getChallengeResponse</span><wbr><span class="parameters">(<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)</span> |
| throws <span class="exceptions"><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></span></div> |
| <div class="block">Create a response based on a given challenge from the remote peer.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>credentials</code> - The credentials that are supplied for this SASL negotiation.</dd> |
| <dd><code>challenge</code> - The challenge that this Mechanism should response to.</dd> |
| <dt>Returns:</dt> |
| <dd>the response that answers the given challenge.</dd> |
| <dt>Throws:</dt> |
| <dd><code><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></code> - if an error occurs generating the challenge response.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="verifyCompletion()"> |
| <h3>verifyCompletion</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">verifyCompletion</span>() |
| throws <span class="exceptions"><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></span></div> |
| <div class="block">Verifies that the SASL exchange has completed successfully. This is |
| an opportunity for the mechanism to ensure that all mandatory |
| steps have been completed successfully and to cleanup and resources |
| that are held by this Mechanism.</div> |
| <dl class="notes"> |
| <dt>Throws:</dt> |
| <dd><code><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></code> - if the outcome of the SASL exchange is not valid for this Mechanism</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isApplicable(org.apache.qpid.protonj2.engine.sasl.client.SaslCredentialsProvider)"> |
| <h3>isApplicable</h3> |
| <div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">isApplicable</span><wbr><span class="parameters">(<a href="SaslCredentialsProvider.html" title="interface in org.apache.qpid.protonj2.engine.sasl.client">SaslCredentialsProvider</a> credentials)</span></div> |
| <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> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>credentials</code> - the login credentials available at the time of mechanism selection.</dd> |
| <dt>Returns:</dt> |
| <dd>true if the mechanism can be used with the provided credentials</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isEnabledByDefault()"> |
| <h3>isEnabledByDefault</h3> |
| <div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">isEnabledByDefault</span>()</div> |
| <div class="block">Allows the mechanism to indicate if it is enabled by default, or only when explicitly enabled |
| through configuring the permitted SASL mechanisms. Any mechanism selection logic should examine |
| this value along with the configured allowed mechanism and decide if this one should be used. |
| |
| Typically most mechanisms can be enabled by default but some require explicit configuration |
| in order to operate which implies that selecting them by default would always cause an authentication |
| error if that mechanism matches the highest priority value offered by the remote peer.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>true if this Mechanism is enabled by default.</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </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> |
