blob: 8c3b9bfde69d5ed64452bfb9f657a15f67f98ee4 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>SaslClientAuthenticationProviders (Apache HBase 3.0.0-alpha-2-SNAPSHOT API)</title>
<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="SaslClientAuthenticationProviders (Apache HBase 3.0.0-alpha-2-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":9,"i1":9,"i2":9,"i3":10,"i4":10,"i5":9,"i6":9,"i7":9,"i8":10,"i9":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static 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>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/SaslClientAuthenticationProviders.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="../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../org/apache/hadoop/hbase/security/provider/SaslClientAuthenticationProvider.html" title="interface in org.apache.hadoop.hbase.security.provider"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/hadoop/hbase/security/provider/SaslServerAuthenticationProvider.html" title="interface in org.apache.hadoop.hbase.security.provider"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/hadoop/hbase/security/provider/SaslClientAuthenticationProviders.html" target="_top">Frames</a></li>
<li><a href="SaslClientAuthenticationProviders.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../allclasses-noframe.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>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&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><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.hadoop.hbase.security.provider</div>
<h2 title="Class SaslClientAuthenticationProviders" class="title">Class SaslClientAuthenticationProviders</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.apache.hadoop.hbase.security.provider.SaslClientAuthenticationProviders</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>@InterfaceAudience.LimitedPrivate(value="Authentication")
@InterfaceStability.Evolving
public final class <a href="../../../../../../src-html/org/apache/hadoop/hbase/security/provider/SaslClientAuthenticationProviders.html#line.45">SaslClientAuthenticationProviders</a>
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
<div class="block">Accessor for all SaslAuthenticationProvider instances.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/security/provider/SaslClientAuthenticationProviders.html#EXTRA_PROVIDERS_KEY">EXTRA_PROVIDERS_KEY</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private static org.slf4j.Logger</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/security/provider/SaslClientAuthenticationProviders.html#LOG">LOG</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&lt;<a href="../../../../../../org/apache/hadoop/hbase/security/provider/SaslClientAuthenticationProvider.html" title="interface in org.apache.hadoop.hbase.security.provider">SaslClientAuthenticationProvider</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/security/provider/SaslClientAuthenticationProviders.html#providers">providers</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private static <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/atomic/AtomicReference.html?is-external=true" title="class or interface in java.util.concurrent.atomic">AtomicReference</a>&lt;<a href="../../../../../../org/apache/hadoop/hbase/security/provider/SaslClientAuthenticationProviders.html" title="class in org.apache.hadoop.hbase.security.provider">SaslClientAuthenticationProviders</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/security/provider/SaslClientAuthenticationProviders.html#providersRef">providersRef</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private <a href="../../../../../../org/apache/hadoop/hbase/security/provider/AuthenticationProviderSelector.html" title="interface in org.apache.hadoop.hbase.security.provider">AuthenticationProviderSelector</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/security/provider/SaslClientAuthenticationProviders.html#selector">selector</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/security/provider/SaslClientAuthenticationProviders.html#SELECTOR_KEY">SELECTOR_KEY</a></span></code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier</th>
<th class="colLast" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private </code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/security/provider/SaslClientAuthenticationProviders.html#SaslClientAuthenticationProviders-java.util.Collection-org.apache.hadoop.hbase.security.provider.AuthenticationProviderSelector-">SaslClientAuthenticationProviders</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&lt;<a href="../../../../../../org/apache/hadoop/hbase/security/provider/SaslClientAuthenticationProvider.html" title="interface in org.apache.hadoop.hbase.security.provider">SaslClientAuthenticationProvider</a>&gt;&nbsp;providers,
<a href="../../../../../../org/apache/hadoop/hbase/security/provider/AuthenticationProviderSelector.html" title="interface in org.apache.hadoop.hbase.security.provider">AuthenticationProviderSelector</a>&nbsp;selector)</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>(package private) static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/security/provider/SaslClientAuthenticationProviders.html#addExplicitProviders-org.apache.hadoop.conf.Configuration-java.util.HashMap-">addExplicitProviders</a></span>(org.apache.hadoop.conf.Configuration&nbsp;conf,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/HashMap.html?is-external=true" title="class or interface in java.util">HashMap</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Byte.html?is-external=true" title="class or interface in java.lang">Byte</a>,<a href="../../../../../../org/apache/hadoop/hbase/security/provider/SaslClientAuthenticationProvider.html" title="interface in org.apache.hadoop.hbase.security.provider">SaslClientAuthenticationProvider</a>&gt;&nbsp;providers)</code>
<div class="block">Extracts and instantiates authentication providers from the configuration.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>(package private) static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/security/provider/SaslClientAuthenticationProviders.html#addProviderIfNotExists-org.apache.hadoop.hbase.security.provider.SaslClientAuthenticationProvider-java.util.HashMap-">addProviderIfNotExists</a></span>(<a href="../../../../../../org/apache/hadoop/hbase/security/provider/SaslClientAuthenticationProvider.html" title="interface in org.apache.hadoop.hbase.security.provider">SaslClientAuthenticationProvider</a>&nbsp;provider,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/HashMap.html?is-external=true" title="class or interface in java.util">HashMap</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Byte.html?is-external=true" title="class or interface in java.lang">Byte</a>,<a href="../../../../../../org/apache/hadoop/hbase/security/provider/SaslClientAuthenticationProvider.html" title="interface in org.apache.hadoop.hbase.security.provider">SaslClientAuthenticationProvider</a>&gt;&nbsp;providers)</code>
<div class="block">Adds the given <code>provider</code> to the set, only if an equivalent provider does not
already exist in the set.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static <a href="../../../../../../org/apache/hadoop/hbase/security/provider/SaslClientAuthenticationProviders.html" title="class in org.apache.hadoop.hbase.security.provider">SaslClientAuthenticationProviders</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/security/provider/SaslClientAuthenticationProviders.html#getInstance-org.apache.hadoop.conf.Configuration-">getInstance</a></span>(org.apache.hadoop.conf.Configuration&nbsp;conf)</code>
<div class="block">Returns a singleton instance of <a href="../../../../../../org/apache/hadoop/hbase/security/provider/SaslClientAuthenticationProviders.html" title="class in org.apache.hadoop.hbase.security.provider"><code>SaslClientAuthenticationProviders</code></a>.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/security/provider/SaslClientAuthenticationProviders.html#getNumRegisteredProviders--">getNumRegisteredProviders</a></span>()</code>
<div class="block">Returns the number of providers that have been registered.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/hadoop/hbase/util/Pair.html" title="class in org.apache.hadoop.hbase.util">Pair</a>&lt;<a href="../../../../../../org/apache/hadoop/hbase/security/provider/SaslClientAuthenticationProvider.html" title="interface in org.apache.hadoop.hbase.security.provider">SaslClientAuthenticationProvider</a>,org.apache.hadoop.security.token.Token&lt;? extends org.apache.hadoop.security.token.TokenIdentifier&gt;&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/security/provider/SaslClientAuthenticationProviders.html#getSimpleProvider--">getSimpleProvider</a></span>()</code>
<div class="block">Returns the provider and token pair for SIMPLE authentication.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>(package private) static <a href="../../../../../../org/apache/hadoop/hbase/security/provider/SaslClientAuthenticationProviders.html" title="class in org.apache.hadoop.hbase.security.provider">SaslClientAuthenticationProviders</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/security/provider/SaslClientAuthenticationProviders.html#instantiate-org.apache.hadoop.conf.Configuration-">instantiate</a></span>(org.apache.hadoop.conf.Configuration&nbsp;conf)</code>
<div class="block">Instantiates all client authentication providers and returns an instance of
<a href="../../../../../../org/apache/hadoop/hbase/security/provider/SaslClientAuthenticationProviders.html" title="class in org.apache.hadoop.hbase.security.provider"><code>SaslClientAuthenticationProviders</code></a>.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>(package private) static <a href="../../../../../../org/apache/hadoop/hbase/security/provider/AuthenticationProviderSelector.html" title="interface in org.apache.hadoop.hbase.security.provider">AuthenticationProviderSelector</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/security/provider/SaslClientAuthenticationProviders.html#instantiateSelector-org.apache.hadoop.conf.Configuration-java.util.Collection-">instantiateSelector</a></span>(org.apache.hadoop.conf.Configuration&nbsp;conf,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&lt;<a href="../../../../../../org/apache/hadoop/hbase/security/provider/SaslClientAuthenticationProvider.html" title="interface in org.apache.hadoop.hbase.security.provider">SaslClientAuthenticationProvider</a>&gt;&nbsp;providers)</code>
<div class="block">Instantiates the ProviderSelector implementation from the provided configuration.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/security/provider/SaslClientAuthenticationProviders.html#reset--">reset</a></span>()</code>
<div class="block">Removes the cached singleton instance of <a href="../../../../../../org/apache/hadoop/hbase/security/provider/SaslClientAuthenticationProviders.html" title="class in org.apache.hadoop.hbase.security.provider"><code>SaslClientAuthenticationProviders</code></a>.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/hadoop/hbase/util/Pair.html" title="class in org.apache.hadoop.hbase.util">Pair</a>&lt;<a href="../../../../../../org/apache/hadoop/hbase/security/provider/SaslClientAuthenticationProvider.html" title="interface in org.apache.hadoop.hbase.security.provider">SaslClientAuthenticationProvider</a>,org.apache.hadoop.security.token.Token&lt;? extends org.apache.hadoop.security.token.TokenIdentifier&gt;&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/security/provider/SaslClientAuthenticationProviders.html#selectProvider-java.lang.String-org.apache.hadoop.hbase.security.User-">selectProvider</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;clusterId,
<a href="../../../../../../org/apache/hadoop/hbase/security/User.html" title="class in org.apache.hadoop.hbase.security">User</a>&nbsp;clientUser)</code>
<div class="block">Chooses the best authentication provider and corresponding token given the HBase cluster
identifier and the user.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/security/provider/SaslClientAuthenticationProviders.html#toString--">toString</a></span>()</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="LOG">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>LOG</h4>
<pre>private static final&nbsp;org.slf4j.Logger <a href="../../../../../../src-html/org/apache/hadoop/hbase/security/provider/SaslClientAuthenticationProviders.html#line.46">LOG</a></pre>
</li>
</ul>
<a name="SELECTOR_KEY">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SELECTOR_KEY</h4>
<pre>public static final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../../src-html/org/apache/hadoop/hbase/security/provider/SaslClientAuthenticationProviders.html#line.49">SELECTOR_KEY</a></pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../constant-values.html#org.apache.hadoop.hbase.security.provider.SaslClientAuthenticationProviders.SELECTOR_KEY">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="EXTRA_PROVIDERS_KEY">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>EXTRA_PROVIDERS_KEY</h4>
<pre>public static final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../../src-html/org/apache/hadoop/hbase/security/provider/SaslClientAuthenticationProviders.html#line.50">EXTRA_PROVIDERS_KEY</a></pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../constant-values.html#org.apache.hadoop.hbase.security.provider.SaslClientAuthenticationProviders.EXTRA_PROVIDERS_KEY">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="providersRef">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>providersRef</h4>
<pre>private static final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/atomic/AtomicReference.html?is-external=true" title="class or interface in java.util.concurrent.atomic">AtomicReference</a>&lt;<a href="../../../../../../org/apache/hadoop/hbase/security/provider/SaslClientAuthenticationProviders.html" title="class in org.apache.hadoop.hbase.security.provider">SaslClientAuthenticationProviders</a>&gt; <a href="../../../../../../src-html/org/apache/hadoop/hbase/security/provider/SaslClientAuthenticationProviders.html#line.52">providersRef</a></pre>
</li>
</ul>
<a name="providers">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>providers</h4>
<pre>private final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&lt;<a href="../../../../../../org/apache/hadoop/hbase/security/provider/SaslClientAuthenticationProvider.html" title="interface in org.apache.hadoop.hbase.security.provider">SaslClientAuthenticationProvider</a>&gt; <a href="../../../../../../src-html/org/apache/hadoop/hbase/security/provider/SaslClientAuthenticationProviders.html#line.55">providers</a></pre>
</li>
</ul>
<a name="selector">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>selector</h4>
<pre>private final&nbsp;<a href="../../../../../../org/apache/hadoop/hbase/security/provider/AuthenticationProviderSelector.html" title="interface in org.apache.hadoop.hbase.security.provider">AuthenticationProviderSelector</a> <a href="../../../../../../src-html/org/apache/hadoop/hbase/security/provider/SaslClientAuthenticationProviders.html#line.56">selector</a></pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="SaslClientAuthenticationProviders-java.util.Collection-org.apache.hadoop.hbase.security.provider.AuthenticationProviderSelector-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>SaslClientAuthenticationProviders</h4>
<pre>private&nbsp;<a href="../../../../../../src-html/org/apache/hadoop/hbase/security/provider/SaslClientAuthenticationProviders.html#line.58">SaslClientAuthenticationProviders</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&lt;<a href="../../../../../../org/apache/hadoop/hbase/security/provider/SaslClientAuthenticationProvider.html" title="interface in org.apache.hadoop.hbase.security.provider">SaslClientAuthenticationProvider</a>&gt;&nbsp;providers,
<a href="../../../../../../org/apache/hadoop/hbase/security/provider/AuthenticationProviderSelector.html" title="interface in org.apache.hadoop.hbase.security.provider">AuthenticationProviderSelector</a>&nbsp;selector)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getNumRegisteredProviders--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNumRegisteredProviders</h4>
<pre>public&nbsp;int&nbsp;<a href="../../../../../../src-html/org/apache/hadoop/hbase/security/provider/SaslClientAuthenticationProviders.html#line.68">getNumRegisteredProviders</a>()</pre>
<div class="block">Returns the number of providers that have been registered.</div>
</li>
</ul>
<a name="getInstance-org.apache.hadoop.conf.Configuration-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInstance</h4>
<pre>public static&nbsp;<a href="../../../../../../org/apache/hadoop/hbase/security/provider/SaslClientAuthenticationProviders.html" title="class in org.apache.hadoop.hbase.security.provider">SaslClientAuthenticationProviders</a>&nbsp;<a href="../../../../../../src-html/org/apache/hadoop/hbase/security/provider/SaslClientAuthenticationProviders.html#line.75">getInstance</a>(org.apache.hadoop.conf.Configuration&nbsp;conf)</pre>
<div class="block">Returns a singleton instance of <a href="../../../../../../org/apache/hadoop/hbase/security/provider/SaslClientAuthenticationProviders.html" title="class in org.apache.hadoop.hbase.security.provider"><code>SaslClientAuthenticationProviders</code></a>.</div>
</li>
</ul>
<a name="reset--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>reset</h4>
<pre>public static&nbsp;void&nbsp;<a href="../../../../../../src-html/org/apache/hadoop/hbase/security/provider/SaslClientAuthenticationProviders.html#line.88">reset</a>()</pre>
<div class="block">Removes the cached singleton instance of <a href="../../../../../../org/apache/hadoop/hbase/security/provider/SaslClientAuthenticationProviders.html" title="class in org.apache.hadoop.hbase.security.provider"><code>SaslClientAuthenticationProviders</code></a>.</div>
</li>
</ul>
<a name="addProviderIfNotExists-org.apache.hadoop.hbase.security.provider.SaslClientAuthenticationProvider-java.util.HashMap-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addProviderIfNotExists</h4>
<pre>static&nbsp;void&nbsp;<a href="../../../../../../src-html/org/apache/hadoop/hbase/security/provider/SaslClientAuthenticationProviders.html#line.96">addProviderIfNotExists</a>(<a href="../../../../../../org/apache/hadoop/hbase/security/provider/SaslClientAuthenticationProvider.html" title="interface in org.apache.hadoop.hbase.security.provider">SaslClientAuthenticationProvider</a>&nbsp;provider,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/HashMap.html?is-external=true" title="class or interface in java.util">HashMap</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Byte.html?is-external=true" title="class or interface in java.lang">Byte</a>,<a href="../../../../../../org/apache/hadoop/hbase/security/provider/SaslClientAuthenticationProvider.html" title="interface in org.apache.hadoop.hbase.security.provider">SaslClientAuthenticationProvider</a>&gt;&nbsp;providers)</pre>
<div class="block">Adds the given <code>provider</code> to the set, only if an equivalent provider does not
already exist in the set.</div>
</li>
</ul>
<a name="instantiateSelector-org.apache.hadoop.conf.Configuration-java.util.Collection-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>instantiateSelector</h4>
<pre>static&nbsp;<a href="../../../../../../org/apache/hadoop/hbase/security/provider/AuthenticationProviderSelector.html" title="interface in org.apache.hadoop.hbase.security.provider">AuthenticationProviderSelector</a>&nbsp;<a href="../../../../../../src-html/org/apache/hadoop/hbase/security/provider/SaslClientAuthenticationProviders.html#line.110">instantiateSelector</a>(org.apache.hadoop.conf.Configuration&nbsp;conf,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&lt;<a href="../../../../../../org/apache/hadoop/hbase/security/provider/SaslClientAuthenticationProvider.html" title="interface in org.apache.hadoop.hbase.security.provider">SaslClientAuthenticationProvider</a>&gt;&nbsp;providers)</pre>
<div class="block">Instantiates the ProviderSelector implementation from the provided configuration.</div>
</li>
</ul>
<a name="addExplicitProviders-org.apache.hadoop.conf.Configuration-java.util.HashMap-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addExplicitProviders</h4>
<pre>static&nbsp;void&nbsp;<a href="../../../../../../src-html/org/apache/hadoop/hbase/security/provider/SaslClientAuthenticationProviders.html#line.131">addExplicitProviders</a>(org.apache.hadoop.conf.Configuration&nbsp;conf,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/HashMap.html?is-external=true" title="class or interface in java.util">HashMap</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Byte.html?is-external=true" title="class or interface in java.lang">Byte</a>,<a href="../../../../../../org/apache/hadoop/hbase/security/provider/SaslClientAuthenticationProvider.html" title="interface in org.apache.hadoop.hbase.security.provider">SaslClientAuthenticationProvider</a>&gt;&nbsp;providers)</pre>
<div class="block">Extracts and instantiates authentication providers from the configuration.</div>
</li>
</ul>
<a name="instantiate-org.apache.hadoop.conf.Configuration-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>instantiate</h4>
<pre>static&nbsp;<a href="../../../../../../org/apache/hadoop/hbase/security/provider/SaslClientAuthenticationProviders.html" title="class in org.apache.hadoop.hbase.security.provider">SaslClientAuthenticationProviders</a>&nbsp;<a href="../../../../../../src-html/org/apache/hadoop/hbase/security/provider/SaslClientAuthenticationProviders.html#line.170">instantiate</a>(org.apache.hadoop.conf.Configuration&nbsp;conf)</pre>
<div class="block">Instantiates all client authentication providers and returns an instance of
<a href="../../../../../../org/apache/hadoop/hbase/security/provider/SaslClientAuthenticationProviders.html" title="class in org.apache.hadoop.hbase.security.provider"><code>SaslClientAuthenticationProviders</code></a>.</div>
</li>
</ul>
<a name="getSimpleProvider--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSimpleProvider</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/hadoop/hbase/util/Pair.html" title="class in org.apache.hadoop.hbase.util">Pair</a>&lt;<a href="../../../../../../org/apache/hadoop/hbase/security/provider/SaslClientAuthenticationProvider.html" title="interface in org.apache.hadoop.hbase.security.provider">SaslClientAuthenticationProvider</a>,org.apache.hadoop.security.token.Token&lt;? extends org.apache.hadoop.security.token.TokenIdentifier&gt;&gt;&nbsp;<a href="../../../../../../src-html/org/apache/hadoop/hbase/security/provider/SaslClientAuthenticationProviders.html#line.201">getSimpleProvider</a>()</pre>
<div class="block">Returns the provider and token pair for SIMPLE authentication.
This method is a "hack" while SIMPLE authentication for HBase does not flow through
the SASL codepath.</div>
</li>
</ul>
<a name="selectProvider-java.lang.String-org.apache.hadoop.hbase.security.User-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>selectProvider</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/hadoop/hbase/util/Pair.html" title="class in org.apache.hadoop.hbase.util">Pair</a>&lt;<a href="../../../../../../org/apache/hadoop/hbase/security/provider/SaslClientAuthenticationProvider.html" title="interface in org.apache.hadoop.hbase.security.provider">SaslClientAuthenticationProvider</a>,org.apache.hadoop.security.token.Token&lt;? extends org.apache.hadoop.security.token.TokenIdentifier&gt;&gt;&nbsp;<a href="../../../../../../src-html/org/apache/hadoop/hbase/security/provider/SaslClientAuthenticationProviders.html#line.212">selectProvider</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;clusterId,
<a href="../../../../../../org/apache/hadoop/hbase/security/User.html" title="class in org.apache.hadoop.hbase.security">User</a>&nbsp;clientUser)</pre>
<div class="block">Chooses the best authentication provider and corresponding token given the HBase cluster
identifier and the user.</div>
</li>
</ul>
<a name="toString--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;<a href="../../../../../../src-html/org/apache/hadoop/hbase/security/provider/SaslClientAuthenticationProviders.html#line.218">toString</a>()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/SaslClientAuthenticationProviders.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="../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../org/apache/hadoop/hbase/security/provider/SaslClientAuthenticationProvider.html" title="interface in org.apache.hadoop.hbase.security.provider"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/hadoop/hbase/security/provider/SaslServerAuthenticationProvider.html" title="interface in org.apache.hadoop.hbase.security.provider"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/hadoop/hbase/security/provider/SaslClientAuthenticationProviders.html" target="_top">Frames</a></li>
<li><a href="SaslClientAuthenticationProviders.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../allclasses-noframe.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>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&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><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2007&#x2013;2021 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>