AccessControlClient (Apache HBase 1.4.11 API)

java.lang.Object
- org.apache.hadoop.hbase.security.access.AccessControlClient

@InterfaceAudience.Public
@InterfaceStability.Evolving
public class AccessControlClient
extends Object

Utility client for doing access control admin operations.

Field Summary

Fields
Modifier and Type Field and Description

static TableName ACL_TABLE_NAME

Fields
Modifier and Type	Field and Description
`static TableName`	`ACL_TABLE_NAME`

Constructor Summary

Constructors
Constructor and Description

AccessControlClient()

Constructors
Constructor and Description
`AccessControlClient()`

Method Summary

Methods
Modifier and Type	Method and Description
`static List<UserPermission>`	`getUserPermissions(org.apache.hadoop.conf.Configuration conf, String tableRegex)` Deprecated. Use `getUserPermissions(Connection, String)` instead.
`static List<UserPermission>`	`getUserPermissions(Connection connection, String tableRegex)` List all the userPermissions matching the given pattern.
`static void`	`grant(org.apache.hadoop.conf.Configuration conf, String userName, Permission.Action... actions)` Deprecated. Use `grant(Connection, String, Permission.Action...)` instead.
`static void`	`grant(org.apache.hadoop.conf.Configuration conf, String namespace, String userName, Permission.Action... actions)` Deprecated. Use `grant(Connection, String, String, Permission.Action...)` instead.
`static void`	`grant(org.apache.hadoop.conf.Configuration conf, TableName tableName, String userName, byte[] family, byte[] qual, Permission.Action... actions)` Deprecated. Use `grant(Connection, TableName, String, byte[], byte[], Permission.Action...)` instead.
`static void`	`grant(Connection connection, String userName, boolean mergeExistingPermissions, Permission.Action... actions)` Grant global permissions for the specified user.
`static void`	`grant(Connection connection, String userName, Permission.Action... actions)` Grant global permissions for the specified user.
`static void`	`grant(Connection connection, String namespace, String userName, boolean mergeExistingPermissions, Permission.Action... actions)` Grants permission on the specified namespace for the specified user.
`static void`	`grant(Connection connection, String namespace, String userName, Permission.Action... actions)` Grants permission on the specified namespace for the specified user.
`static void`	`grant(Connection connection, TableName tableName, String userName, byte[] family, byte[] qual, boolean mergeExistingPermissions, Permission.Action... actions)` Grants permission on the specified table for the specified user
`static void`	`grant(Connection connection, TableName tableName, String userName, byte[] family, byte[] qual, Permission.Action... actions)` Grants permission on the specified table for the specified user.
`static boolean`	`isAccessControllerRunning(org.apache.hadoop.conf.Configuration conf)` Deprecated. Use `isAccessControllerRunning(Connection)` instead.
`static boolean`	`isAccessControllerRunning(Connection connection)`
`static boolean`	`isAuthorizationEnabled(Connection connection)` Return true if authorization is supported and enabled
`static boolean`	`isCellAuthorizationEnabled(Connection connection)` Return true if cell authorization is supported and enabled
`static void`	`revoke(org.apache.hadoop.conf.Configuration conf, String userName, Permission.Action... actions)` Deprecated. Use `revoke(Connection, String, Permission.Action...)` instead.
`static void`	`revoke(org.apache.hadoop.conf.Configuration conf, String namespace, String userName, Permission.Action... actions)` Deprecated. Use `revoke(Connection, String, String, Permission.Action...)` instead.
`static void`	`revoke(org.apache.hadoop.conf.Configuration conf, TableName tableName, String username, byte[] family, byte[] qualifier, Permission.Action... actions)` Deprecated. Use `revoke(Connection, TableName, String, byte[], byte[], Permission.Action...)` instead.
`static void`	`revoke(Connection connection, String userName, Permission.Action... actions)` Revoke global permissions for the specified user.
`static void`	`revoke(Connection connection, String namespace, String userName, Permission.Action... actions)` Revokes the permission on the table for the specified user.
`static void`	`revoke(Connection connection, TableName tableName, String username, byte[] family, byte[] qualifier, Permission.Action... actions)` Revokes the permission on the table

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ACL_TABLE_NAME

public static final TableName ACL_TABLE_NAME

Constructor Detail
- AccessControlClient
```
public AccessControlClient()
```

Method Detail

isAuthorizationEnabled
```
public static boolean isAuthorizationEnabled(Connection connection)
                                      throws IOException
```
Return true if authorization is supported and enabled

Parameters:
connection - The connection to use

Returns:
true if authorization is supported and enabled, false otherwise

Throws:

IOException

isCellAuthorizationEnabled
```
public static boolean isCellAuthorizationEnabled(Connection connection)
                                          throws IOException
```
Return true if cell authorization is supported and enabled

Parameters:
connection - The connection to use

Returns:
true if cell authorization is supported and enabled, false otherwise

Throws:

IOException

grant
```
public static void grant(Connection connection,
         TableName tableName,
         String userName,
         byte[] family,
         byte[] qual,
         boolean mergeExistingPermissions,
         Permission.Action... actions)
                  throws Throwable
```
Grants permission on the specified table for the specified user

Parameters:
connection - The Connection instance to use
tableName -
userName -
family -
qual -
mergeExistingPermissions - If set to false, later granted permissions will override previous granted permissions. otherwise, it'll merge with previous granted permissions.
actions -

Throws:

Throwable

grant

public static void grant(Connection connection,
         TableName tableName,
         String userName,
         byte[] family,
         byte[] qual,
         Permission.Action... actions)
                  throws Throwable

Grants permission on the specified table for the specified user. If permissions for a specified user exists, later granted permissions will override previous granted permissions.

Parameters:: connection -; tableName -; userName -; family -; qual -; actions -
Throws:: Throwable

grant
```
public static void grant(Connection connection,
         String namespace,
         String userName,
         boolean mergeExistingPermissions,
         Permission.Action... actions)
                  throws Throwable
```
Grants permission on the specified namespace for the specified user.

Parameters:
connection -
namespace -
userName -
mergeExistingPermissions - If set to false, later granted permissions will override previous granted permissions. otherwise, it'll merge with previous granted permissions.
actions -

Throws:

Throwable

grant
```
public static void grant(Connection connection,
         String namespace,
         String userName,
         Permission.Action... actions)
                  throws Throwable
```
Grants permission on the specified namespace for the specified user. If permissions for a specified user exists, later granted permissions will override previous granted permissions.

Parameters:
connection - The Connection instance to use
namespace -
userName -
actions -

Throws:

Throwable

grant
```
public static void grant(Connection connection,
         String userName,
         boolean mergeExistingPermissions,
         Permission.Action... actions)
                  throws Throwable
```
Grant global permissions for the specified user.

Parameters:
connection - The Connection instance to use
userName -
mergeExistingPermissions - If set to false, later granted permissions will override previous granted permissions. otherwise, it'll merge with previous granted permissions.
actions -

Throws:

Throwable

grant

public static void grant(Connection connection,
         String userName,
         Permission.Action... actions)
                  throws Throwable

Grant global permissions for the specified user.

Parameters:: connection - The Connection instance to use; userName -; actions -
Throws:: Throwable

isAccessControllerRunning

public static boolean isAccessControllerRunning(Connection connection)
                                         throws MasterNotRunningException,
                                                ZooKeeperConnectionException,
                                                IOException

Throws:: MasterNotRunningException; ZooKeeperConnectionException; IOException

revoke

public static void revoke(Connection connection,
          TableName tableName,
          String username,
          byte[] family,
          byte[] qualifier,
          Permission.Action... actions)
                   throws Throwable

Revokes the permission on the table

Parameters:: connection - The Connection instance to use; tableName -; username -; family -; qualifier -; actions -
Throws:: Throwable

revoke

public static void revoke(Connection connection,
          String namespace,
          String userName,
          Permission.Action... actions)
                   throws Throwable

Revokes the permission on the table for the specified user.

Parameters:: connection - The Connection instance to use; namespace -; userName -; actions -
Throws:: Throwable

revoke

public static void revoke(Connection connection,
          String userName,
          Permission.Action... actions)
                   throws Throwable

Revoke global permissions for the specified user.

Parameters:: connection - The Connection instance to use
Throws:: Throwable

getUserPermissions

public static List<UserPermission> getUserPermissions(Connection connection,
                                      String tableRegex)
                                               throws Throwable

List all the userPermissions matching the given pattern.

Parameters:: connection - The Connection instance to use; tableRegex - The regular expression string to match against
Returns:: - returns an array of UserPermissions
Throws:: Throwable

grant

@Deprecated
public static void grant(org.apache.hadoop.conf.Configuration conf,
                    TableName tableName,
                    String userName,
                    byte[] family,
                    byte[] qual,
                    Permission.Action... actions)
                  throws Throwable

Deprecated. Use grant(Connection, TableName, String, byte[], byte[], Permission.Action...) instead.

Grants permission on the specified table for the specified user

Parameters:: conf -; tableName -; userName -; family -; qual -; actions -
Throws:: Throwable

grant

@Deprecated
public static void grant(org.apache.hadoop.conf.Configuration conf,
                    String namespace,
                    String userName,
                    Permission.Action... actions)
                  throws Throwable

Deprecated. Use grant(Connection, String, String, Permission.Action...) instead.

Grants permission on the specified namespace for the specified user.

Parameters:: conf -; namespace -; userName -; actions -
Throws:: Throwable

grant

@Deprecated
public static void grant(org.apache.hadoop.conf.Configuration conf,
                    String userName,
                    Permission.Action... actions)
                  throws Throwable

Deprecated. Use grant(Connection, String, Permission.Action...) instead.

Grant global permissions for the specified user.

Throws:: Throwable

isAccessControllerRunning

@Deprecated
public static boolean isAccessControllerRunning(org.apache.hadoop.conf.Configuration conf)
                                         throws MasterNotRunningException,
                                                ZooKeeperConnectionException,
                                                IOException

Deprecated. Use isAccessControllerRunning(Connection) instead.

Throws:: MasterNotRunningException; ZooKeeperConnectionException; IOException

revoke

@Deprecated
public static void revoke(org.apache.hadoop.conf.Configuration conf,
                     TableName tableName,
                     String username,
                     byte[] family,
                     byte[] qualifier,
                     Permission.Action... actions)
                   throws Throwable

Deprecated. Use revoke(Connection, TableName, String, byte[], byte[], Permission.Action...) instead.

Revokes the permission on the table

Parameters:: conf -; tableName -; username -; family -; qualifier -; actions -
Throws:: Throwable

revoke

@Deprecated
public static void revoke(org.apache.hadoop.conf.Configuration conf,
                     String namespace,
                     String userName,
                     Permission.Action... actions)
                   throws Throwable

Deprecated. Use revoke(Connection, String, String, Permission.Action...) instead.

Revokes the permission on the table for the specified user.

Parameters:: conf -; namespace -; userName -; actions -
Throws:: Throwable

revoke

@Deprecated
public static void revoke(org.apache.hadoop.conf.Configuration conf,
                     String userName,
                     Permission.Action... actions)
                   throws Throwable

Deprecated. Use revoke(Connection, String, Permission.Action...) instead.

Revoke global permissions for the specified user.

Throws:: Throwable

getUserPermissions
```
@Deprecated
public static List<UserPermission> getUserPermissions(org.apache.hadoop.conf.Configuration conf,
                                                 String tableRegex)
                                               throws Throwable
```
Deprecated. Use getUserPermissions(Connection, String) instead.

List all the userPermissions matching the given pattern. If pattern is null, the behavior is dependent on whether user has global admin privileges or not. If yes, the global permissions along with the list of superusers would be returned. Else, no rows get returned.

Parameters:
conf -
tableRegex - The regular expression string to match against

Returns:
- returns an array of UserPermissions

Throws:

Throwable

Class AccessControlClient

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ACL_TABLE_NAME

Constructor Detail

AccessControlClient

Method Detail

isAuthorizationEnabled

isCellAuthorizationEnabled

grant

grant

grant

grant

grant

grant

isAccessControllerRunning

revoke

revoke

revoke

getUserPermissions

grant

grant

grant

isAccessControllerRunning

revoke

revoke

revoke

getUserPermissions