http://git-wip-us.apache.org/repos/asf/hbase-site/blob/5fd895c6/devapidocs/index-all.html ---------------------------------------------------------------------- diff --git a/devapidocs/index-all.html b/devapidocs/index-all.html index 77a8257..a9b1fe2 100644 --- a/devapidocs/index-all.html +++ b/devapidocs/index-all.html @@ -4585,14 +4585,22 @@ <dd> </dd> <dt><a href="org/apache/hadoop/hbase/security/access/AuthResult.Params.html" title="class in org.apache.hadoop.hbase.security.access"><span class="typeNameLink">AuthResult.Params</span></a> - Class in <a href="org/apache/hadoop/hbase/security/access/package-summary.html">org.apache.hadoop.hbase.security.access</a></dt> <dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/hadoop/hbase/client/AsyncConnectionImpl.html#authService">authService</a></span> - Variable in class org.apache.hadoop.hbase.client.<a href="org/apache/hadoop/hbase/client/AsyncConnectionImpl.html" title="class in org.apache.hadoop.hbase.client">AsyncConnectionImpl</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/hadoop/hbase/client/ConnectionImplementation.html#authService">authService</a></span> - Variable in class org.apache.hadoop.hbase.client.<a href="org/apache/hadoop/hbase/client/ConnectionImplementation.html" title="class in org.apache.hadoop.hbase.client">ConnectionImplementation</a></dt> +<dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/hadoop/hbase/ipc/RpcServer.html#authTokenSecretMgr">authTokenSecretMgr</a></span> - Variable in class org.apache.hadoop.hbase.ipc.<a href="org/apache/hadoop/hbase/ipc/RpcServer.html" title="class in org.apache.hadoop.hbase.ipc">RpcServer</a></dt> <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/AuthUtil.html#AuthUtil--">AuthUtil()</a></span> - Constructor for class org.apache.hadoop.hbase.<a href="org/apache/hadoop/hbase/AuthUtil.html" title="class in org.apache.hadoop.hbase">AuthUtil</a></dt> -<dd> </dd> +<dd> +<div class="block"><span class="deprecatedLabel">Deprecated.</span></div> + </dd> <dt><span class="memberNameLink"><a href="org/apache/hadoop/hbase/quotas/RateLimiter.html#avail">avail</a></span> - Variable in class org.apache.hadoop.hbase.quotas.<a href="org/apache/hadoop/hbase/quotas/RateLimiter.html" title="class in org.apache.hadoop.hbase.quotas">RateLimiter</a></dt> <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/hadoop/hbase/util/UnsafeAvailChecker.html#avail">avail</a></span> - Static variable in class org.apache.hadoop.hbase.util.<a href="org/apache/hadoop/hbase/util/UnsafeAvailChecker.html" title="class in org.apache.hadoop.hbase.util">UnsafeAvailChecker</a></dt> @@ -10773,6 +10781,10 @@ <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/hadoop/hbase/mapreduce/SampleUploader.Uploader.html#checkpoint">checkpoint</a></span> - Variable in class org.apache.hadoop.hbase.mapreduce.<a href="org/apache/hadoop/hbase/mapreduce/SampleUploader.Uploader.html" title="class in org.apache.hadoop.hbase.mapreduce">SampleUploader.Uploader</a></dt> <dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/hadoop/hbase/AuthUtil.html#checkPrincipalMatch-org.apache.hadoop.conf.Configuration-java.lang.String-">checkPrincipalMatch(Configuration, 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> + </dd> <dt><span class="memberNameLink"><a href="org/apache/hadoop/hbase/master/replication/ReplicationPeerManager.html#checkQueuesDeleted-java.lang.String-">checkQueuesDeleted(String)</a></span> - Method in class org.apache.hadoop.hbase.master.replication.<a href="org/apache/hadoop/hbase/master/replication/ReplicationPeerManager.html" title="class in org.apache.hadoop.hbase.master.replication">ReplicationPeerManager</a></dt> <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/hadoop/hbase/quotas/DefaultOperationQuota.html#checkQuota-int-int-int-">checkQuota(int, int, int)</a></span> - Method in class org.apache.hadoop.hbase.quotas.<a href="org/apache/hadoop/hbase/quotas/DefaultOperationQuota.html" title="class in org.apache.hadoop.hbase.quotas">DefaultOperationQuota</a></dt> @@ -19584,6 +19596,10 @@ </dd> <dt><span class="memberNameLink"><a href="org/apache/hadoop/hbase/regionserver/StoreFileInfo.html#createdTimestamp">createdTimestamp</a></span> - Variable in class org.apache.hadoop.hbase.regionserver.<a href="org/apache/hadoop/hbase/regionserver/StoreFileInfo.html" title="class in org.apache.hadoop.hbase.regionserver">StoreFileInfo</a></dt> <dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/hadoop/hbase/AuthUtil.html#createDummyStoppable--">createDummyStoppable()</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> + </dd> <dt><span class="memberNameLink"><a href="org/apache/hadoop/hbase/KeyValue.html#createEmptyByteArray-int-int-int-long-org.apache.hadoop.hbase.KeyValue.Type-int-int-">createEmptyByteArray(int, int, int, long, KeyValue.Type, int, int)</a></span> - Static method in class org.apache.hadoop.hbase.<a href="org/apache/hadoop/hbase/KeyValue.html" title="class in org.apache.hadoop.hbase">KeyValue</a></dt> <dd> <div class="block">Create an empty byte[] representing a KeyValue @@ -34896,7 +34912,9 @@ <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/security/token/TokenProvider.html#getAuthenticationToken-com.google.protobuf.RpcController-org.apache.hadoop.hbase.protobuf.generated.AuthenticationProtos.GetAuthenticationTokenRequest-com.google.protobuf.RpcCallback-">getAuthenticationToken(RpcController, AuthenticationProtos.GetAuthenticationTokenRequest, RpcCallback<AuthenticationProtos.GetAuthenticationTokenResponse>)</a></span> - Method in class org.apache.hadoop.hbase.security.token.<a href="org/apache/hadoop/hbase/security/token/TokenProvider.html" title="class in org.apache.hadoop.hbase.security.token">TokenProvider</a></dt> <dd> </dd> @@ -34914,6 +34932,11 @@ <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/hadoop/hbase/ipc/ServerRpcConnection.html#getAuthorizedUgi-java.lang.String-">getAuthorizedUgi(String)</a></span> - Method in class org.apache.hadoop.hbase.ipc.<a href="org/apache/hadoop/hbase/ipc/ServerRpcConnection.html" title="class in org.apache.hadoop.hbase.ipc">ServerRpcConnection</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/security/visibility/VisibilityClient.html#getAuths-org.apache.hadoop.conf.Configuration-java.lang.String-">getAuths(Configuration, String)</a></span> - Static method in class org.apache.hadoop.hbase.security.visibility.<a href="org/apache/hadoop/hbase/security/visibility/VisibilityClient.html" title="class in org.apache.hadoop.hbase.security.visibility">VisibilityClient</a></dt> <dd> <div class="block"><span class="deprecatedLabel">Deprecated.</span> @@ -39866,6 +39889,7 @@ <dd> </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> @@ -54507,6 +54531,7 @@ <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/hadoop/hbase/AuthUtil.html#GROUP_PREFIX">GROUP_PREFIX</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">Prefix character to denote group names</div> </dd> <dt><span class="memberNameLink"><a href="org/apache/hadoop/hbase/rsgroup/RSGroupAdminEndpoint.html#groupAdminServer">groupAdminServer</a></span> - Variable in class org.apache.hadoop.hbase.rsgroup.<a href="org/apache/hadoop/hbase/rsgroup/RSGroupAdminEndpoint.html" title="class in org.apache.hadoop.hbase.rsgroup">RSGroupAdminEndpoint</a></dt> @@ -56009,6 +56034,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 @@ -62930,6 +62965,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> @@ -63171,6 +63207,8 @@ <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/hadoop/hbase/procedure2/LockStatus.html#isLockOwner-long-">isLockOwner(long)</a></span> - Method in interface org.apache.hadoop.hbase.procedure2.<a href="org/apache/hadoop/hbase/procedure2/LockStatus.html" title="interface in org.apache.hadoop.hbase.procedure2">LockStatus</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/master/assignment/AssignmentManager.html#isLogSplittingDone-org.apache.hadoop.hbase.ServerName-boolean-">isLogSplittingDone(ServerName, boolean)</a></span> - Method in class org.apache.hadoop.hbase.master.assignment.<a href="org/apache/hadoop/hbase/master/assignment/AssignmentManager.html" title="class in org.apache.hadoop.hbase.master.assignment">AssignmentManager</a></dt> <dd> <div class="block"> @@ -68056,7 +68094,9 @@ <dt><span class="memberNameLink"><a href="org/apache/hadoop/hbase/AsyncMetaTableAccessor.html#LOG">LOG</a></span> - Static variable in class org.apache.hadoop.hbase.<a href="org/apache/hadoop/hbase/AsyncMetaTableAccessor.html" title="class in org.apache.hadoop.hbase">AsyncMetaTableAccessor</a></dt> <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/hadoop/hbase/AuthUtil.html#LOG">LOG</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> </dd> +<dd> +<div class="block"><span class="deprecatedLabel">Deprecated.</span></div> + </dd> <dt><span class="memberNameLink"><a href="org/apache/hadoop/hbase/backup/BackupDriver.html#LOG">LOG</a></span> - Static variable in class org.apache.hadoop.hbase.backup.<a href="org/apache/hadoop/hbase/backup/BackupDriver.html" title="class in org.apache.hadoop.hbase.backup">BackupDriver</a></dt> <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/hadoop/hbase/backup/BackupHFileCleaner.html#LOG">LOG</a></span> - Static variable in class org.apache.hadoop.hbase.backup.<a href="org/apache/hadoop/hbase/backup/BackupHFileCleaner.html" title="class in org.apache.hadoop.hbase.backup">BackupHFileCleaner</a></dt> @@ -69565,28 +69605,54 @@ <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/security/User.SecureHadoopUser.html#login-org.apache.hadoop.conf.Configuration-java.lang.String-java.lang.String-java.lang.String-">login(Configuration, String, String, String)</a></span> - Static method in class org.apache.hadoop.hbase.security.<a href="org/apache/hadoop/hbase/security/User.SecureHadoopUser.html" title="class in org.apache.hadoop.hbase.security">User.SecureHadoopUser</a></dt> <dd> <div class="block">Obtain credentials for the current process using the configured Kerberos keytab file and principal.</div> </dd> +<dt><span class="memberNameLink"><a href="org/apache/hadoop/hbase/security/User.SecureHadoopUser.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.SecureHadoopUser.html" title="class in org.apache.hadoop.hbase.security">User.SecureHadoopUser</a></dt> +<dd> +<div class="block">Login through configured keytab and pricipal.</div> +</dd> <dt><span class="memberNameLink"><a href="org/apache/hadoop/hbase/security/UserProvider.html#login-java.lang.String-java.lang.String-java.lang.String-">login(String, String, String)</a></span> - Method in class org.apache.hadoop.hbase.security.<a href="org/apache/hadoop/hbase/security/UserProvider.html" title="class in org.apache.hadoop.hbase.security">UserProvider</a></dt> <dd> <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/UserProvider.html#login-java.lang.String-java.lang.String-">login(String, String)</a></span> - Method in class org.apache.hadoop.hbase.security.<a href="org/apache/hadoop/hbase/security/UserProvider.html" title="class in org.apache.hadoop.hbase.security">UserProvider</a></dt> +<dd> +<div class="block">Login with given keytab and principal.</div> +</dd> <dt><span class="memberNameLink"><a href="org/apache/hadoop/hbase/zookeeper/ZKUtil.html#login-org.apache.hadoop.conf.Configuration-java.lang.String-java.lang.String-java.lang.String-java.lang.String-java.lang.String-">login(Configuration, String, String, String, String, String)</a></span> - Static method in class org.apache.hadoop.hbase.zookeeper.<a href="org/apache/hadoop/hbase/zookeeper/ZKUtil.html" title="class in org.apache.hadoop.hbase.zookeeper">ZKUtil</a></dt> <dd> <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/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/zookeeper/ZKUtil.html#loginClient-org.apache.hadoop.conf.Configuration-java.lang.String-java.lang.String-java.lang.String-">loginClient(Configuration, String, String, String)</a></span> - Static method in class org.apache.hadoop.hbase.zookeeper.<a href="org/apache/hadoop/hbase/zookeeper/ZKUtil.html" title="class in org.apache.hadoop.hbase.zookeeper">ZKUtil</a></dt> <dd> <div class="block">Log in the current zookeeper client using the given configuration keys for the credential file and login principal.</div> </dd> +<dt><span class="memberNameLink"><a href="org/apache/hadoop/hbase/AuthUtil.html#loginClientAsService-org.apache.hadoop.conf.Configuration-">loginClientAsService(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).</div> +</dd> <dt><span class="memberNameLink"><a href="org/apache/hadoop/hbase/zookeeper/ZKUtil.JaasConfiguration.html#loginContextName">loginContextName</a></span> - Variable in class org.apache.hadoop.hbase.zookeeper.<a href="org/apache/hadoop/hbase/zookeeper/ZKUtil.JaasConfiguration.html" title="class in org.apache.hadoop.hbase.zookeeper">ZKUtil.JaasConfiguration</a></dt> <dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/hadoop/hbase/AuthUtil.html#loginFromKeytabAndReturnUser-org.apache.hadoop.hbase.security.UserProvider-">loginFromKeytabAndReturnUser(UserProvider)</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> + </dd> <dt><span class="memberNameLink"><a href="org/apache/hadoop/hbase/zookeeper/ZKUtil.html#loginServer-org.apache.hadoop.conf.Configuration-java.lang.String-java.lang.String-java.lang.String-">loginServer(Configuration, String, String, String)</a></span> - Static method in class org.apache.hadoop.hbase.zookeeper.<a href="org/apache/hadoop/hbase/zookeeper/ZKUtil.html" title="class in org.apache.hadoop.hbase.zookeeper">ZKUtil</a></dt> <dd> <div class="block">Log in the current zookeeper server process using the given configuration @@ -105139,6 +105205,16 @@ service.</div> <div class="block">If we make sure the block could not be cached, we will not acquire the lock otherwise we will acquire lock</div> </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/security/UserProvider.html#shouldLoginFromKeytab--">shouldLoginFromKeytab()</a></span> - Method in class org.apache.hadoop.hbase.security.<a href="org/apache/hadoop/hbase/security/UserProvider.html" title="class in org.apache.hadoop.hbase.security">UserProvider</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/filter/FilterListWithOR.html#shouldPassCurrentCellToFilter-org.apache.hadoop.hbase.Cell-org.apache.hadoop.hbase.Cell-org.apache.hadoop.hbase.filter.Filter.ReturnCode-">shouldPassCurrentCellToFilter(Cell, Cell, Filter.ReturnCode)</a></span> - Method in class org.apache.hadoop.hbase.filter.<a href="org/apache/hadoop/hbase/filter/FilterListWithOR.html" title="class in org.apache.hadoop.hbase.filter">FilterListWithOR</a></dt> <dd> <div class="block">For MUST_PASS_ONE, we cannot make sure that when filter-A in filter list return NEXT_COL then @@ -107621,6 +107697,10 @@ service.</div> <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/hadoop/hbase/HBaseInterfaceAudience.html#SPARK">SPARK</a></span> - Static variable in class org.apache.hadoop.hbase.<a href="org/apache/hadoop/hbase/HBaseInterfaceAudience.html" title="class in org.apache.hadoop.hbase">HBaseInterfaceAudience</a></dt> <dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/hadoop/hbase/client/AsyncConnectionImpl.html#spawnRenewalChore-org.apache.hadoop.security.UserGroupInformation-">spawnRenewalChore(UserGroupInformation)</a></span> - Method in class org.apache.hadoop.hbase.client.<a href="org/apache/hadoop/hbase/client/AsyncConnectionImpl.html" title="class in org.apache.hadoop.hbase.client">AsyncConnectionImpl</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/hadoop/hbase/client/ConnectionImplementation.html#spawnRenewalChore-org.apache.hadoop.security.UserGroupInformation-">spawnRenewalChore(UserGroupInformation)</a></span> - Method in class org.apache.hadoop.hbase.client.<a href="org/apache/hadoop/hbase/client/ConnectionImplementation.html" title="class in org.apache.hadoop.hbase.client">ConnectionImplementation</a></dt> +<dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/hadoop/hbase/util/RegionSplitCalculator.html#specialEndKey-R-">specialEndKey(R)</a></span> - Static method in class org.apache.hadoop.hbase.util.<a href="org/apache/hadoop/hbase/util/RegionSplitCalculator.html" title="class in org.apache.hadoop.hbase.util">RegionSplitCalculator</a></dt> <dd> <div class="block">SPECIAL CASE wrapper for empty end key</div> @@ -114142,6 +114222,7 @@ service.</div> <dd> </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/rsgroup/RSGroupProtobufUtil.html#toGroupInfo-org.apache.hadoop.hbase.protobuf.generated.RSGroupProtos.RSGroupInfo-">toGroupInfo(RSGroupProtos.RSGroupInfo)</a></span> - Static method in class org.apache.hadoop.hbase.rsgroup.<a href="org/apache/hadoop/hbase/rsgroup/RSGroupProtobufUtil.html" title="class in org.apache.hadoop.hbase.rsgroup">RSGroupProtobufUtil</a></dt>
http://git-wip-us.apache.org/repos/asf/hbase-site/blob/5fd895c6/devapidocs/org/apache/hadoop/hbase/AuthUtil.html ---------------------------------------------------------------------- diff --git a/devapidocs/org/apache/hadoop/hbase/AuthUtil.html b/devapidocs/org/apache/hadoop/hbase/AuthUtil.html index 04159f0..86e2a30 100644 --- a/devapidocs/org/apache/hadoop/hbase/AuthUtil.html +++ b/devapidocs/org/apache/hadoop/hbase/AuthUtil.html @@ -18,8 +18,8 @@ catch(err) { } //--> -var methods = {"i0":9,"i1":9,"i2":9,"i3":9}; -var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"]}; +var methods = {"i0":41,"i1":41,"i2":41,"i3":41,"i4":41,"i5":41,"i6":41,"i7":41,"i8":41,"i9":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"; @@ -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,7 +149,12 @@ 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> @@ -167,12 +176,29 @@ extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html <tr class="altColor"> <td class="colFirst"><code>private 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#GROUP_PREFIX">GROUP_PREFIX</a></span></code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> <div class="block">Prefix character to denote group names</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_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="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_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> +<tr class="rowColor"> <td class="colFirst"><code>private static org.slf4j.Logger</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/AuthUtil.html#LOG">LOG</a></span></code> </td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/AuthUtil.html#LOG">LOG</a></span></code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> + </td> </tr> </table> </li> @@ -191,7 +217,9 @@ extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html </tr> <tr class="altColor"> <td class="colFirst"><code>private </code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/AuthUtil.html#AuthUtil--">AuthUtil</a></span>()</code> </td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/AuthUtil.html#AuthUtil--">AuthUtil</a></span>()</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> + </td> </tr> </table> </li> @@ -203,34 +231,79 @@ 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> </tr> <tr id="i0" class="altColor"> +<td class="colFirst"><code>private static boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/AuthUtil.html#checkPrincipalMatch-org.apache.hadoop.conf.Configuration-java.lang.String-">checkPrincipalMatch</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> loginUserName)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> + </td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>private static <a href="../../../../org/apache/hadoop/hbase/Stoppable.html" title="interface in org.apache.hadoop.hbase">Stoppable</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/AuthUtil.html#createDummyStoppable--">createDummyStoppable</a></span>()</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> + </td> +</tr> +<tr id="i2" 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"><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 id="i3" 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"><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> -<tr id="i1" class="rowColor"> +<tr id="i4" 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#getGroupName-java.lang.String-">getGroupName</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> aclKey)</code> +<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> </td> </tr> -<tr id="i2" class="altColor"> +<tr id="i5" class="rowColor"> <td class="colFirst"><code>static boolean</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/AuthUtil.html#isGroupPrincipal-java.lang.String-">isGroupPrincipal</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> name)</code> +<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> </td> </tr> -<tr id="i3" class="rowColor"> +<tr id="i6" 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"><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> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code>private 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"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/AuthUtil.html#loginClientAsService-org.apache.hadoop.conf.Configuration-">loginClientAsService</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).</div> +</td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code>private 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"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/AuthUtil.html#loginFromKeytabAndReturnUser-org.apache.hadoop.hbase.security.UserProvider-">loginFromKeytabAndReturnUser</a></span>(<a href="../../../../org/apache/hadoop/hbase/security/UserProvider.html" title="class in org.apache.hadoop.hbase.security">UserProvider</a> provider)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> + </td> +</tr> +<tr id="i9" 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#toGroupEntry-java.lang.String-">toGroupEntry</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> name)</code> +<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> </td> </tr> @@ -262,16 +335,18 @@ extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html <ul class="blockList"> <li class="blockList"> <h4>LOG</h4> -<pre>private static final org.slf4j.Logger <a href="../../../../src-html/org/apache/hadoop/hbase/AuthUtil.html#line.71">LOG</a></pre> +<pre>private static final org.slf4j.Logger <a href="../../../../src-html/org/apache/hadoop/hbase/AuthUtil.html#line.81">LOG</a></pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> </li> </ul> <a name="GROUP_PREFIX"> <!-- --> </a> -<ul class="blockListLast"> +<ul class="blockList"> <li class="blockList"> <h4>GROUP_PREFIX</h4> -<pre>private 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.74">GROUP_PREFIX</a></pre> +<pre>private 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.84">GROUP_PREFIX</a></pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> <div class="block">Prefix character to denote group names</div> <dl> <dt><span class="seeLabel">See Also:</span></dt> @@ -279,6 +354,36 @@ extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html </dl> </li> </ul> +<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> <!-- ========= CONSTRUCTOR DETAIL ======== --> @@ -293,7 +398,8 @@ extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html <ul class="blockListLast"> <li class="blockList"> <h4>AuthUtil</h4> -<pre>private <a href="../../../../src-html/org/apache/hadoop/hbase/AuthUtil.html#line.76">AuthUtil</a>()</pre> +<pre>private <a href="../../../../src-html/org/apache/hadoop/hbase/AuthUtil.html#line.92">AuthUtil</a>()</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> </li> </ul> </li> @@ -304,14 +410,105 @@ extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html <!-- --> </a> <h3>Method Detail</h3> +<a name="loginClient-org.apache.hadoop.conf.Configuration-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>loginClient</h4> +<pre>@InterfaceAudience.Private +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/AuthUtil.html#line.104">loginClient</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> </div> +<div class="block">For kerberized cluster, return login user (from kinit or from keytab if specified). + For non-kerberized cluster, return system user.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>conf</code> - configuartion file</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>user</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> - login exception</dd> +</dl> +</li> +</ul> +<a name="checkPrincipalMatch-org.apache.hadoop.conf.Configuration-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>checkPrincipalMatch</h4> +<pre>private static boolean <a href="../../../../src-html/org/apache/hadoop/hbase/AuthUtil.html#line.132">checkPrincipalMatch</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> loginUserName)</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +</li> +</ul> +<a name="loginFromKeytabAndReturnUser-org.apache.hadoop.hbase.security.UserProvider-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>loginFromKeytabAndReturnUser</h4> +<pre>private 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/AuthUtil.html#line.142">loginFromKeytabAndReturnUser</a>(<a href="../../../../org/apache/hadoop/hbase/security/UserProvider.html" title="class in org.apache.hadoop.hbase.security">UserProvider</a> provider) + 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> </div> +<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="loginClientAsService-org.apache.hadoop.conf.Configuration-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>loginClientAsService</h4> +<pre>private 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/AuthUtil.html#line.165">loginClientAsService</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> </div> +<div class="block">For kerberized cluster, return login user (from kinit or from keytab). + Principal should be the following format: name/fully.qualified.domain.name@REALM. + For non-kerberized cluster, return system user. + <p> + NOT recommend to use to method unless you're sure what you're doing, it is for canary only. + Please use User#loginClient.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>conf</code> - configuration file</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>user</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> - login exception</dd> +</dl> +</li> +</ul> +<a name="getAuthRenewalChore-org.apache.hadoop.security.UserGroupInformation-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAuthRenewalChore</h4> +<pre>@InterfaceAudience.Private +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.191">getAuthRenewalChore</a>(org.apache.hadoop.security.UserGroupInformation user)</pre> +<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> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a ScheduledChore for renewals.</dd> +</dl> +</li> +</ul> <a name="getAuthChore-org.apache.hadoop.conf.Configuration-"> <!-- --> </a> <ul class="blockList"> <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> @@ -323,6 +520,16 @@ extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html </dl> </li> </ul> +<a name="createDummyStoppable--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createDummyStoppable</h4> +<pre>private static <a href="../../../../org/apache/hadoop/hbase/Stoppable.html" title="interface in org.apache.hadoop.hbase">Stoppable</a> <a href="../../../../src-html/org/apache/hadoop/hbase/AuthUtil.html#line.226">createDummyStoppable</a>()</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +</li> +</ul> <a name="isGroupPrincipal-java.lang.String-"> <!-- --> </a> @@ -330,7 +537,8 @@ extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html <li class="blockList"> <h4>isGroupPrincipal</h4> <pre>@InterfaceAudience.Private -public static boolean <a href="../../../../src-html/org/apache/hadoop/hbase/AuthUtil.html#line.146">isGroupPrincipal</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> name)</pre> +public static boolean <a href="../../../../src-html/org/apache/hadoop/hbase/AuthUtil.html#line.248">isGroupPrincipal</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> name)</pre> +<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. Currently this simply checks if the name starts with the special group prefix character ("@").</div> @@ -343,7 +551,8 @@ public static boolean <a href="../../../../src-html/org/apache/hadoop/ <li class="blockList"> <h4>getGroupName</h4> <pre>@InterfaceAudience.Private -public 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> <a href="../../../../src-html/org/apache/hadoop/hbase/AuthUtil.html#line.155">getGroupName</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> aclKey)</pre> +public 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> <a href="../../../../src-html/org/apache/hadoop/hbase/AuthUtil.html#line.257">getGroupName</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> aclKey)</pre> +<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> </li> @@ -355,7 +564,8 @@ public static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ <li class="blockList"> <h4>toGroupEntry</h4> <pre>@InterfaceAudience.Private -public 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> <a href="../../../../src-html/org/apache/hadoop/hbase/AuthUtil.html#line.167">toGroupEntry</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> name)</pre> +public 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> <a href="../../../../src-html/org/apache/hadoop/hbase/AuthUtil.html#line.269">toGroupEntry</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> name)</pre> +<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> </li> </ul> http://git-wip-us.apache.org/repos/asf/hbase-site/blob/5fd895c6/devapidocs/org/apache/hadoop/hbase/backup/package-tree.html ---------------------------------------------------------------------- diff --git a/devapidocs/org/apache/hadoop/hbase/backup/package-tree.html b/devapidocs/org/apache/hadoop/hbase/backup/package-tree.html index f11e74d..44aeebe 100644 --- a/devapidocs/org/apache/hadoop/hbase/backup/package-tree.html +++ b/devapidocs/org/apache/hadoop/hbase/backup/package-tree.html @@ -168,8 +168,8 @@ <li type="circle">java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true"; title="class or interface in java.lang"><span class="typeNameLink">Enum</span></a><E> (implements java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html?is-external=true"; title="class or interface in java.lang">Comparable</a><T>, java.io.<a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true"; title="class or interface in java.io">Serializable</a>) <ul> <li type="circle">org.apache.hadoop.hbase.backup.<a href="../../../../../org/apache/hadoop/hbase/backup/BackupRestoreConstants.BackupCommand.html" title="enum in org.apache.hadoop.hbase.backup"><span class="typeNameLink">BackupRestoreConstants.BackupCommand</span></a></li> -<li type="circle">org.apache.hadoop.hbase.backup.<a href="../../../../../org/apache/hadoop/hbase/backup/BackupInfo.BackupState.html" title="enum in org.apache.hadoop.hbase.backup"><span class="typeNameLink">BackupInfo.BackupState</span></a></li> <li type="circle">org.apache.hadoop.hbase.backup.<a href="../../../../../org/apache/hadoop/hbase/backup/BackupInfo.BackupPhase.html" title="enum in org.apache.hadoop.hbase.backup"><span class="typeNameLink">BackupInfo.BackupPhase</span></a></li> +<li type="circle">org.apache.hadoop.hbase.backup.<a href="../../../../../org/apache/hadoop/hbase/backup/BackupInfo.BackupState.html" title="enum in org.apache.hadoop.hbase.backup"><span class="typeNameLink">BackupInfo.BackupState</span></a></li> <li type="circle">org.apache.hadoop.hbase.backup.<a href="../../../../../org/apache/hadoop/hbase/backup/BackupType.html" title="enum in org.apache.hadoop.hbase.backup"><span class="typeNameLink">BackupType</span></a></li> </ul> </li> http://git-wip-us.apache.org/repos/asf/hbase-site/blob/5fd895c6/devapidocs/org/apache/hadoop/hbase/class-use/ChoreService.html ---------------------------------------------------------------------- diff --git a/devapidocs/org/apache/hadoop/hbase/class-use/ChoreService.html b/devapidocs/org/apache/hadoop/hbase/class-use/ChoreService.html index 1d3d90c..4210012 100644 --- a/devapidocs/org/apache/hadoop/hbase/class-use/ChoreService.html +++ b/devapidocs/org/apache/hadoop/hbase/class-use/ChoreService.html @@ -87,18 +87,24 @@ <td class="colLast"> </td> </tr> <tr class="rowColor"> +<td class="colFirst"><a href="#org.apache.hadoop.hbase.client">org.apache.hadoop.hbase.client</a></td> +<td class="colLast"> +<div class="block">Provides HBase Client</div> +</td> +</tr> +<tr class="altColor"> <td class="colFirst"><a href="#org.apache.hadoop.hbase.master">org.apache.hadoop.hbase.master</a></td> <td class="colLast"> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><a href="#org.apache.hadoop.hbase.regionserver">org.apache.hadoop.hbase.regionserver</a></td> <td class="colLast"> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><a href="#org.apache.hadoop.hbase.replication.regionserver">org.apache.hadoop.hbase.replication.regionserver</a></td> <td class="colLast"> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><a href="#org.apache.hadoop.hbase.util">org.apache.hadoop.hbase.util</a></td> <td class="colLast"> </td> </tr> @@ -125,6 +131,28 @@ </tbody> </table> </li> +<li class="blockList"><a name="org.apache.hadoop.hbase.client"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../org/apache/hadoop/hbase/ChoreService.html" title="class in org.apache.hadoop.hbase">ChoreService</a> in <a href="../../../../../org/apache/hadoop/hbase/client/package-summary.html">org.apache.hadoop.hbase.client</a></h3> +<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing fields, and an explanation"> +<caption><span>Fields in <a href="../../../../../org/apache/hadoop/hbase/client/package-summary.html">org.apache.hadoop.hbase.client</a> declared as <a href="../../../../../org/apache/hadoop/hbase/ChoreService.html" title="class in org.apache.hadoop.hbase">ChoreService</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>private <a href="../../../../../org/apache/hadoop/hbase/ChoreService.html" title="class in org.apache.hadoop.hbase">ChoreService</a></code></td> +<td class="colLast"><span class="typeNameLabel">ConnectionImplementation.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/ConnectionImplementation.html#authService">authService</a></span></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>private <a href="../../../../../org/apache/hadoop/hbase/ChoreService.html" title="class in org.apache.hadoop.hbase">ChoreService</a></code></td> +<td class="colLast"><span class="typeNameLabel">AsyncConnectionImpl.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/AsyncConnectionImpl.html#authService">authService</a></span></code> </td> +</tr> +</tbody> +</table> +</li> <li class="blockList"><a name="org.apache.hadoop.hbase.master"> <!-- --> </a> http://git-wip-us.apache.org/repos/asf/hbase-site/blob/5fd895c6/devapidocs/org/apache/hadoop/hbase/class-use/ScheduledChore.html ---------------------------------------------------------------------- diff --git a/devapidocs/org/apache/hadoop/hbase/class-use/ScheduledChore.html b/devapidocs/org/apache/hadoop/hbase/class-use/ScheduledChore.html index fe3cc29..ecb28b9 100644 --- a/devapidocs/org/apache/hadoop/hbase/class-use/ScheduledChore.html +++ b/devapidocs/org/apache/hadoop/hbase/class-use/ScheduledChore.html @@ -166,6 +166,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/devapidocs/org/apache/hadoop/hbase/class-use/Stoppable.html ---------------------------------------------------------------------- diff --git a/devapidocs/org/apache/hadoop/hbase/class-use/Stoppable.html b/devapidocs/org/apache/hadoop/hbase/class-use/Stoppable.html index 60fabe9..f7b3ad5 100644 --- a/devapidocs/org/apache/hadoop/hbase/class-use/Stoppable.html +++ b/devapidocs/org/apache/hadoop/hbase/class-use/Stoppable.html @@ -216,6 +216,12 @@ </tr> <tbody> <tr class="altColor"> +<td class="colFirst"><code>private static <a href="../../../../../org/apache/hadoop/hbase/Stoppable.html" title="interface in org.apache.hadoop.hbase">Stoppable</a></code></td> +<td class="colLast"><span class="typeNameLabel">AuthUtil.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/AuthUtil.html#createDummyStoppable--">createDummyStoppable</a></span>()</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> + </td> +</tr> +<tr class="rowColor"> <td class="colFirst"><code><a href="../../../../../org/apache/hadoop/hbase/Stoppable.html" title="interface in org.apache.hadoop.hbase">Stoppable</a></code></td> <td class="colLast"><span class="typeNameLabel">ScheduledChore.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/ScheduledChore.html#getStopper--">getStopper</a></span>()</code> </td> </tr>
