blob: f69d129d0fa7decc5cfd6bf015931895978c4631 [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>GssSaslClientAuthenticationProvider (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="GssSaslClientAuthenticationProvider (Apache HBase 3.0.0-alpha-2-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":9,"i3":10,"i4":10,"i5":10,"i6":10,"i7":9};
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/GssSaslClientAuthenticationProvider.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/GssSaslAuthenticationProvider.html" title="class 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/GssSaslServerAuthenticationProvider.html" title="class 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/GssSaslClientAuthenticationProvider.html" target="_top">Frames</a></li>
<li><a href="GssSaslClientAuthenticationProvider.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 GssSaslClientAuthenticationProvider" class="title">Class GssSaslClientAuthenticationProvider</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><a href="../../../../../../org/apache/hadoop/hbase/security/provider/BuiltInSaslAuthenticationProvider.html" title="class in org.apache.hadoop.hbase.security.provider">org.apache.hadoop.hbase.security.provider.BuiltInSaslAuthenticationProvider</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../../../org/apache/hadoop/hbase/security/provider/GssSaslAuthenticationProvider.html" title="class in org.apache.hadoop.hbase.security.provider">org.apache.hadoop.hbase.security.provider.GssSaslAuthenticationProvider</a></li>
<li>
<ul class="inheritance">
<li>org.apache.hadoop.hbase.security.provider.GssSaslClientAuthenticationProvider</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../../../org/apache/hadoop/hbase/security/provider/SaslAuthenticationProvider.html" title="interface in org.apache.hadoop.hbase.security.provider">SaslAuthenticationProvider</a>, <a href="../../../../../../org/apache/hadoop/hbase/security/provider/SaslClientAuthenticationProvider.html" title="interface in org.apache.hadoop.hbase.security.provider">SaslClientAuthenticationProvider</a></dd>
</dl>
<hr>
<br>
<pre>@InterfaceAudience.Private
public class <a href="../../../../../../src-html/org/apache/hadoop/hbase/security/provider/GssSaslClientAuthenticationProvider.html#line.43">GssSaslClientAuthenticationProvider</a>
extends <a href="../../../../../../org/apache/hadoop/hbase/security/provider/GssSaslAuthenticationProvider.html" title="class in org.apache.hadoop.hbase.security.provider">GssSaslAuthenticationProvider</a>
implements <a href="../../../../../../org/apache/hadoop/hbase/security/provider/SaslClientAuthenticationProvider.html" title="interface in org.apache.hadoop.hbase.security.provider">SaslClientAuthenticationProvider</a></pre>
</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>private static org.slf4j.Logger</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/security/provider/GssSaslClientAuthenticationProvider.html#LOG">LOG</a></span></code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.apache.hadoop.hbase.security.provider.GssSaslAuthenticationProvider">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.apache.hadoop.hbase.security.provider.<a href="../../../../../../org/apache/hadoop/hbase/security/provider/GssSaslAuthenticationProvider.html" title="class in org.apache.hadoop.hbase.security.provider">GssSaslAuthenticationProvider</a></h3>
<code><a href="../../../../../../org/apache/hadoop/hbase/security/provider/GssSaslAuthenticationProvider.html#SASL_AUTH_METHOD">SASL_AUTH_METHOD</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.apache.hadoop.hbase.security.provider.BuiltInSaslAuthenticationProvider">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.apache.hadoop.hbase.security.provider.<a href="../../../../../../org/apache/hadoop/hbase/security/provider/BuiltInSaslAuthenticationProvider.html" title="class in org.apache.hadoop.hbase.security.provider">BuiltInSaslAuthenticationProvider</a></h3>
<code><a href="../../../../../../org/apache/hadoop/hbase/security/provider/BuiltInSaslAuthenticationProvider.html#AUTH_TOKEN_TYPE">AUTH_TOKEN_TYPE</a></code></li>
</ul>
</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="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/security/provider/GssSaslClientAuthenticationProvider.html#GssSaslClientAuthenticationProvider--">GssSaslClientAuthenticationProvider</a></span>()</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>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/security/provider/GssSaslClientAuthenticationProvider.html#canRetry--">canRetry</a></span>()</code>
<div class="block">Returns true if the implementation is capable of performing some action which may allow a
failed authentication to become a successful authentication.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/javax/security/sasl/SaslClient.html?is-external=true" title="class or interface in javax.security.sasl">SaslClient</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/security/provider/GssSaslClientAuthenticationProvider.html#createClient-org.apache.hadoop.conf.Configuration-java.net.InetAddress-org.apache.hadoop.hbase.security.SecurityInfo-org.apache.hadoop.security.token.Token-boolean-java.util.Map-">createClient</a></span>(org.apache.hadoop.conf.Configuration&nbsp;conf,
<a href="https://docs.oracle.com/javase/8/docs/api/java/net/InetAddress.html?is-external=true" title="class or interface in java.net">InetAddress</a>&nbsp;serverAddr,
<a href="../../../../../../org/apache/hadoop/hbase/security/SecurityInfo.html" title="class in org.apache.hadoop.hbase.security">SecurityInfo</a>&nbsp;securityInfo,
org.apache.hadoop.security.token.Token&lt;? extends org.apache.hadoop.security.token.TokenIdentifier&gt;&nbsp;token,
boolean&nbsp;fallbackAllowed,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<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="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;saslProps)</code>
<div class="block">Creates the SASL client instance for this auth'n method.</div>
</td>
</tr>
<tr id="i2" 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/GssSaslClientAuthenticationProvider.html#getHostnameForServerPrincipal-org.apache.hadoop.conf.Configuration-java.net.InetAddress-">getHostnameForServerPrincipal</a></span>(org.apache.hadoop.conf.Configuration&nbsp;conf,
<a href="https://docs.oracle.com/javase/8/docs/api/java/net/InetAddress.html?is-external=true" title="class or interface in java.net">InetAddress</a>&nbsp;addr)</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>org.apache.hadoop.security.UserGroupInformation</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/security/provider/GssSaslClientAuthenticationProvider.html#getRealUser-org.apache.hadoop.hbase.security.User-">getRealUser</a></span>(<a href="../../../../../../org/apache/hadoop/hbase/security/User.html" title="class in org.apache.hadoop.hbase.security">User</a>&nbsp;user)</code>
<div class="block">Returns the "real" user, the user who has the credentials being authenticated by the
remote service, in the form of an <code>UserGroupInformation</code> object.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>(package private) <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/GssSaslClientAuthenticationProvider.html#getServerPrincipal-org.apache.hadoop.conf.Configuration-org.apache.hadoop.hbase.security.SecurityInfo-java.net.InetAddress-">getServerPrincipal</a></span>(org.apache.hadoop.conf.Configuration&nbsp;conf,
<a href="../../../../../../org/apache/hadoop/hbase/security/SecurityInfo.html" title="class in org.apache.hadoop.hbase.security">SecurityInfo</a>&nbsp;securityInfo,
<a href="https://docs.oracle.com/javase/8/docs/api/java/net/InetAddress.html?is-external=true" title="class or interface in java.net">InetAddress</a>&nbsp;server)</code>&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>org.apache.hadoop.hbase.shaded.protobuf.generated.RPCProtos.UserInformation</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/security/provider/GssSaslClientAuthenticationProvider.html#getUserInfo-org.apache.hadoop.hbase.security.User-">getUserInfo</a></span>(<a href="../../../../../../org/apache/hadoop/hbase/security/User.html" title="class in org.apache.hadoop.hbase.security">User</a>&nbsp;user)</code>
<div class="block">Constructs a <code>RPCProtos.UserInformation</code> from the given <code>UserGroupInformation</code></div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/security/provider/GssSaslClientAuthenticationProvider.html#relogin--">relogin</a></span>()</code>
<div class="block">Executes any necessary logic to re-login the client.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>private static boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/security/provider/GssSaslClientAuthenticationProvider.html#useCanonicalHostname-org.apache.hadoop.conf.Configuration-">useCanonicalHostname</a></span>(org.apache.hadoop.conf.Configuration&nbsp;conf)</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.hadoop.hbase.security.provider.GssSaslAuthenticationProvider">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.hadoop.hbase.security.provider.<a href="../../../../../../org/apache/hadoop/hbase/security/provider/GssSaslAuthenticationProvider.html" title="class in org.apache.hadoop.hbase.security.provider">GssSaslAuthenticationProvider</a></h3>
<code><a href="../../../../../../org/apache/hadoop/hbase/security/provider/GssSaslAuthenticationProvider.html#getSaslAuthMethod--">getSaslAuthMethod</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.hadoop.hbase.security.provider.BuiltInSaslAuthenticationProvider">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.hadoop.hbase.security.provider.<a href="../../../../../../org/apache/hadoop/hbase/security/provider/BuiltInSaslAuthenticationProvider.html" title="class in org.apache.hadoop.hbase.security.provider">BuiltInSaslAuthenticationProvider</a></h3>
<code><a href="../../../../../../org/apache/hadoop/hbase/security/provider/BuiltInSaslAuthenticationProvider.html#getTokenKind--">getTokenKind</a></code></li>
</ul>
<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#toString--" title="class or interface in java.lang">toString</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>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.hadoop.hbase.security.provider.SaslAuthenticationProvider">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.hadoop.hbase.security.provider.<a href="../../../../../../org/apache/hadoop/hbase/security/provider/SaslAuthenticationProvider.html" title="interface in org.apache.hadoop.hbase.security.provider">SaslAuthenticationProvider</a></h3>
<code><a href="../../../../../../org/apache/hadoop/hbase/security/provider/SaslAuthenticationProvider.html#getSaslAuthMethod--">getSaslAuthMethod</a>, <a href="../../../../../../org/apache/hadoop/hbase/security/provider/SaslAuthenticationProvider.html#getTokenKind--">getTokenKind</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="blockListLast">
<li class="blockList">
<h4>LOG</h4>
<pre>private static final&nbsp;org.slf4j.Logger <a href="../../../../../../src-html/org/apache/hadoop/hbase/security/provider/GssSaslClientAuthenticationProvider.html#line.45">LOG</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="GssSaslClientAuthenticationProvider--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>GssSaslClientAuthenticationProvider</h4>
<pre>public&nbsp;<a href="../../../../../../src-html/org/apache/hadoop/hbase/security/provider/GssSaslClientAuthenticationProvider.html#line.43">GssSaslClientAuthenticationProvider</a>()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="useCanonicalHostname-org.apache.hadoop.conf.Configuration-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>useCanonicalHostname</h4>
<pre>private static&nbsp;boolean&nbsp;<a href="../../../../../../src-html/org/apache/hadoop/hbase/security/provider/GssSaslClientAuthenticationProvider.html#line.48">useCanonicalHostname</a>(org.apache.hadoop.conf.Configuration&nbsp;conf)</pre>
</li>
</ul>
<a name="getHostnameForServerPrincipal-org.apache.hadoop.conf.Configuration-java.net.InetAddress-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHostnameForServerPrincipal</h4>
<pre>public static&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/GssSaslClientAuthenticationProvider.html#line.54">getHostnameForServerPrincipal</a>(org.apache.hadoop.conf.Configuration&nbsp;conf,
<a href="https://docs.oracle.com/javase/8/docs/api/java/net/InetAddress.html?is-external=true" title="class or interface in java.net">InetAddress</a>&nbsp;addr)</pre>
</li>
</ul>
<a name="getServerPrincipal-org.apache.hadoop.conf.Configuration-org.apache.hadoop.hbase.security.SecurityInfo-java.net.InetAddress-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getServerPrincipal</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>&nbsp;<a href="../../../../../../src-html/org/apache/hadoop/hbase/security/provider/GssSaslClientAuthenticationProvider.html#line.72">getServerPrincipal</a>(org.apache.hadoop.conf.Configuration&nbsp;conf,
<a href="../../../../../../org/apache/hadoop/hbase/security/SecurityInfo.html" title="class in org.apache.hadoop.hbase.security">SecurityInfo</a>&nbsp;securityInfo,
<a href="https://docs.oracle.com/javase/8/docs/api/java/net/InetAddress.html?is-external=true" title="class or interface in java.net">InetAddress</a>&nbsp;server)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
</dl>
</li>
</ul>
<a name="createClient-org.apache.hadoop.conf.Configuration-java.net.InetAddress-org.apache.hadoop.hbase.security.SecurityInfo-org.apache.hadoop.security.token.Token-boolean-java.util.Map-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createClient</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/javax/security/sasl/SaslClient.html?is-external=true" title="class or interface in javax.security.sasl">SaslClient</a>&nbsp;<a href="../../../../../../src-html/org/apache/hadoop/hbase/security/provider/GssSaslClientAuthenticationProvider.html#line.85">createClient</a>(org.apache.hadoop.conf.Configuration&nbsp;conf,
<a href="https://docs.oracle.com/javase/8/docs/api/java/net/InetAddress.html?is-external=true" title="class or interface in java.net">InetAddress</a>&nbsp;serverAddr,
<a href="../../../../../../org/apache/hadoop/hbase/security/SecurityInfo.html" title="class in org.apache.hadoop.hbase.security">SecurityInfo</a>&nbsp;securityInfo,
org.apache.hadoop.security.token.Token&lt;? extends org.apache.hadoop.security.token.TokenIdentifier&gt;&nbsp;token,
boolean&nbsp;fallbackAllowed,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<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="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;saslProps)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../org/apache/hadoop/hbase/security/provider/SaslClientAuthenticationProvider.html#createClient-org.apache.hadoop.conf.Configuration-java.net.InetAddress-org.apache.hadoop.hbase.security.SecurityInfo-org.apache.hadoop.security.token.Token-boolean-java.util.Map-">SaslClientAuthenticationProvider</a></code></span></div>
<div class="block">Creates the SASL client instance for this auth'n method.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/apache/hadoop/hbase/security/provider/SaslClientAuthenticationProvider.html#createClient-org.apache.hadoop.conf.Configuration-java.net.InetAddress-org.apache.hadoop.hbase.security.SecurityInfo-org.apache.hadoop.security.token.Token-boolean-java.util.Map-">createClient</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/apache/hadoop/hbase/security/provider/SaslClientAuthenticationProvider.html" title="interface in org.apache.hadoop.hbase.security.provider">SaslClientAuthenticationProvider</a></code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
</dl>
</li>
</ul>
<a name="getUserInfo-org.apache.hadoop.hbase.security.User-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUserInfo</h4>
<pre>public&nbsp;org.apache.hadoop.hbase.shaded.protobuf.generated.RPCProtos.UserInformation&nbsp;<a href="../../../../../../src-html/org/apache/hadoop/hbase/security/provider/GssSaslClientAuthenticationProvider.html#line.100">getUserInfo</a>(<a href="../../../../../../org/apache/hadoop/hbase/security/User.html" title="class in org.apache.hadoop.hbase.security">User</a>&nbsp;user)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../org/apache/hadoop/hbase/security/provider/SaslClientAuthenticationProvider.html#getUserInfo-org.apache.hadoop.hbase.security.User-">SaslClientAuthenticationProvider</a></code></span></div>
<div class="block">Constructs a <code>RPCProtos.UserInformation</code> from the given <code>UserGroupInformation</code></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/apache/hadoop/hbase/security/provider/SaslClientAuthenticationProvider.html#getUserInfo-org.apache.hadoop.hbase.security.User-">getUserInfo</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/apache/hadoop/hbase/security/provider/SaslClientAuthenticationProvider.html" title="interface in org.apache.hadoop.hbase.security.provider">SaslClientAuthenticationProvider</a></code></dd>
</dl>
</li>
</ul>
<a name="canRetry--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>canRetry</h4>
<pre>public&nbsp;boolean&nbsp;<a href="../../../../../../src-html/org/apache/hadoop/hbase/security/provider/GssSaslClientAuthenticationProvider.html#line.108">canRetry</a>()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../org/apache/hadoop/hbase/security/provider/SaslClientAuthenticationProvider.html#canRetry--">SaslClientAuthenticationProvider</a></code></span></div>
<div class="block">Returns true if the implementation is capable of performing some action which may allow a
failed authentication to become a successful authentication. Otherwise, returns false</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/apache/hadoop/hbase/security/provider/SaslClientAuthenticationProvider.html#canRetry--">canRetry</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/apache/hadoop/hbase/security/provider/SaslClientAuthenticationProvider.html" title="interface in org.apache.hadoop.hbase.security.provider">SaslClientAuthenticationProvider</a></code></dd>
</dl>
</li>
</ul>
<a name="relogin--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>relogin</h4>
<pre>public&nbsp;void&nbsp;<a href="../../../../../../src-html/org/apache/hadoop/hbase/security/provider/GssSaslClientAuthenticationProvider.html#line.113">relogin</a>()
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../org/apache/hadoop/hbase/security/provider/SaslClientAuthenticationProvider.html#relogin--">SaslClientAuthenticationProvider</a></code></span></div>
<div class="block">Executes any necessary logic to re-login the client. Not all implementations will have
any logic that needs to be executed.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/apache/hadoop/hbase/security/provider/SaslClientAuthenticationProvider.html#relogin--">relogin</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/apache/hadoop/hbase/security/provider/SaslClientAuthenticationProvider.html" title="interface in org.apache.hadoop.hbase.security.provider">SaslClientAuthenticationProvider</a></code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
</dl>
</li>
</ul>
<a name="getRealUser-org.apache.hadoop.hbase.security.User-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getRealUser</h4>
<pre>public&nbsp;org.apache.hadoop.security.UserGroupInformation&nbsp;<a href="../../../../../../src-html/org/apache/hadoop/hbase/security/provider/GssSaslClientAuthenticationProvider.html#line.123">getRealUser</a>(<a href="../../../../../../org/apache/hadoop/hbase/security/User.html" title="class in org.apache.hadoop.hbase.security">User</a>&nbsp;user)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../org/apache/hadoop/hbase/security/provider/SaslClientAuthenticationProvider.html#getRealUser-org.apache.hadoop.hbase.security.User-">SaslClientAuthenticationProvider</a></code></span></div>
<div class="block">Returns the "real" user, the user who has the credentials being authenticated by the
remote service, in the form of an <code>UserGroupInformation</code> object.
It is common in the Hadoop "world" to have distinct notions of a "real" user and a "proxy"
user. A "real" user is the user which actually has the credentials (often, a Kerberos ticket),
but some code may be running as some other user who has no credentials. This method gives
the authentication provider a chance to acknowledge this is happening and ensure that any
RPCs are executed with the real user's credentials, because executing them as the proxy user
would result in failure because no credentials exist to authenticate the RPC.
Not all implementations will need to implement this method. By default, the provided User's
UGI is returned directly.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/apache/hadoop/hbase/security/provider/SaslClientAuthenticationProvider.html#getRealUser-org.apache.hadoop.hbase.security.User-">getRealUser</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/apache/hadoop/hbase/security/provider/SaslClientAuthenticationProvider.html" title="interface in org.apache.hadoop.hbase.security.provider">SaslClientAuthenticationProvider</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/GssSaslClientAuthenticationProvider.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/GssSaslAuthenticationProvider.html" title="class 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/GssSaslServerAuthenticationProvider.html" title="class 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/GssSaslClientAuthenticationProvider.html" target="_top">Frames</a></li>
<li><a href="GssSaslClientAuthenticationProvider.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>