| <!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>SaslAuthenticationProvider (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="SaslAuthenticationProvider (Apache HBase 3.0.0-alpha-2-SNAPSHOT API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/SaslAuthenticationProvider.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/GssSaslServerAuthenticationProvider.SaslGssCallbackHandler.html" title="class in org.apache.hadoop.hbase.security.provider"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/hadoop/hbase/security/provider/SaslAuthMethod.html" title="class in org.apache.hadoop.hbase.security.provider"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/hadoop/hbase/security/provider/SaslAuthenticationProvider.html" target="_top">Frames</a></li> |
| <li><a href="SaslAuthenticationProvider.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../../allclasses-noframe.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> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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="Interface SaslAuthenticationProvider" class="title">Interface SaslAuthenticationProvider</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Known Subinterfaces:</dt> |
| <dd><a href="../../../../../../org/apache/hadoop/hbase/security/provider/SaslClientAuthenticationProvider.html" title="interface in org.apache.hadoop.hbase.security.provider">SaslClientAuthenticationProvider</a>, <a href="../../../../../../org/apache/hadoop/hbase/security/provider/SaslServerAuthenticationProvider.html" title="interface in org.apache.hadoop.hbase.security.provider">SaslServerAuthenticationProvider</a></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../../../org/apache/hadoop/hbase/security/provider/AbstractSaslClientAuthenticationProvider.html" title="class in org.apache.hadoop.hbase.security.provider">AbstractSaslClientAuthenticationProvider</a>, <a href="../../../../../../org/apache/hadoop/hbase/security/provider/BuiltInSaslAuthenticationProvider.html" title="class in org.apache.hadoop.hbase.security.provider">BuiltInSaslAuthenticationProvider</a>, <a href="../../../../../../org/apache/hadoop/hbase/security/provider/DigestSaslAuthenticationProvider.html" title="class in org.apache.hadoop.hbase.security.provider">DigestSaslAuthenticationProvider</a>, <a href="../../../../../../org/apache/hadoop/hbase/security/provider/DigestSaslClientAuthenticationProvider.html" title="class in org.apache.hadoop.hbase.security.provider">DigestSaslClientAuthenticationProvider</a>, <a href="../../../../../../org/apache/hadoop/hbase/security/provider/DigestSaslServerAuthenticationProvider.html" title="class in org.apache.hadoop.hbase.security.provider">DigestSaslServerAuthenticationProvider</a>, <a href="../../../../../../org/apache/hadoop/hbase/security/provider/GssSaslAuthenticationProvider.html" title="class in org.apache.hadoop.hbase.security.provider">GssSaslAuthenticationProvider</a>, <a href="../../../../../../org/apache/hadoop/hbase/security/provider/GssSaslClientAuthenticationProvider.html" title="class in org.apache.hadoop.hbase.security.provider">GssSaslClientAuthenticationProvider</a>, <a href="../../../../../../org/apache/hadoop/hbase/security/provider/GssSaslServerAuthenticationProvider.html" title="class in org.apache.hadoop.hbase.security.provider">GssSaslServerAuthenticationProvider</a>, <a href="../../../../../../org/apache/hadoop/hbase/security/provider/example/ShadeSaslAuthenticationProvider.html" title="class in org.apache.hadoop.hbase.security.provider.example">ShadeSaslAuthenticationProvider</a>, <a href="../../../../../../org/apache/hadoop/hbase/security/provider/example/ShadeSaslClientAuthenticationProvider.html" title="class in org.apache.hadoop.hbase.security.provider.example">ShadeSaslClientAuthenticationProvider</a>, <a href="../../../../../../org/apache/hadoop/hbase/security/provider/example/ShadeSaslServerAuthenticationProvider.html" title="class in org.apache.hadoop.hbase.security.provider.example">ShadeSaslServerAuthenticationProvider</a>, <a href="../../../../../../org/apache/hadoop/hbase/security/provider/SimpleSaslAuthenticationProvider.html" title="class in org.apache.hadoop.hbase.security.provider">SimpleSaslAuthenticationProvider</a>, <a href="../../../../../../org/apache/hadoop/hbase/security/provider/SimpleSaslClientAuthenticationProvider.html" title="class in org.apache.hadoop.hbase.security.provider">SimpleSaslClientAuthenticationProvider</a>, <a href="../../../../../../org/apache/hadoop/hbase/security/provider/SimpleSaslServerAuthenticationProvider.html" title="class in org.apache.hadoop.hbase.security.provider">SimpleSaslServerAuthenticationProvider</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>@InterfaceAudience.LimitedPrivate(value="Authentication") |
| @InterfaceStability.Evolving |
| public interface <a href="../../../../../../src-html/org/apache/hadoop/hbase/security/provider/SaslAuthenticationProvider.html#line.35">SaslAuthenticationProvider</a></pre> |
| <div class="block">Encapsulation of client-side logic to authenticate to HBase via some means over SASL. |
| It is suggested that custom implementations extend the abstract class in the type hierarchy |
| instead of directly implementing this interface (clients have a base class available, but |
| servers presently do not). |
| |
| Implementations of this interface <b>must</b> be unique among each other via the <code>byte</code> |
| returned by <a href="../../../../../../org/apache/hadoop/hbase/security/provider/SaslAuthMethod.html#getCode--"><code>SaslAuthMethod.getCode()</code></a> on <a href="../../../../../../org/apache/hadoop/hbase/security/provider/SaslAuthenticationProvider.html#getSaslAuthMethod--"><code>getSaslAuthMethod()</code></a>.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== 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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </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><a href="../../../../../../org/apache/hadoop/hbase/security/provider/SaslAuthMethod.html" title="class in org.apache.hadoop.hbase.security.provider">SaslAuthMethod</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/security/provider/SaslAuthenticationProvider.html#getSaslAuthMethod--">getSaslAuthMethod</a></span>()</code> |
| <div class="block">Returns the attributes which identify how this provider authenticates.</div> |
| </td> |
| </tr> |
| <tr id="i1" 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/SaslAuthenticationProvider.html#getTokenKind--">getTokenKind</a></span>()</code> |
| <div class="block">Returns the name of the type used by the TokenIdentifier.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getSaslAuthMethod--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSaslAuthMethod</h4> |
| <pre><a href="../../../../../../org/apache/hadoop/hbase/security/provider/SaslAuthMethod.html" title="class in org.apache.hadoop.hbase.security.provider">SaslAuthMethod</a> <a href="../../../../../../src-html/org/apache/hadoop/hbase/security/provider/SaslAuthenticationProvider.html#line.40">getSaslAuthMethod</a>()</pre> |
| <div class="block">Returns the attributes which identify how this provider authenticates.</div> |
| </li> |
| </ul> |
| <a name="getTokenKind--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getTokenKind</h4> |
| <pre><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/SaslAuthenticationProvider.html#line.45">getTokenKind</a>()</pre> |
| <div class="block">Returns the name of the type used by the TokenIdentifier.</div> |
| </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/SaslAuthenticationProvider.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/GssSaslServerAuthenticationProvider.SaslGssCallbackHandler.html" title="class in org.apache.hadoop.hbase.security.provider"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/hadoop/hbase/security/provider/SaslAuthMethod.html" title="class in org.apache.hadoop.hbase.security.provider"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/hadoop/hbase/security/provider/SaslAuthenticationProvider.html" target="_top">Frames</a></li> |
| <li><a href="SaslAuthenticationProvider.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../../allclasses-noframe.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> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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 © 2007–2021 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
