http://git-wip-us.apache.org/repos/asf/hbase-site/blob/5fd895c6/apidocs/index-all.html ---------------------------------------------------------------------- diff --git a/apidocs/index-all.html b/apidocs/index-all.html index 2d01af1..127fbc5 100644 --- a/apidocs/index-all.html +++ b/apidocs/index-all.html @@ -647,7 +647,9 @@ <dd> </dd> <dt><a href="org/apache/hadoop/hbase/AuthUtil.html" title="class in org.apache.hadoop.hbase"><span class="typeNameLink">AuthUtil</span></a> - Class in <a href="org/apache/hadoop/hbase/package-summary.html">org.apache.hadoop.hbase</a></dt> <dd> -<div class="block">Utility methods for helping with security tasks.</div> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> +<div class="block"><span class="deprecationComment">since 2.2.0, to be removed in hbase-3.0.0.</span></div> +</div> </dd> <dt><span class="memberNameLink"><a href="org/apache/hadoop/hbase/client/locking/EntityLock.html#await-long-java.util.concurrent.TimeUnit-">await(long, TimeUnit)</a></span> - Method in class org.apache.hadoop.hbase.client.locking.<a href="org/apache/hadoop/hbase/client/locking/EntityLock.html" title="class in org.apache.hadoop.hbase.client.locking">EntityLock</a></dt> <dd> </dd> @@ -5918,10 +5920,17 @@ <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/hadoop/hbase/AuthUtil.html#getAuthChore-org.apache.hadoop.conf.Configuration-">getAuthChore(Configuration)</a></span> - Static method in class org.apache.hadoop.hbase.<a href="org/apache/hadoop/hbase/AuthUtil.html" title="class in org.apache.hadoop.hbase">AuthUtil</a></dt> <dd> -<div class="block">Checks if security is enabled and if so, launches chore for refreshing kerberos ticket.</div> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> +<div class="block"><span class="deprecationComment">Deprecated since 2.2.0, this method will be internal use only after 3.0.0.</span></div> +</div> </dd> <dt><span class="memberNameLink"><a href="org/apache/hadoop/hbase/client/Query.html#getAuthorizations--">getAuthorizations()</a></span> - Method in class org.apache.hadoop.hbase.client.<a href="org/apache/hadoop/hbase/client/Query.html" title="class in org.apache.hadoop.hbase.client">Query</a></dt> <dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/hadoop/hbase/AuthUtil.html#getAuthRenewalChore-org.apache.hadoop.security.UserGroupInformation-">getAuthRenewalChore(UserGroupInformation)</a></span> - Static method in class org.apache.hadoop.hbase.<a href="org/apache/hadoop/hbase/AuthUtil.html" title="class in org.apache.hadoop.hbase">AuthUtil</a></dt> +<dd> +<div class="block"><span class="deprecatedLabel">Deprecated.</span></div> +<div class="block">Checks if security is enabled and if so, launches chore for refreshing kerberos ticket.</div> +</dd> <dt><span class="memberNameLink"><a href="org/apache/hadoop/hbase/client/HTableMultiplexer.HTableMultiplexerStatus.html#getAverageLatencyForEachRegionServer--">getAverageLatencyForEachRegionServer()</a></span> - Method in class org.apache.hadoop.hbase.client.<a href="org/apache/hadoop/hbase/client/HTableMultiplexer.HTableMultiplexerStatus.html" title="class in org.apache.hadoop.hbase.client">HTableMultiplexer.HTableMultiplexerStatus</a></dt> <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/hadoop/hbase/ClusterMetrics.html#getAverageLoad--">getAverageLoad()</a></span> - Method in interface org.apache.hadoop.hbase.<a href="org/apache/hadoop/hbase/ClusterMetrics.html" title="interface in org.apache.hadoop.hbase">ClusterMetrics</a></dt> @@ -6799,6 +6808,7 @@ </dd> <dt><span class="memberNameLink"><a href="org/apache/hadoop/hbase/AuthUtil.html#getGroupName-java.lang.String-">getGroupName(String)</a></span> - Static method in class org.apache.hadoop.hbase.<a href="org/apache/hadoop/hbase/AuthUtil.html" title="class in org.apache.hadoop.hbase">AuthUtil</a></dt> <dd> +<div class="block"><span class="deprecatedLabel">Deprecated.</span></div> <div class="block">Returns the actual name for a group principal (stripped of the group prefix).</div> </dd> @@ -9582,6 +9592,16 @@ <dd> <div class="block">Parameter name for HBase client IPC pool type</div> </dd> +<dt><span class="memberNameLink"><a href="org/apache/hadoop/hbase/AuthUtil.html#HBASE_CLIENT_KERBEROS_PRINCIPAL">HBASE_CLIENT_KERBEROS_PRINCIPAL</a></span> - Static variable in class org.apache.hadoop.hbase.<a href="org/apache/hadoop/hbase/AuthUtil.html" title="class in org.apache.hadoop.hbase">AuthUtil</a></dt> +<dd> +<div class="block"><span class="deprecatedLabel">Deprecated.</span></div> +<div class="block">Client principal</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/hadoop/hbase/AuthUtil.html#HBASE_CLIENT_KEYTAB_FILE">HBASE_CLIENT_KEYTAB_FILE</a></span> - Static variable in class org.apache.hadoop.hbase.<a href="org/apache/hadoop/hbase/AuthUtil.html" title="class in org.apache.hadoop.hbase">AuthUtil</a></dt> +<dd> +<div class="block"><span class="deprecatedLabel">Deprecated.</span></div> +<div class="block">Client keytab file</div> +</dd> <dt><span class="memberNameLink"><a href="org/apache/hadoop/hbase/HConstants.html#HBASE_CLIENT_MAX_PERREGION_TASKS">HBASE_CLIENT_MAX_PERREGION_TASKS</a></span> - Static variable in class org.apache.hadoop.hbase.<a href="org/apache/hadoop/hbase/HConstants.html" title="class in org.apache.hadoop.hbase">HConstants</a></dt> <dd> <div class="block">The maximum number of concurrent connections the client will maintain to a single @@ -10790,6 +10810,7 @@ <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/hadoop/hbase/AuthUtil.html#isGroupPrincipal-java.lang.String-">isGroupPrincipal(String)</a></span> - Static method in class org.apache.hadoop.hbase.<a href="org/apache/hadoop/hbase/AuthUtil.html" title="class in org.apache.hadoop.hbase">AuthUtil</a></dt> <dd> +<div class="block"><span class="deprecatedLabel">Deprecated.</span></div> <div class="block">Returns whether or not the given name should be interpreted as a group principal.</div> </dd> @@ -10840,6 +10861,8 @@ <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/hadoop/hbase/client/locking/EntityLock.html#isLocked--">isLocked()</a></span> - Method in class org.apache.hadoop.hbase.client.locking.<a href="org/apache/hadoop/hbase/client/locking/EntityLock.html" title="class in org.apache.hadoop.hbase.client.locking">EntityLock</a></dt> <dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/hadoop/hbase/security/User.html#isLoginFromKeytab--">isLoginFromKeytab()</a></span> - Method in class org.apache.hadoop.hbase.security.<a href="org/apache/hadoop/hbase/security/User.html" title="class in org.apache.hadoop.hbase.security">User</a></dt> +<dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/hadoop/hbase/client/Admin.html#isMasterInMaintenanceMode--">isMasterInMaintenanceMode()</a></span> - Method in interface org.apache.hadoop.hbase.client.<a href="org/apache/hadoop/hbase/client/Admin.html" title="interface in org.apache.hadoop.hbase.client">Admin</a></dt> <dd> <div class="block">Check whether Master is in maintenance mode.</div> @@ -11805,6 +11828,15 @@ <div class="block">Log in the current process using the given configuration keys for the credential file and login principal.</div> </dd> +<dt><span class="memberNameLink"><a href="org/apache/hadoop/hbase/security/User.html#login-java.lang.String-java.lang.String-">login(String, String)</a></span> - Static method in class org.apache.hadoop.hbase.security.<a href="org/apache/hadoop/hbase/security/User.html" title="class in org.apache.hadoop.hbase.security">User</a></dt> +<dd> +<div class="block">Login with the given keytab and principal.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/hadoop/hbase/AuthUtil.html#loginClient-org.apache.hadoop.conf.Configuration-">loginClient(Configuration)</a></span> - Static method in class org.apache.hadoop.hbase.<a href="org/apache/hadoop/hbase/AuthUtil.html" title="class in org.apache.hadoop.hbase">AuthUtil</a></dt> +<dd> +<div class="block"><span class="deprecatedLabel">Deprecated.</span></div> +<div class="block">For kerberized cluster, return login user (from kinit or from keytab if specified).</div> +</dd> <dt><span class="memberNameLink"><a href="org/apache/hadoop/hbase/util/VersionInfo.html#logVersion--">logVersion()</a></span> - Static method in class org.apache.hadoop.hbase.util.<a href="org/apache/hadoop/hbase/util/VersionInfo.html" title="class in org.apache.hadoop.hbase.util">VersionInfo</a></dt> <dd> </dd> <dt><a href="org/apache/hadoop/hbase/filter/LongComparator.html" title="class in org.apache.hadoop.hbase.filter"><span class="typeNameLink">LongComparator</span></a> - Class in <a href="org/apache/hadoop/hbase/filter/package-summary.html">org.apache.hadoop.hbase.filter</a></dt> @@ -17238,6 +17270,11 @@ Input/OutputFormats, a table indexing MapReduce job, and utility methods.</div> <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/hadoop/hbase/util/SimplePositionedMutableByteRange.html#shallowCopySubRange-int-int-">shallowCopySubRange(int, int)</a></span> - Method in class org.apache.hadoop.hbase.util.<a href="org/apache/hadoop/hbase/util/SimplePositionedMutableByteRange.html" title="class in org.apache.hadoop.hbase.util">SimplePositionedMutableByteRange</a></dt> <dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/hadoop/hbase/security/User.html#shouldLoginFromKeytab-org.apache.hadoop.conf.Configuration-">shouldLoginFromKeytab(Configuration)</a></span> - Static method in class org.apache.hadoop.hbase.security.<a href="org/apache/hadoop/hbase/security/User.html" title="class in org.apache.hadoop.hbase.security">User</a></dt> +<dd> +<div class="block">In secure environment, if a user specified his keytab and principal, + a hbase client will try to login with them.</div> +</dd> <dt><span class="memberNameLink"><a href="org/apache/hadoop/hbase/mapreduce/TableInputFormat.html#SHUFFLE_MAPS">SHUFFLE_MAPS</a></span> - Static variable in class org.apache.hadoop.hbase.mapreduce.<a href="org/apache/hadoop/hbase/mapreduce/TableInputFormat.html" title="class in org.apache.hadoop.hbase.mapreduce">TableInputFormat</a></dt> <dd> <div class="block">Specify if we have to shuffle the map tasks.</div> @@ -18701,6 +18738,7 @@ Input/OutputFormats, a table indexing MapReduce job, and utility methods.</div> </dd> <dt><span class="memberNameLink"><a href="org/apache/hadoop/hbase/AuthUtil.html#toGroupEntry-java.lang.String-">toGroupEntry(String)</a></span> - Static method in class org.apache.hadoop.hbase.<a href="org/apache/hadoop/hbase/AuthUtil.html" title="class in org.apache.hadoop.hbase">AuthUtil</a></dt> <dd> +<div class="block"><span class="deprecatedLabel">Deprecated.</span></div> <div class="block">Returns the group entry with the group prefix for a group principal.</div> </dd> <dt><span class="memberNameLink"><a href="org/apache/hadoop/hbase/HTableDescriptor.html#toHColumnDescriptor-org.apache.hadoop.hbase.client.ColumnFamilyDescriptor-">toHColumnDescriptor(ColumnFamilyDescriptor)</a></span> - Method in class org.apache.hadoop.hbase.<a href="org/apache/hadoop/hbase/HTableDescriptor.html" title="class in org.apache.hadoop.hbase">HTableDescriptor</a></dt>
http://git-wip-us.apache.org/repos/asf/hbase-site/blob/5fd895c6/apidocs/org/apache/hadoop/hbase/AuthUtil.html ---------------------------------------------------------------------- diff --git a/apidocs/org/apache/hadoop/hbase/AuthUtil.html b/apidocs/org/apache/hadoop/hbase/AuthUtil.html index 58f6135..30f1281 100644 --- a/apidocs/org/apache/hadoop/hbase/AuthUtil.html +++ b/apidocs/org/apache/hadoop/hbase/AuthUtil.html @@ -18,8 +18,8 @@ catch(err) { } //--> -var methods = {"i0":9}; -var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"]}; +var methods = {"i0":41}; +var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated Methods"]}; var altColor = "altColor"; var rowColor = "rowColor"; var tableTab = "tableTab"; @@ -75,13 +75,13 @@ var activeTableTab = "activeTableTab"; <ul class="subNavList"> <li>Summary: </li> <li>Nested | </li> -<li>Field | </li> +<li><a href="#field.summary">Field</a> | </li> <li>Constr | </li> <li><a href="#method.summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> -<li>Field | </li> +<li><a href="#field.detail">Field</a> | </li> <li>Constr | </li> <li><a href="#method.detail">Method</a></li> </ul> @@ -108,9 +108,13 @@ var activeTableTab = "activeTableTab"; <ul class="blockList"> <li class="blockList"> <hr> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> +<div class="block"><span class="deprecationComment">since 2.2.0, to be removed in hbase-3.0.0.</span></div> +</div> <br> -<pre>@InterfaceAudience.Public -public class <a href="../../../../src-html/org/apache/hadoop/hbase/AuthUtil.html#line.70">AuthUtil</a> +<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true"; title="class or interface in java.lang">@Deprecated</a> + @InterfaceAudience.Public +public final class <a href="../../../../src-html/org/apache/hadoop/hbase/AuthUtil.html#line.79">AuthUtil</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">Utility methods for helping with security tasks. Downstream users may rely on this class to handle authenticating via keytab where @@ -145,13 +149,47 @@ extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html </pre> See the "Running Canary in a Kerberos-enabled Cluster" section of the HBase Reference Guide for - an example of configuring a user of this Auth Chore to run on a secure cluster.</div> + an example of configuring a user of this Auth Chore to run on a secure cluster. + <pre> + </pre> + This class will be internal use only from 2.2.0 version, and will transparently work + for kerberized applications. For more, please refer + <a href="http://hbase.apache.org/book.html#hbase.secure.configuration";>Client-side Configuration for Secure Operation</a></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"> </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/AuthUtil.html#HBASE_CLIENT_KERBEROS_PRINCIPAL">HBASE_CLIENT_KERBEROS_PRINCIPAL</a></span></code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Client principal</div> +</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/AuthUtil.html#HBASE_CLIENT_KEYTAB_FILE">HBASE_CLIENT_KEYTAB_FILE</a></span></code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Client keytab file</div> +</td> +</tr> +</table> +</li> +</ul> <!-- ========== METHOD SUMMARY =========== --> <ul class="blockList"> <li class="blockList"><a name="method.summary"> @@ -159,7 +197,7 @@ extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html </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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated 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> @@ -167,7 +205,9 @@ extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html <tr id="i0" class="altColor"> <td class="colFirst"><code>static <a href="../../../../org/apache/hadoop/hbase/ScheduledChore.html" title="class in org.apache.hadoop.hbase">ScheduledChore</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/AuthUtil.html#getAuthChore-org.apache.hadoop.conf.Configuration-">getAuthChore</a></span>(org.apache.hadoop.conf.Configuration conf)</code> -<div class="block">Checks if security is enabled and if so, launches chore for refreshing kerberos ticket.</div> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> +<div class="block"><span class="deprecationComment">Deprecated since 2.2.0, this method will be internal use only after 3.0.0.</span></div> +</div> </td> </tr> </table> @@ -186,6 +226,44 @@ extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html <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="HBASE_CLIENT_KEYTAB_FILE"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>HBASE_CLIENT_KEYTAB_FILE</h4> +<pre>public static final <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/AuthUtil.html#line.87">HBASE_CLIENT_KEYTAB_FILE</a></pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Client keytab file</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../constant-values.html#org.apache.hadoop.hbase.AuthUtil.HBASE_CLIENT_KEYTAB_FILE">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="HBASE_CLIENT_KERBEROS_PRINCIPAL"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>HBASE_CLIENT_KERBEROS_PRINCIPAL</h4> +<pre>public static final <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/AuthUtil.html#line.90">HBASE_CLIENT_KERBEROS_PRINCIPAL</a></pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Client principal</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../constant-values.html#org.apache.hadoop.hbase.AuthUtil.HBASE_CLIENT_KERBEROS_PRINCIPAL">Constant Field Values</a></dd> +</dl> +</li> +</ul> +</li> +</ul> <!-- ============ METHOD DETAIL ========== --> <ul class="blockList"> <li class="blockList"><a name="method.detail"> @@ -198,8 +276,10 @@ extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html <ul class="blockListLast"> <li class="blockList"> <h4>getAuthChore</h4> -<pre>public static <a href="../../../../org/apache/hadoop/hbase/ScheduledChore.html" title="class in org.apache.hadoop.hbase">ScheduledChore</a> <a href="../../../../src-html/org/apache/hadoop/hbase/AuthUtil.html#line.85">getAuthChore</a>(org.apache.hadoop.conf.Configuration conf) - 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> +<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true"; title="class or interface in java.lang">@Deprecated</a> +public static <a href="../../../../org/apache/hadoop/hbase/ScheduledChore.html" title="class in org.apache.hadoop.hbase">ScheduledChore</a> <a href="../../../../src-html/org/apache/hadoop/hbase/AuthUtil.html#line.220">getAuthChore</a>(org.apache.hadoop.conf.Configuration conf) + 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="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">Deprecated since 2.2.0, this method will be internal use only after 3.0.0.</span></div> <div class="block">Checks if security is enabled and if so, launches chore for refreshing kerberos ticket.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> @@ -265,13 +345,13 @@ extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html <ul class="subNavList"> <li>Summary: </li> <li>Nested | </li> -<li>Field | </li> +<li><a href="#field.summary">Field</a> | </li> <li>Constr | </li> <li><a href="#method.summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> -<li>Field | </li> +<li><a href="#field.detail">Field</a> | </li> <li>Constr | </li> <li><a href="#method.detail">Method</a></li> </ul> http://git-wip-us.apache.org/repos/asf/hbase-site/blob/5fd895c6/apidocs/org/apache/hadoop/hbase/class-use/ScheduledChore.html ---------------------------------------------------------------------- diff --git a/apidocs/org/apache/hadoop/hbase/class-use/ScheduledChore.html b/apidocs/org/apache/hadoop/hbase/class-use/ScheduledChore.html index 9ded7b3..35c844b 100644 --- a/apidocs/org/apache/hadoop/hbase/class-use/ScheduledChore.html +++ b/apidocs/org/apache/hadoop/hbase/class-use/ScheduledChore.html @@ -105,6 +105,15 @@ <tr class="altColor"> <td class="colFirst"><code>static <a href="../../../../../org/apache/hadoop/hbase/ScheduledChore.html" title="class in org.apache.hadoop.hbase">ScheduledChore</a></code></td> <td class="colLast"><span class="typeNameLabel">AuthUtil.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/AuthUtil.html#getAuthChore-org.apache.hadoop.conf.Configuration-">getAuthChore</a></span>(org.apache.hadoop.conf.Configuration conf)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> +<div class="block"><span class="deprecationComment">Deprecated since 2.2.0, this method will be internal use only after 3.0.0.</span></div> +</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../../org/apache/hadoop/hbase/ScheduledChore.html" title="class in org.apache.hadoop.hbase">ScheduledChore</a></code></td> +<td class="colLast"><span class="typeNameLabel">AuthUtil.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/AuthUtil.html#getAuthRenewalChore-org.apache.hadoop.security.UserGroupInformation-">getAuthRenewalChore</a></span>(org.apache.hadoop.security.UserGroupInformation user)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> <div class="block">Checks if security is enabled and if so, launches chore for refreshing kerberos ticket.</div> </td> </tr> http://git-wip-us.apache.org/repos/asf/hbase-site/blob/5fd895c6/apidocs/org/apache/hadoop/hbase/client/ConnectionFactory.html ---------------------------------------------------------------------- diff --git a/apidocs/org/apache/hadoop/hbase/client/ConnectionFactory.html b/apidocs/org/apache/hadoop/hbase/client/ConnectionFactory.html index e3dba54..8a60f70 100644 --- a/apidocs/org/apache/hadoop/hbase/client/ConnectionFactory.html +++ b/apidocs/org/apache/hadoop/hbase/client/ConnectionFactory.html @@ -110,7 +110,7 @@ var activeTableTab = "activeTableTab"; <hr> <br> <pre>@InterfaceAudience.Public -public class <a href="../../../../../src-html/org/apache/hadoop/hbase/client/ConnectionFactory.html#line.56">ConnectionFactory</a> +public class <a href="../../../../../src-html/org/apache/hadoop/hbase/client/ConnectionFactory.html#line.68">ConnectionFactory</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">A non-instantiable class that manages creation of <a href="../../../../../org/apache/hadoop/hbase/client/Connection.html" title="interface in org.apache.hadoop.hbase.client"><code>Connection</code></a>s. Managing the lifecycle of the <a href="../../../../../org/apache/hadoop/hbase/client/Connection.html" title="interface in org.apache.hadoop.hbase.client"><code>Connection</code></a>s to the cluster is the responsibility of the caller. From a @@ -128,6 +128,16 @@ extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html } </pre> + Since 2.2.0, Connection created by ConnectionFactory can contain user-specified kerberos + credentials if caller has following two configurations set: + <ul> + <li>hbase.client.keytab.file, points to a valid keytab on the local filesystem + <li>hbase.client.kerberos.principal, gives the Kerberos principal to use + </ul> + By this way, caller can directly connect to kerberized cluster without caring login and + credentials renewal logic in application. + <pre> + </pre> Similarly, <a href="../../../../../org/apache/hadoop/hbase/client/Connection.html" title="interface in org.apache.hadoop.hbase.client"><code>Connection</code></a> also returns <a href="../../../../../org/apache/hadoop/hbase/client/Admin.html" title="interface in org.apache.hadoop.hbase.client"><code>Admin</code></a> and <a href="../../../../../org/apache/hadoop/hbase/client/RegionLocator.html" title="interface in org.apache.hadoop.hbase.client"><code>RegionLocator</code></a> implementations.</div> <dl> @@ -276,7 +286,7 @@ extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html <ul class="blockListLast"> <li class="blockList"> <h4>HBASE_CLIENT_ASYNC_CONNECTION_IMPL</h4> -<pre>public static final <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/client/ConnectionFactory.html#line.58">HBASE_CLIENT_ASYNC_CONNECTION_IMPL</a></pre> +<pre>public static final <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/client/ConnectionFactory.html#line.70">HBASE_CLIENT_ASYNC_CONNECTION_IMPL</a></pre> <dl> <dt><span class="seeLabel">See Also:</span></dt> <dd><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.client.ConnectionFactory.HBASE_CLIENT_ASYNC_CONNECTION_IMPL">Constant Field Values</a></dd> @@ -297,7 +307,7 @@ extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html <ul class="blockListLast"> <li class="blockList"> <h4>ConnectionFactory</h4> -<pre>protected <a href="../../../../../src-html/org/apache/hadoop/hbase/client/ConnectionFactory.html#line.61">ConnectionFactory</a>()</pre> +<pre>protected <a href="../../../../../src-html/org/apache/hadoop/hbase/client/ConnectionFactory.html#line.73">ConnectionFactory</a>()</pre> <div class="block">No public c.tors</div> </li> </ul> @@ -315,7 +325,7 @@ extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html <ul class="blockList"> <li class="blockList"> <h4>createConnection</h4> -<pre>public static <a href="../../../../../org/apache/hadoop/hbase/client/Connection.html" title="interface in org.apache.hadoop.hbase.client">Connection</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/ConnectionFactory.html#line.86">createConnection</a>() +<pre>public static <a href="../../../../../org/apache/hadoop/hbase/client/Connection.html" title="interface in org.apache.hadoop.hbase.client">Connection</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/ConnectionFactory.html#line.98">createConnection</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">Create a new Connection instance using default HBaseConfiguration. Connection encapsulates all housekeeping for a connection to the cluster. All tables and interfaces created from returned @@ -349,7 +359,7 @@ extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html <ul class="blockList"> <li class="blockList"> <h4>createConnection</h4> -<pre>public static <a href="../../../../../org/apache/hadoop/hbase/client/Connection.html" title="interface in org.apache.hadoop.hbase.client">Connection</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/ConnectionFactory.html#line.113">createConnection</a>(org.apache.hadoop.conf.Configuration conf) +<pre>public static <a href="../../../../../org/apache/hadoop/hbase/client/Connection.html" title="interface in org.apache.hadoop.hbase.client">Connection</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/ConnectionFactory.html#line.126">createConnection</a>(org.apache.hadoop.conf.Configuration conf) 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">Create a new Connection instance using the passed <code>conf</code> instance. Connection encapsulates all housekeeping for a connection to the cluster. All tables and interfaces @@ -385,7 +395,7 @@ extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html <ul class="blockList"> <li class="blockList"> <h4>createConnection</h4> -<pre>public static <a href="../../../../../org/apache/hadoop/hbase/client/Connection.html" title="interface in org.apache.hadoop.hbase.client">Connection</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/ConnectionFactory.html#line.141">createConnection</a>(org.apache.hadoop.conf.Configuration conf, +<pre>public static <a href="../../../../../org/apache/hadoop/hbase/client/Connection.html" title="interface in org.apache.hadoop.hbase.client">Connection</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/ConnectionFactory.html#line.154">createConnection</a>(org.apache.hadoop.conf.Configuration conf, <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/ExecutorService.html?is-external=true"; title="class or interface in java.util.concurrent">ExecutorService</a> pool) 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">Create a new Connection instance using the passed <code>conf</code> instance. Connection @@ -423,7 +433,7 @@ extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html <ul class="blockList"> <li class="blockList"> <h4>createConnection</h4> -<pre>public static <a href="../../../../../org/apache/hadoop/hbase/client/Connection.html" title="interface in org.apache.hadoop.hbase.client">Connection</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/ConnectionFactory.html#line.170">createConnection</a>(org.apache.hadoop.conf.Configuration conf, +<pre>public static <a href="../../../../../org/apache/hadoop/hbase/client/Connection.html" title="interface in org.apache.hadoop.hbase.client">Connection</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/ConnectionFactory.html#line.183">createConnection</a>(org.apache.hadoop.conf.Configuration conf, <a href="../../../../../org/apache/hadoop/hbase/security/User.html" title="class in org.apache.hadoop.hbase.security">User</a> user) 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">Create a new Connection instance using the passed <code>conf</code> instance. Connection @@ -461,7 +471,7 @@ extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html <ul class="blockList"> <li class="blockList"> <h4>createConnection</h4> -<pre>public static <a href="../../../../../org/apache/hadoop/hbase/client/Connection.html" title="interface in org.apache.hadoop.hbase.client">Connection</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/ConnectionFactory.html#line.199">createConnection</a>(org.apache.hadoop.conf.Configuration conf, +<pre>public static <a href="../../../../../org/apache/hadoop/hbase/client/Connection.html" title="interface in org.apache.hadoop.hbase.client">Connection</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/ConnectionFactory.html#line.212">createConnection</a>(org.apache.hadoop.conf.Configuration conf, <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/ExecutorService.html?is-external=true"; title="class or interface in java.util.concurrent">ExecutorService</a> pool, <a href="../../../../../org/apache/hadoop/hbase/security/User.html" title="class in org.apache.hadoop.hbase.security">User</a> user) 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> @@ -501,7 +511,7 @@ extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html <ul class="blockList"> <li class="blockList"> <h4>createAsyncConnection</h4> -<pre>public static <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true"; title="class or interface in java.util.concurrent">CompletableFuture</a><<a href="../../../../../org/apache/hadoop/hbase/client/AsyncConnection.html" title="interface in org.apache.hadoop.hbase.client">AsyncConnection</a>> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/ConnectionFactory.html#line.230">createAsyncConnection</a>()</pre> +<pre>public static <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true"; title="class or interface in java.util.concurrent">CompletableFuture</a><<a href="../../../../../org/apache/hadoop/hbase/client/AsyncConnection.html" title="interface in org.apache.hadoop.hbase.client">AsyncConnection</a>> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/ConnectionFactory.html#line.240">createAsyncConnection</a>()</pre> <div class="block">Call <a href="../../../../../org/apache/hadoop/hbase/client/ConnectionFactory.html#createAsyncConnection-org.apache.hadoop.conf.Configuration-"><code>createAsyncConnection(Configuration)</code></a> using default HBaseConfiguration.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> @@ -517,7 +527,7 @@ extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html <ul class="blockList"> <li class="blockList"> <h4>createAsyncConnection</h4> -<pre>public static <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true"; title="class or interface in java.util.concurrent">CompletableFuture</a><<a href="../../../../../org/apache/hadoop/hbase/client/AsyncConnection.html" title="interface in org.apache.hadoop.hbase.client">AsyncConnection</a>> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/ConnectionFactory.html#line.243">createAsyncConnection</a>(org.apache.hadoop.conf.Configuration conf)</pre> +<pre>public static <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true"; title="class or interface in java.util.concurrent">CompletableFuture</a><<a href="../../../../../org/apache/hadoop/hbase/client/AsyncConnection.html" title="interface in org.apache.hadoop.hbase.client">AsyncConnection</a>> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/ConnectionFactory.html#line.253">createAsyncConnection</a>(org.apache.hadoop.conf.Configuration conf)</pre> <div class="block">Call <a href="../../../../../org/apache/hadoop/hbase/client/ConnectionFactory.html#createAsyncConnection-org.apache.hadoop.conf.Configuration-org.apache.hadoop.hbase.security.User-"><code>createAsyncConnection(Configuration, User)</code></a> using the given <code>conf</code> and a User object created by <code>UserProvider</code>. The given <code>conf</code> will also be used to initialize the <code>UserProvider</code>.</div> @@ -538,7 +548,7 @@ extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html <ul class="blockListLast"> <li class="blockList"> <h4>createAsyncConnection</h4> -<pre>public static <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true"; title="class or interface in java.util.concurrent">CompletableFuture</a><<a href="../../../../../org/apache/hadoop/hbase/client/AsyncConnection.html" title="interface in org.apache.hadoop.hbase.client">AsyncConnection</a>> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/ConnectionFactory.html#line.271">createAsyncConnection</a>(org.apache.hadoop.conf.Configuration conf, +<pre>public static <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true"; title="class or interface in java.util.concurrent">CompletableFuture</a><<a href="../../../../../org/apache/hadoop/hbase/client/AsyncConnection.html" title="interface in org.apache.hadoop.hbase.client">AsyncConnection</a>> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/ConnectionFactory.html#line.281">createAsyncConnection</a>(org.apache.hadoop.conf.Configuration conf, <a href="../../../../../org/apache/hadoop/hbase/security/User.html" title="class in org.apache.hadoop.hbase.security">User</a> user)</pre> <div class="block">Create a new AsyncConnection instance using the passed <code>conf</code> and <code>user</code>. AsyncConnection encapsulates all housekeeping for a connection to the cluster. All tables and http://git-wip-us.apache.org/repos/asf/hbase-site/blob/5fd895c6/apidocs/org/apache/hadoop/hbase/package-summary.html ---------------------------------------------------------------------- diff --git a/apidocs/org/apache/hadoop/hbase/package-summary.html b/apidocs/org/apache/hadoop/hbase/package-summary.html index 52e1919..0c36ff2 100644 --- a/apidocs/org/apache/hadoop/hbase/package-summary.html +++ b/apidocs/org/apache/hadoop/hbase/package-summary.html @@ -151,8 +151,8 @@ <tbody> <tr class="altColor"> <td class="colFirst"><a href="../../../../org/apache/hadoop/hbase/AuthUtil.html" title="class in org.apache.hadoop.hbase">AuthUtil</a></td> -<td class="colLast"> -<div class="block">Utility methods for helping with security tasks.</div> +<td class="colLast">Deprecated +<div class="block"><span class="deprecationComment">since 2.2.0, to be removed in hbase-3.0.0.</span></div> </td> </tr> <tr class="rowColor"> http://git-wip-us.apache.org/repos/asf/hbase-site/blob/5fd895c6/apidocs/org/apache/hadoop/hbase/security/User.html ---------------------------------------------------------------------- diff --git a/apidocs/org/apache/hadoop/hbase/security/User.html b/apidocs/org/apache/hadoop/hbase/security/User.html index b904c89..19548a2 100644 --- a/apidocs/org/apache/hadoop/hbase/security/User.html +++ b/apidocs/org/apache/hadoop/hbase/security/User.html @@ -18,7 +18,7 @@ catch(err) { } //--> -var methods = {"i0":10,"i1":9,"i2":9,"i3":10,"i4":9,"i5":10,"i6":10,"i7":6,"i8":10,"i9":10,"i10":10,"i11":10,"i12":9,"i13":9,"i14":9,"i15":6,"i16":6,"i17":9,"i18":10}; +var methods = {"i0":10,"i1":9,"i2":9,"i3":10,"i4":9,"i5":10,"i6":10,"i7":6,"i8":10,"i9":10,"i10":10,"i11":10,"i12":9,"i13":10,"i14":9,"i15":9,"i16":9,"i17":6,"i18":6,"i19":9,"i20":9,"i21":10}; var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete Methods"]}; var altColor = "altColor"; var rowColor = "rowColor"; @@ -110,7 +110,7 @@ var activeTableTab = "activeTableTab"; <hr> <br> <pre>@InterfaceAudience.Public -public abstract class <a href="../../../../../src-html/org/apache/hadoop/hbase/security/User.html#line.55">User</a> +public abstract class <a href="../../../../../src-html/org/apache/hadoop/hbase/security/User.html#line.57">User</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">Wrapper to abstract out usage of user and group information in HBase. @@ -261,12 +261,16 @@ extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html </td> </tr> <tr id="i13" class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/security/User.html#isLoginFromKeytab--">isLoginFromKeytab</a></span>()</code> </td> +</tr> +<tr id="i14" class="altColor"> <td class="colFirst"><code>static boolean</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/security/User.html#isSecurityEnabled--">isSecurityEnabled</a></span>()</code> <div class="block">Returns whether or not Kerberos authentication is configured for Hadoop.</div> </td> </tr> -<tr id="i14" class="altColor"> +<tr id="i15" class="rowColor"> <td class="colFirst"><code>static void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/security/User.html#login-org.apache.hadoop.conf.Configuration-java.lang.String-java.lang.String-java.lang.String-">login</a></span>(org.apache.hadoop.conf.Configuration conf, <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> fileConfKey, @@ -276,25 +280,39 @@ extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html credential file and login principal.</div> </td> </tr> -<tr id="i15" class="rowColor"> +<tr id="i16" class="altColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/security/User.html#login-java.lang.String-java.lang.String-">login</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> keytabLocation, + <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> pricipalName)</code> +<div class="block">Login with the given keytab and principal.</div> +</td> +</tr> +<tr id="i17" class="rowColor"> <td class="colFirst"><code>abstract <T> T</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/security/User.html#runAs-java.security.PrivilegedAction-">runAs</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/security/PrivilegedAction.html?is-external=true"; title="class or interface in java.security">PrivilegedAction</a><T> action)</code> <div class="block">Executes the given action within the context of this user.</div> </td> </tr> -<tr id="i16" class="altColor"> +<tr id="i18" class="altColor"> <td class="colFirst"><code>abstract <T> T</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/security/User.html#runAs-java.security.PrivilegedExceptionAction-">runAs</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/security/PrivilegedExceptionAction.html?is-external=true"; title="class or interface in java.security">PrivilegedExceptionAction</a><T> action)</code> <div class="block">Executes the given action within the context of this user.</div> </td> </tr> -<tr id="i17" class="rowColor"> +<tr id="i19" class="rowColor"> <td class="colFirst"><code>static <T> T</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/security/User.html#runAsLoginUser-java.security.PrivilegedExceptionAction-">runAsLoginUser</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/security/PrivilegedExceptionAction.html?is-external=true"; title="class or interface in java.security">PrivilegedExceptionAction</a><T> action)</code> <div class="block">Executes the given action as the login user</div> </td> </tr> -<tr id="i18" class="altColor"> +<tr id="i20" class="altColor"> +<td class="colFirst"><code>static boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/security/User.html#shouldLoginFromKeytab-org.apache.hadoop.conf.Configuration-">shouldLoginFromKeytab</a></span>(org.apache.hadoop.conf.Configuration conf)</code> +<div class="block">In secure environment, if a user specified his keytab and principal, + a hbase client will try to login with them.</div> +</td> +</tr> +<tr id="i21" 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/User.html#toString--">toString</a></span>()</code> </td> </tr> @@ -326,7 +344,7 @@ extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html <ul class="blockList"> <li class="blockList"> <h4>HBASE_SECURITY_CONF_KEY</h4> -<pre>public static final <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/User.html#line.56">HBASE_SECURITY_CONF_KEY</a></pre> +<pre>public static final <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/User.html#line.58">HBASE_SECURITY_CONF_KEY</a></pre> <dl> <dt><span class="seeLabel">See Also:</span></dt> <dd><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.security.User.HBASE_SECURITY_CONF_KEY">Constant Field Values</a></dd> @@ -339,7 +357,7 @@ extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html <ul class="blockList"> <li class="blockList"> <h4>HBASE_SECURITY_AUTHORIZATION_CONF_KEY</h4> -<pre>public static final <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/User.html#line.58">HBASE_SECURITY_AUTHORIZATION_CONF_KEY</a></pre> +<pre>public static final <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/User.html#line.60">HBASE_SECURITY_AUTHORIZATION_CONF_KEY</a></pre> <dl> <dt><span class="seeLabel">See Also:</span></dt> <dd><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.security.User.HBASE_SECURITY_AUTHORIZATION_CONF_KEY">Constant Field Values</a></dd> @@ -352,7 +370,7 @@ extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html <ul class="blockListLast"> <li class="blockList"> <h4>ugi</h4> -<pre>protected org.apache.hadoop.security.UserGroupInformation <a href="../../../../../src-html/org/apache/hadoop/hbase/security/User.html#line.61">ugi</a></pre> +<pre>protected org.apache.hadoop.security.UserGroupInformation <a href="../../../../../src-html/org/apache/hadoop/hbase/security/User.html#line.63">ugi</a></pre> </li> </ul> </li> @@ -369,7 +387,7 @@ extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html <ul class="blockListLast"> <li class="blockList"> <h4>User</h4> -<pre>public <a href="../../../../../src-html/org/apache/hadoop/hbase/security/User.html#line.55">User</a>()</pre> +<pre>public <a href="../../../../../src-html/org/apache/hadoop/hbase/security/User.html#line.57">User</a>()</pre> </li> </ul> </li> @@ -386,7 +404,7 @@ extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html <ul class="blockList"> <li class="blockList"> <h4>getUGI</h4> -<pre>public org.apache.hadoop.security.UserGroupInformation <a href="../../../../../src-html/org/apache/hadoop/hbase/security/User.html#line.63">getUGI</a>()</pre> +<pre>public org.apache.hadoop.security.UserGroupInformation <a href="../../../../../src-html/org/apache/hadoop/hbase/security/User.html#line.65">getUGI</a>()</pre> </li> </ul> <a name="getName--"> @@ -395,7 +413,7 @@ extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html <ul class="blockList"> <li class="blockList"> <h4>getName</h4> -<pre>public <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/User.html#line.73">getName</a>()</pre> +<pre>public <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/User.html#line.75">getName</a>()</pre> <div class="block">Returns the full user name. For Kerberos principals this will include the host and realm portions of the principal name.</div> <dl> @@ -410,7 +428,7 @@ extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html <ul class="blockList"> <li class="blockList"> <h4>getGroupNames</h4> -<pre>public <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/User.html#line.82">getGroupNames</a>()</pre> +<pre>public <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/User.html#line.84">getGroupNames</a>()</pre> <div class="block">Returns the list of groups of which this user is a member. On secure Hadoop this returns the group information for the user as resolved on the server. For 0.20 based Hadoop, the group names are passed from the client.</div> @@ -422,7 +440,7 @@ extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html <ul class="blockList"> <li class="blockList"> <h4>getShortName</h4> -<pre>public abstract <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/User.html#line.92">getShortName</a>()</pre> +<pre>public abstract <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/User.html#line.94">getShortName</a>()</pre> <div class="block">Returns the shortened version of the user name -- the portion that maps to an operating system user name.</div> <dl> @@ -437,7 +455,7 @@ extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html <ul class="blockList"> <li class="blockList"> <h4>runAs</h4> -<pre>public abstract <T> T <a href="../../../../../src-html/org/apache/hadoop/hbase/security/User.html#line.97">runAs</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/security/PrivilegedAction.html?is-external=true"; title="class or interface in java.security">PrivilegedAction</a><T> action)</pre> +<pre>public abstract <T> T <a href="../../../../../src-html/org/apache/hadoop/hbase/security/User.html#line.99">runAs</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/security/PrivilegedAction.html?is-external=true"; title="class or interface in java.security">PrivilegedAction</a><T> action)</pre> <div class="block">Executes the given action within the context of this user.</div> </li> </ul> @@ -447,7 +465,7 @@ extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html <ul class="blockList"> <li class="blockList"> <h4>runAs</h4> -<pre>public abstract <T> T <a href="../../../../../src-html/org/apache/hadoop/hbase/security/User.html#line.102">runAs</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/security/PrivilegedExceptionAction.html?is-external=true"; title="class or interface in java.security">PrivilegedExceptionAction</a><T> action) +<pre>public abstract <T> T <a href="../../../../../src-html/org/apache/hadoop/hbase/security/User.html#line.104">runAs</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/security/PrivilegedExceptionAction.html?is-external=true"; title="class or interface in java.security">PrivilegedExceptionAction</a><T> action) 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>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/InterruptedException.html?is-external=true"; title="class or interface in java.lang">InterruptedException</a></pre> <div class="block">Executes the given action within the context of this user.</div> @@ -464,7 +482,7 @@ extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html <ul class="blockList"> <li class="blockList"> <h4>getToken</h4> -<pre>public org.apache.hadoop.security.token.Token<?> <a href="../../../../../src-html/org/apache/hadoop/hbase/security/User.html#line.113">getToken</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> kind, +<pre>public org.apache.hadoop.security.token.Token<?> <a href="../../../../../src-html/org/apache/hadoop/hbase/security/User.html#line.115">getToken</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> kind, <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> service) 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">Returns the Token of the specified kind associated with this user, @@ -486,7 +504,7 @@ extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html <ul class="blockList"> <li class="blockList"> <h4>getTokens</h4> -<pre>public <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><org.apache.hadoop.security.token.Token<? extends org.apache.hadoop.security.token.TokenIdentifier>> <a href="../../../../../src-html/org/apache/hadoop/hbase/security/User.html#line.126">getTokens</a>()</pre> +<pre>public <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><org.apache.hadoop.security.token.Token<? extends org.apache.hadoop.security.token.TokenIdentifier>> <a href="../../../../../src-html/org/apache/hadoop/hbase/security/User.html#line.128">getTokens</a>()</pre> <div class="block">Returns all the tokens stored in the user's credentials.</div> </li> </ul> @@ -496,7 +514,7 @@ extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html <ul class="blockList"> <li class="blockList"> <h4>addToken</h4> -<pre>public void <a href="../../../../../src-html/org/apache/hadoop/hbase/security/User.html#line.135">addToken</a>(org.apache.hadoop.security.token.Token<? extends org.apache.hadoop.security.token.TokenIdentifier> token)</pre> +<pre>public void <a href="../../../../../src-html/org/apache/hadoop/hbase/security/User.html#line.137">addToken</a>(org.apache.hadoop.security.token.Token<? extends org.apache.hadoop.security.token.TokenIdentifier> token)</pre> <div class="block">Adds the given Token to the user's credentials.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> @@ -504,13 +522,26 @@ extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html </dl> </li> </ul> +<a name="isLoginFromKeytab--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isLoginFromKeytab</h4> +<pre>public boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/security/User.html#line.144">isLoginFromKeytab</a>()</pre> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>true if user credentials are obtained from keytab.</dd> +</dl> +</li> +</ul> <a name="equals-java.lang.Object-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>equals</h4> -<pre>public boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/security/User.html#line.140">equals</a>(<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> o)</pre> +<pre>public boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/security/User.html#line.149">equals</a>(<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> o)</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#equals-java.lang.Object-"; title="class or interface in java.lang">equals</a></code> in class <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> @@ -523,7 +554,7 @@ extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html <ul class="blockList"> <li class="blockList"> <h4>hashCode</h4> -<pre>public int <a href="../../../../../src-html/org/apache/hadoop/hbase/security/User.html#line.151">hashCode</a>()</pre> +<pre>public int <a href="../../../../../src-html/org/apache/hadoop/hbase/security/User.html#line.160">hashCode</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#hashCode--"; title="class or interface in java.lang">hashCode</a></code> in class <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> @@ -536,7 +567,7 @@ extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html <ul class="blockList"> <li class="blockList"> <h4>toString</h4> -<pre>public <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/User.html#line.156">toString</a>()</pre> +<pre>public <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/User.html#line.165">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> in class <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> @@ -549,7 +580,7 @@ extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html <ul class="blockList"> <li class="blockList"> <h4>getCurrent</h4> -<pre>public static <a href="../../../../../org/apache/hadoop/hbase/security/User.html" title="class in org.apache.hadoop.hbase.security">User</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/security/User.html#line.163">getCurrent</a>() +<pre>public static <a href="../../../../../org/apache/hadoop/hbase/security/User.html" title="class in org.apache.hadoop.hbase.security">User</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/security/User.html#line.172">getCurrent</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">Returns the <code>User</code> instance within current execution context.</div> <dl> @@ -564,7 +595,7 @@ extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html <ul class="blockList"> <li class="blockList"> <h4>runAsLoginUser</h4> -<pre>public static <T> T <a href="../../../../../src-html/org/apache/hadoop/hbase/security/User.html#line.178">runAsLoginUser</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/security/PrivilegedExceptionAction.html?is-external=true"; title="class or interface in java.security">PrivilegedExceptionAction</a><T> action) +<pre>public static <T> T <a href="../../../../../src-html/org/apache/hadoop/hbase/security/User.html#line.187">runAsLoginUser</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/security/PrivilegedExceptionAction.html?is-external=true"; title="class or interface in java.security">PrivilegedExceptionAction</a><T> action) 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">Executes the given action as the login user</div> <dl> @@ -583,7 +614,7 @@ extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html <ul class="blockList"> <li class="blockList"> <h4>create</h4> -<pre>public static <a href="../../../../../org/apache/hadoop/hbase/security/User.html" title="class in org.apache.hadoop.hbase.security">User</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/security/User.html#line.194">create</a>(org.apache.hadoop.security.UserGroupInformation ugi)</pre> +<pre>public static <a href="../../../../../org/apache/hadoop/hbase/security/User.html" title="class in org.apache.hadoop.hbase.security">User</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/security/User.html#line.203">create</a>(org.apache.hadoop.security.UserGroupInformation ugi)</pre> <div class="block">Wraps an underlying <code>UserGroupInformation</code> instance.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> @@ -599,7 +630,7 @@ extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html <ul class="blockList"> <li class="blockList"> <h4>createUserForTesting</h4> -<pre>public static <a href="../../../../../org/apache/hadoop/hbase/security/User.html" title="class in org.apache.hadoop.hbase.security">User</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/security/User.html#line.207">createUserForTesting</a>(org.apache.hadoop.conf.Configuration conf, +<pre>public static <a href="../../../../../org/apache/hadoop/hbase/security/User.html" title="class in org.apache.hadoop.hbase.security">User</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/security/User.html#line.216">createUserForTesting</a>(org.apache.hadoop.conf.Configuration conf, <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> name, <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>[] groups)</pre> <div class="block">Generates a new <code>User</code> instance specifically for use in test code.</div> @@ -618,7 +649,7 @@ extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html <ul class="blockList"> <li class="blockList"> <h4>login</h4> -<pre>public static void <a href="../../../../../src-html/org/apache/hadoop/hbase/security/User.html#line.229">login</a>(org.apache.hadoop.conf.Configuration conf, +<pre>public static void <a href="../../../../../src-html/org/apache/hadoop/hbase/security/User.html#line.238">login</a>(org.apache.hadoop.conf.Configuration conf, <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> fileConfKey, <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> principalConfKey, <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> localhost) @@ -642,13 +673,32 @@ extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html </dl> </li> </ul> +<a name="login-java.lang.String-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>login</h4> +<pre>public static void <a href="../../../../../src-html/org/apache/hadoop/hbase/security/User.html#line.249">login</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> keytabLocation, + <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> pricipalName) + 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">Login with the given keytab and principal.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>keytabLocation</code> - path of keytab</dd> +<dd><code>pricipalName</code> - login principal</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> - underlying exception from UserGroupInformation.loginUserFromKeytab</dd> +</dl> +</li> +</ul> <a name="isSecurityEnabled--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>isSecurityEnabled</h4> -<pre>public static boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/security/User.html#line.240">isSecurityEnabled</a>()</pre> +<pre>public static boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/security/User.html#line.259">isSecurityEnabled</a>()</pre> <div class="block">Returns whether or not Kerberos authentication is configured for Hadoop. For non-secure Hadoop, this always returns <code>false</code>. For secure Hadoop, it will return the value from @@ -658,15 +708,33 @@ extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html <a name="isHBaseSecurityEnabled-org.apache.hadoop.conf.Configuration-"> <!-- --> </a> -<ul class="blockListLast"> +<ul class="blockList"> <li class="blockList"> <h4>isHBaseSecurityEnabled</h4> -<pre>public static boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/security/User.html#line.249">isHBaseSecurityEnabled</a>(org.apache.hadoop.conf.Configuration conf)</pre> +<pre>public static boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/security/User.html#line.268">isHBaseSecurityEnabled</a>(org.apache.hadoop.conf.Configuration conf)</pre> <div class="block">Returns whether or not secure authentication is enabled for HBase. Note that HBase security requires HDFS security to provide any guarantees, so it is recommended that secure HBase should run on secure HDFS.</div> </li> </ul> +<a name="shouldLoginFromKeytab-org.apache.hadoop.conf.Configuration-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>shouldLoginFromKeytab</h4> +<pre>public static boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/security/User.html#line.279">shouldLoginFromKeytab</a>(org.apache.hadoop.conf.Configuration conf)</pre> +<div class="block">In secure environment, if a user specified his keytab and principal, + a hbase client will try to login with them. Otherwise, hbase client will try to obtain + ticket(through kinit) from system.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>conf</code> - configuration file</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>true if keytab and principal are configured</dd> +</dl> +</li> +</ul> </li> </ul> </li> http://git-wip-us.apache.org/repos/asf/hbase-site/blob/5fd895c6/apidocs/org/apache/hadoop/hbase/security/class-use/User.html ---------------------------------------------------------------------- diff --git a/apidocs/org/apache/hadoop/hbase/security/class-use/User.html b/apidocs/org/apache/hadoop/hbase/security/class-use/User.html index 32e819d..ace1b72 100644 --- a/apidocs/org/apache/hadoop/hbase/security/class-use/User.html +++ b/apidocs/org/apache/hadoop/hbase/security/class-use/User.html @@ -106,6 +106,22 @@ </a> <h3>Uses of <a href="../../../../../../org/apache/hadoop/hbase/security/User.html" title="class in org.apache.hadoop.hbase.security">User</a> in <a href="../../../../../../org/apache/hadoop/hbase/package-summary.html">org.apache.hadoop.hbase</a></h3> <table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../../org/apache/hadoop/hbase/package-summary.html">org.apache.hadoop.hbase</a> that return <a href="../../../../../../org/apache/hadoop/hbase/security/User.html" title="class in org.apache.hadoop.hbase.security">User</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../../../../org/apache/hadoop/hbase/security/User.html" title="class in org.apache.hadoop.hbase.security">User</a></code></td> +<td class="colLast"><span class="typeNameLabel">AuthUtil.</span><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/AuthUtil.html#loginClient-org.apache.hadoop.conf.Configuration-">loginClient</a></span>(org.apache.hadoop.conf.Configuration conf)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">For kerberized cluster, return login user (from kinit or from keytab if specified).</div> +</td> +</tr> +</tbody> +</table> +<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> <caption><span>Methods in <a href="../../../../../../org/apache/hadoop/hbase/package-summary.html">org.apache.hadoop.hbase</a> with parameters of type <a href="../../../../../../org/apache/hadoop/hbase/security/User.html" title="class in org.apache.hadoop.hbase.security">User</a></span><span class="tabEnd"> </span></caption> <tr> <th class="colFirst" scope="col">Modifier and Type</th>
