Google Git
Sign in
apache / qpid-site / a52bbf4a24b0bdf923763f81d78481d22102177f / . / input / releases / qpid-protonj2-1.0.0-M9 / api / org / apache / qpid / protonj2 / engine / sasl / client / SaslMechanismSelector.html
blob: ea76b4de467823fe77debbbe58a225325c57f0d4 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>SaslMechanismSelector (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="SaslMechanismSelector (Qpid ProtonJ2 Parent 1.0.0-M9 API)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":10,"i3":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</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 class="navBarCell1Rev">Class</li>
<li><a href="class-use/SaslMechanismSelector.html">Use</a></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&nbsp;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>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.apache.qpid.protonj2.engine.sasl.client</a></div>
<h2 title="Class SaslMechanismSelector" class="title">Class SaslMechanismSelector</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.apache.qpid.protonj2.engine.sasl.client.SaslMechanismSelector</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<pre>public class <span class="typeNameLabel">SaslMechanismSelector</span>
extends <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></pre>
<div class="block">Client side mechanism used to select a matching mechanism from the server offered list of
mechanisms. The client configures the list of allowed <a href="Mechanism.html" title="interface in org.apache.qpid.protonj2.engine.sasl.client"><code>Mechanism</code></a> names and when the
server mechanisms are offered mechanism is chosen from the allowed set. If the client does
not configure any mechanisms then the selector chooses from all supported <a href="Mechanism.html" title="interface in org.apache.qpid.protonj2.engine.sasl.client"><code>Mechanism</code></a>
types.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">SaslMechanismSelector</a></span>()</code></th>
<td class="colLast">
<div class="block">Creates a new <a href="Mechanism.html" title="interface in org.apache.qpid.protonj2.engine.sasl.client"><code>Mechanism</code></a> selector that will choose a match from all supported <a href="Mechanism.html" title="interface in org.apache.qpid.protonj2.engine.sasl.client"><code>Mechanism</code></a> types.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(java.util.Collection)">SaslMechanismSelector</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a>&lt;<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>&gt;&nbsp;allowed)</code></th>
<td class="colLast">
<div class="block">Creates a new <a href="Mechanism.html" title="interface in org.apache.qpid.protonj2.engine.sasl.client"><code>Mechanism</code></a> selector configured with the given set of allowed <a href="Mechanism.html" title="interface in org.apache.qpid.protonj2.engine.sasl.client"><code>Mechanism</code></a> names.</div>
</td>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(java.util.Set)">SaslMechanismSelector</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Set.html?is-external=true" title="class or interface in java.util" class="externalLink">Set</a>&lt;<a href="../../../types/Symbol.html" title="class in org.apache.qpid.protonj2.types">Symbol</a>&gt;&nbsp;allowed)</code></th>
<td class="colLast">
<div class="block">Creates a new <a href="Mechanism.html" title="interface in org.apache.qpid.protonj2.engine.sasl.client"><code>Mechanism</code></a> selector configured with the given set of allowed <a href="Mechanism.html" title="interface in org.apache.qpid.protonj2.engine.sasl.client"><code>Mechanism</code></a> names.</div>
</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></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>
<tr id="i0" 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"><code><span class="memberNameLink"><a href="#createMechanism(org.apache.qpid.protonj2.types.Symbol,org.apache.qpid.protonj2.engine.sasl.client.SaslCredentialsProvider)">createMechanism</a></span>&#8203;(<a href="../../../types/Symbol.html" title="class in org.apache.qpid.protonj2.types">Symbol</a>&nbsp;name,
<a href="SaslCredentialsProvider.html" title="interface in org.apache.qpid.protonj2.engine.sasl.client">SaslCredentialsProvider</a>&nbsp;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 id="i1" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Set.html?is-external=true" title="class or interface in java.util" class="externalLink">Set</a>&lt;<a href="../../../types/Symbol.html" title="class in org.apache.qpid.protonj2.types">Symbol</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAllowedMechanisms()">getAllowedMechanisms</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>protected boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isApplicable(org.apache.qpid.protonj2.engine.sasl.client.Mechanism,org.apache.qpid.protonj2.engine.sasl.client.SaslCredentialsProvider)">isApplicable</a></span>&#8203;(<a href="Mechanism.html" title="interface in org.apache.qpid.protonj2.engine.sasl.client">Mechanism</a>&nbsp;candidate,
<a href="SaslCredentialsProvider.html" title="interface in org.apache.qpid.protonj2.engine.sasl.client">SaslCredentialsProvider</a>&nbsp;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 id="i3" 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"><code><span class="memberNameLink"><a href="#select(org.apache.qpid.protonj2.types.Symbol%5B%5D,org.apache.qpid.protonj2.engine.sasl.client.SaslCredentialsProvider)">select</a></span>&#8203;(<a href="../../../types/Symbol.html" title="class in org.apache.qpid.protonj2.types">Symbol</a>[]&nbsp;serverMechs,
<a href="SaslCredentialsProvider.html" title="interface in org.apache.qpid.protonj2.engine.sasl.client">SaslCredentialsProvider</a>&nbsp;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>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></h3>
<code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang" class="externalLink">clone</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink">equals</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang" class="externalLink">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang" class="externalLink">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang" class="externalLink">toString</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#wait(long,int)" title="class or interface in java.lang" class="externalLink">wait</a></code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SaslMechanismSelector</h4>
<pre>public&nbsp;SaslMechanismSelector()</pre>
<div class="block">Creates a new <a href="Mechanism.html" title="interface in org.apache.qpid.protonj2.engine.sasl.client"><code>Mechanism</code></a> selector that will choose a match from all supported <a href="Mechanism.html" title="interface in org.apache.qpid.protonj2.engine.sasl.client"><code>Mechanism</code></a> types.</div>
</li>
</ul>
<a id="&lt;init&gt;(java.util.Collection)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SaslMechanismSelector</h4>
<pre>public&nbsp;SaslMechanismSelector&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a>&lt;<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>&gt;&nbsp;allowed)</pre>
<div class="block">Creates a new <a href="Mechanism.html" title="interface in org.apache.qpid.protonj2.engine.sasl.client"><code>Mechanism</code></a> selector configured with the given set of allowed <a href="Mechanism.html" title="interface in org.apache.qpid.protonj2.engine.sasl.client"><code>Mechanism</code></a> names.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>allowed</code> - A <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink"><code>Collection</code></a> of SASL mechanism names that are allowed to be used when selecting a matching mechanism.</dd>
</dl>
</li>
</ul>
<a id="&lt;init&gt;(java.util.Set)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>SaslMechanismSelector</h4>
<pre>public&nbsp;SaslMechanismSelector&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Set.html?is-external=true" title="class or interface in java.util" class="externalLink">Set</a>&lt;<a href="../../../types/Symbol.html" title="class in org.apache.qpid.protonj2.types">Symbol</a>&gt;&nbsp;allowed)</pre>
<div class="block">Creates a new <a href="Mechanism.html" title="interface in org.apache.qpid.protonj2.engine.sasl.client"><code>Mechanism</code></a> selector configured with the given set of allowed <a href="Mechanism.html" title="interface in org.apache.qpid.protonj2.engine.sasl.client"><code>Mechanism</code></a> names.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>allowed</code> - A <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Set.html?is-external=true" title="class or interface in java.util" class="externalLink"><code>Set</code></a> of SASL mechanism names that are allowed to be used when selecting a matching mechanism.</dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="getAllowedMechanisms()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAllowedMechanisms</h4>
<pre class="methodSignature">public&nbsp;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Set.html?is-external=true" title="class or interface in java.util" class="externalLink">Set</a>&lt;<a href="../../../types/Symbol.html" title="class in org.apache.qpid.protonj2.types">Symbol</a>&gt;&nbsp;getAllowedMechanisms()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the configured set of allowed SASL <a href="Mechanism.html" title="interface in org.apache.qpid.protonj2.engine.sasl.client"><code>Mechanism</code></a> names.</dd>
</dl>
</li>
</ul>
<a id="select(org.apache.qpid.protonj2.types.Symbol[],org.apache.qpid.protonj2.engine.sasl.client.SaslCredentialsProvider)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>select</h4>
<pre class="methodSignature">public&nbsp;<a href="Mechanism.html" title="interface in org.apache.qpid.protonj2.engine.sasl.client">Mechanism</a>&nbsp;select&#8203;(<a href="../../../types/Symbol.html" title="class in org.apache.qpid.protonj2.types">Symbol</a>[]&nbsp;serverMechs,
<a href="SaslCredentialsProvider.html" title="interface in org.apache.qpid.protonj2.engine.sasl.client">SaslCredentialsProvider</a>&nbsp;credentials)</pre>
<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>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>serverMechs</code> - The list of mechanisms the server indicates it supports.</dd>
<dd><code>credentials</code> - A <a href="SaslCredentialsProvider.html" title="interface in org.apache.qpid.protonj2.engine.sasl.client"><code>SaslCredentialsProvider</code></a> used to choose an matching applicable SASL <a href="Mechanism.html" title="interface in org.apache.qpid.protonj2.engine.sasl.client"><code>Mechanism</code></a>.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a selected SASL <a href="Mechanism.html" title="interface in org.apache.qpid.protonj2.engine.sasl.client"><code>Mechanism</code></a> instance or null of no match is possible.</dd>
</dl>
</li>
</ul>
<a id="createMechanism(org.apache.qpid.protonj2.types.Symbol,org.apache.qpid.protonj2.engine.sasl.client.SaslCredentialsProvider)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createMechanism</h4>
<pre class="methodSignature">protected&nbsp;<a href="Mechanism.html" title="interface in org.apache.qpid.protonj2.engine.sasl.client">Mechanism</a>&nbsp;createMechanism&#8203;(<a href="../../../types/Symbol.html" title="class in org.apache.qpid.protonj2.types">Symbol</a>&nbsp;name,
<a href="SaslCredentialsProvider.html" title="interface in org.apache.qpid.protonj2.engine.sasl.client">SaslCredentialsProvider</a>&nbsp;credentials)</pre>
<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>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - A mechanism name that matches one of the supported offerings by the remote</dd>
<dd><code>credentials</code> - The provided credentials that will be used to perform authentication with the remote.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a new <a href="Mechanism.html" title="interface in org.apache.qpid.protonj2.engine.sasl.client"><code>Mechanism</code></a> instance or null the offered mechanism is unsupported.</dd>
</dl>
</li>
</ul>
<a id="isApplicable(org.apache.qpid.protonj2.engine.sasl.client.Mechanism,org.apache.qpid.protonj2.engine.sasl.client.SaslCredentialsProvider)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>isApplicable</h4>
<pre class="methodSignature">protected&nbsp;boolean&nbsp;isApplicable&#8203;(<a href="Mechanism.html" title="interface in org.apache.qpid.protonj2.engine.sasl.client">Mechanism</a>&nbsp;candidate,
<a href="SaslCredentialsProvider.html" title="interface in org.apache.qpid.protonj2.engine.sasl.client">SaslCredentialsProvider</a>&nbsp;credentials)</pre>
<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>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>candidate</code> - The SASL mechanism that matches both the allowed and the server offered lists.</dd>
<dd><code>credentials</code> - The provided SASL credentials which will be used when authenticating with the remote.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if the candidate <a href="Mechanism.html" title="interface in org.apache.qpid.protonj2.engine.sasl.client"><code>Mechanism</code></a> is applicable given the provide credentials.</dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<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 class="navBarCell1Rev">Class</li>
<li><a href="class-use/SaslMechanismSelector.html">Use</a></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&nbsp;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>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &#169; 2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</body>
</html>