org.apache.hadoop.hbase.security.access

Class AccessControlUtil

java.lang.Object

org.apache.hadoop.hbase.security.access.AccessControlUtil

@InterfaceAudience.Private
public class AccessControlUtil
extends Object

Since:

2.0.0

Constructor Summary

Constructors

Modifier	Constructor and Description
private	AccessControlUtil()

Method Summary

Modifier and Type	Method and Description
static org.apache.hadoop.hbase.protobuf.generated.AccessControlProtos.GetUserPermissionsResponse	buildGetUserPermissionsResponse(List<UserPermission> permissions) Converts the permissions list into a protocol buffer GetUserPermissionsResponse
static org.apache.hadoop.hbase.protobuf.generated.AccessControlProtos.GrantRequest	buildGrantRequest(String username, boolean mergeExistingPermissions, org.apache.hadoop.hbase.protobuf.generated.AccessControlProtos.Permission.Action... actions) Create a request to grant user permissions.
static org.apache.hadoop.hbase.protobuf.generated.AccessControlProtos.GrantRequest	buildGrantRequest(String username, String namespace, boolean mergeExistingPermissions, org.apache.hadoop.hbase.protobuf.generated.AccessControlProtos.Permission.Action... actions) Create a request to grant user permissions.
static org.apache.hadoop.hbase.protobuf.generated.AccessControlProtos.GrantRequest	buildGrantRequest(String username, TableName tableName, byte[] family, byte[] qualifier, boolean mergeExistingPermissions, org.apache.hadoop.hbase.protobuf.generated.AccessControlProtos.Permission.Action... actions) Create a request to grant user permissions.
static org.apache.hadoop.hbase.protobuf.generated.AccessControlProtos.RevokeRequest	buildRevokeRequest(String username, org.apache.hadoop.hbase.protobuf.generated.AccessControlProtos.Permission.Action... actions) Create a request to revoke user permissions.
static org.apache.hadoop.hbase.protobuf.generated.AccessControlProtos.RevokeRequest	buildRevokeRequest(String username, String namespace, org.apache.hadoop.hbase.protobuf.generated.AccessControlProtos.Permission.Action... actions) Create a request to revoke user permissions.
static org.apache.hadoop.hbase.protobuf.generated.AccessControlProtos.RevokeRequest	buildRevokeRequest(String username, TableName tableName, byte[] family, byte[] qualifier, org.apache.hadoop.hbase.protobuf.generated.AccessControlProtos.Permission.Action... actions) Create a request to revoke user permissions.
static List<UserPermission>	getUserPermissions(com.google.protobuf.RpcController controller, org.apache.hadoop.hbase.protobuf.generated.AccessControlProtos.AccessControlService.BlockingInterface protocol) A utility used to get user's global permissions.
static List<UserPermission>	getUserPermissions(com.google.protobuf.RpcController controller, org.apache.hadoop.hbase.protobuf.generated.AccessControlProtos.AccessControlService.BlockingInterface protocol, byte[] namespace) A utility used to get permissions for selected namespace.
static List<UserPermission>	getUserPermissions(com.google.protobuf.RpcController controller, org.apache.hadoop.hbase.protobuf.generated.AccessControlProtos.AccessControlService.BlockingInterface protocol, TableName t) A utility used to get user table permissions.
static void	grant(com.google.protobuf.RpcController controller, org.apache.hadoop.hbase.protobuf.generated.AccessControlProtos.AccessControlService.BlockingInterface protocol, String userShortName, boolean mergeExistingPermissions, Permission.Action... actions) A utility used to grant a user global permissions.
static void	grant(com.google.protobuf.RpcController controller, org.apache.hadoop.hbase.protobuf.generated.AccessControlProtos.AccessControlService.BlockingInterface protocol, String userShortName, String namespace, boolean mergeExistingPermissions, Permission.Action... actions) A utility used to grant a user namespace permissions.
static void	grant(com.google.protobuf.RpcController controller, org.apache.hadoop.hbase.protobuf.generated.AccessControlProtos.AccessControlService.BlockingInterface protocol, String userShortName, TableName tableName, byte[] f, byte[] q, boolean mergeExistingPermissions, Permission.Action... actions) A utility used to grant a user table permissions.
static void	revoke(com.google.protobuf.RpcController controller, org.apache.hadoop.hbase.protobuf.generated.AccessControlProtos.AccessControlService.BlockingInterface protocol, String userShortName, Permission.Action... actions) A utility used to revoke a user's global permissions.
static void	revoke(com.google.protobuf.RpcController controller, org.apache.hadoop.hbase.protobuf.generated.AccessControlProtos.AccessControlService.BlockingInterface protocol, String userShortName, String namespace, Permission.Action... actions) A utility used to revoke a user's namespace permissions.
static void	revoke(com.google.protobuf.RpcController controller, org.apache.hadoop.hbase.protobuf.generated.AccessControlProtos.AccessControlService.BlockingInterface protocol, String userShortName, TableName tableName, byte[] f, byte[] q, Permission.Action... actions) A utility used to revoke a user's table permissions.
static Permission	toPermission(org.apache.hadoop.hbase.protobuf.generated.AccessControlProtos.Permission proto) Converts a Permission proto to a client Permission object.
static org.apache.hadoop.hbase.protobuf.generated.AccessControlProtos.Permission	toPermission(Permission perm) Convert a client Permission to a Permission proto
static Permission.Action	toPermissionAction(org.apache.hadoop.hbase.protobuf.generated.AccessControlProtos.Permission.Action action) Converts a Permission.Action proto to a client Permission.Action object.
static org.apache.hadoop.hbase.protobuf.generated.AccessControlProtos.Permission.Action	toPermissionAction(Permission.Action action) Convert a client Permission.Action to a Permission.Action proto
static List<Permission.Action>	toPermissionActions(List<org.apache.hadoop.hbase.protobuf.generated.AccessControlProtos.Permission.Action> protoActions) Converts a list of Permission.Action proto to a list of client Permission.Action objects.
static TablePermission	toTablePermission(org.apache.hadoop.hbase.protobuf.generated.AccessControlProtos.Permission proto) Converts a Permission proto to a client TablePermission object.
static UserPermission	toUserPermission(org.apache.hadoop.hbase.protobuf.generated.AccessControlProtos.UserPermission proto) Converts a user permission proto to a client user permission object.
static org.apache.hadoop.hbase.protobuf.generated.AccessControlProtos.UserPermission	toUserPermission(UserPermission perm) Convert a client user permission to a user permission proto
static org.apache.hbase.thirdparty.com.google.common.collect.ListMultimap<String,Permission>	toUsersAndPermissions(org.apache.hadoop.hbase.protobuf.generated.AccessControlProtos.UsersAndPermissions proto)
static org.apache.hadoop.hbase.protobuf.generated.AccessControlProtos.UsersAndPermissions	toUsersAndPermissions(org.apache.hbase.thirdparty.com.google.common.collect.ListMultimap<String,Permission> perms)
static org.apache.hadoop.hbase.protobuf.generated.AccessControlProtos.UsersAndPermissions	toUsersAndPermissions(String user, Permission perms)
static org.apache.hbase.thirdparty.com.google.common.collect.ListMultimap<String,TablePermission>	toUserTablePermissions(org.apache.hadoop.hbase.protobuf.generated.AccessControlProtos.UsersAndPermissions proto) Convert a protobuf UserTablePermissions to a ListMultimap<String, TablePermission> where key is username.
static org.apache.hadoop.hbase.protobuf.generated.AccessControlProtos.UsersAndPermissions	toUserTablePermissions(org.apache.hbase.thirdparty.com.google.common.collect.ListMultimap<String,TablePermission> perm) Convert a ListMultimap<String, TablePermission> where key is username to a protobuf UserPermission

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AccessControlUtil

private AccessControlUtil()

Method Detail

buildGrantRequest

public static org.apache.hadoop.hbase.protobuf.generated.AccessControlProtos.GrantRequest buildGrantRequest(String username,
                                                                                                            TableName tableName,
                                                                                                            byte[] family,
                                                                                                            byte[] qualifier,
                                                                                                            boolean mergeExistingPermissions,
                                                                                                            org.apache.hadoop.hbase.protobuf.generated.AccessControlProtos.Permission.Action... actions)

Create a request to grant user permissions.

Parameters:

username - the short user name who to grant permissions

tableName - optional table name the permissions apply

family - optional column family

qualifier - optional qualifier

actions - the permissions to be granted

Returns:

A AccessControlProtos GrantRequest

buildGrantRequest

public static org.apache.hadoop.hbase.protobuf.generated.AccessControlProtos.GrantRequest buildGrantRequest(String username,
                                                                                                            String namespace,
                                                                                                            boolean mergeExistingPermissions,
                                                                                                            org.apache.hadoop.hbase.protobuf.generated.AccessControlProtos.Permission.Action... actions)

Create a request to grant user permissions.

Parameters:

username - the short user name who to grant permissions

namespace - optional table name the permissions apply

actions - the permissions to be granted

Returns:

A AccessControlProtos GrantRequest

buildRevokeRequest

public static org.apache.hadoop.hbase.protobuf.generated.AccessControlProtos.RevokeRequest buildRevokeRequest(String username,
                                                                                                              org.apache.hadoop.hbase.protobuf.generated.AccessControlProtos.Permission.Action... actions)

Create a request to revoke user permissions.

Parameters:

username - the short user name whose permissions to be revoked

actions - the permissions to be revoked

Returns:

A AccessControlProtos RevokeRequest

buildRevokeRequest

public static org.apache.hadoop.hbase.protobuf.generated.AccessControlProtos.RevokeRequest buildRevokeRequest(String username,
                                                                                                              String namespace,
                                                                                                              org.apache.hadoop.hbase.protobuf.generated.AccessControlProtos.Permission.Action... actions)

Create a request to revoke user permissions.

Parameters:

username - the short user name whose permissions to be revoked

namespace - optional table name the permissions apply

actions - the permissions to be revoked

Returns:

A AccessControlProtos RevokeRequest

buildGrantRequest

public static org.apache.hadoop.hbase.protobuf.generated.AccessControlProtos.GrantRequest buildGrantRequest(String username,
                                                                                                            boolean mergeExistingPermissions,
                                                                                                            org.apache.hadoop.hbase.protobuf.generated.AccessControlProtos.Permission.Action... actions)

Create a request to grant user permissions.

Parameters:

username - the short user name who to grant permissions

actions - the permissions to be granted

Returns:

A AccessControlProtos GrantRequest

toUsersAndPermissions

public static org.apache.hadoop.hbase.protobuf.generated.AccessControlProtos.UsersAndPermissions toUsersAndPermissions(String user,
                                                                                                                       Permission perms)

toUsersAndPermissions

public static org.apache.hadoop.hbase.protobuf.generated.AccessControlProtos.UsersAndPermissions toUsersAndPermissions(org.apache.hbase.thirdparty.com.google.common.collect.ListMultimap<String,Permission> perms)

toUsersAndPermissions

public static org.apache.hbase.thirdparty.com.google.common.collect.ListMultimap<String,Permission> toUsersAndPermissions(org.apache.hadoop.hbase.protobuf.generated.AccessControlProtos.UsersAndPermissions proto)

toPermission

public static Permission toPermission(org.apache.hadoop.hbase.protobuf.generated.AccessControlProtos.Permission proto)

Converts a Permission proto to a client Permission object.

Parameters:

proto - the protobuf Permission

Returns:

the converted Permission

toTablePermission

public static TablePermission toTablePermission(org.apache.hadoop.hbase.protobuf.generated.AccessControlProtos.Permission proto)

Converts a Permission proto to a client TablePermission object.

Parameters:

proto - the protobuf Permission

Returns:

the converted TablePermission

toPermission

public static org.apache.hadoop.hbase.protobuf.generated.AccessControlProtos.Permission toPermission(Permission perm)

Convert a client Permission to a Permission proto

Parameters:

perm - the client Permission

Returns:

the protobuf Permission

toPermissionActions

public static List<Permission.Action> toPermissionActions(List<org.apache.hadoop.hbase.protobuf.generated.AccessControlProtos.Permission.Action> protoActions)

Converts a list of Permission.Action proto to a list of client Permission.Action objects.

Parameters:

protoActions - the list of protobuf Actions

Returns:

the converted list of Actions

toPermissionAction

public static Permission.Action toPermissionAction(org.apache.hadoop.hbase.protobuf.generated.AccessControlProtos.Permission.Action action)

Converts a Permission.Action proto to a client Permission.Action object.

Parameters:

action - the protobuf Action

Returns:

the converted Action

toPermissionAction

public static org.apache.hadoop.hbase.protobuf.generated.AccessControlProtos.Permission.Action toPermissionAction(Permission.Action action)

Convert a client Permission.Action to a Permission.Action proto

Parameters:

action - the client Action

Returns:

the protobuf Action

toUserPermission

public static org.apache.hadoop.hbase.protobuf.generated.AccessControlProtos.UserPermission toUserPermission(UserPermission perm)

Convert a client user permission to a user permission proto

Parameters:

perm - the client UserPermission

Returns:

the protobuf UserPermission

buildGetUserPermissionsResponse

public static org.apache.hadoop.hbase.protobuf.generated.AccessControlProtos.GetUserPermissionsResponse buildGetUserPermissionsResponse(List<UserPermission> permissions)

Converts the permissions list into a protocol buffer GetUserPermissionsResponse

toUserPermission

public static UserPermission toUserPermission(org.apache.hadoop.hbase.protobuf.generated.AccessControlProtos.UserPermission proto)

Converts a user permission proto to a client user permission object.

Parameters:

proto - the protobuf UserPermission

Returns:

the converted UserPermission

toUserTablePermissions

public static org.apache.hadoop.hbase.protobuf.generated.AccessControlProtos.UsersAndPermissions toUserTablePermissions(org.apache.hbase.thirdparty.com.google.common.collect.ListMultimap<String,TablePermission> perm)

Convert a ListMultimap<String, TablePermission> where key is username to a protobuf UserPermission

Parameters:

perm - the list of user and table permissions

Returns:

the protobuf UserTablePermissions

grant

public static void grant(com.google.protobuf.RpcController controller,
                         org.apache.hadoop.hbase.protobuf.generated.AccessControlProtos.AccessControlService.BlockingInterface protocol,
                         String userShortName,
                         boolean mergeExistingPermissions,
                         Permission.Action... actions)
                  throws com.google.protobuf.ServiceException

A utility used to grant a user global permissions.

It's also called by the shell, in case you want to find references.

Parameters:

protocol - the AccessControlService protocol proxy

userShortName - the short name of the user to grant permissions

actions - the permissions to be granted

Throws:

com.google.protobuf.ServiceException

grant

public static void grant(com.google.protobuf.RpcController controller,
                         org.apache.hadoop.hbase.protobuf.generated.AccessControlProtos.AccessControlService.BlockingInterface protocol,
                         String userShortName,
                         TableName tableName,
                         byte[] f,
                         byte[] q,
                         boolean mergeExistingPermissions,
                         Permission.Action... actions)
                  throws com.google.protobuf.ServiceException

A utility used to grant a user table permissions. The permissions will be for a table table/column family/qualifier.

It's also called by the shell, in case you want to find references.

Parameters:

protocol - the AccessControlService protocol proxy

userShortName - the short name of the user to grant permissions

tableName - optional table name

f - optional column family

q - optional qualifier

actions - the permissions to be granted

Throws:

com.google.protobuf.ServiceException

grant

public static void grant(com.google.protobuf.RpcController controller,
                         org.apache.hadoop.hbase.protobuf.generated.AccessControlProtos.AccessControlService.BlockingInterface protocol,
                         String userShortName,
                         String namespace,
                         boolean mergeExistingPermissions,
                         Permission.Action... actions)
                  throws com.google.protobuf.ServiceException

A utility used to grant a user namespace permissions.

It's also called by the shell, in case you want to find references.

Parameters:

protocol - the AccessControlService protocol proxy

namespace - the short name of the user to grant permissions

actions - the permissions to be granted

Throws:

com.google.protobuf.ServiceException

revoke

public static void revoke(com.google.protobuf.RpcController controller,
                          org.apache.hadoop.hbase.protobuf.generated.AccessControlProtos.AccessControlService.BlockingInterface protocol,
                          String userShortName,
                          Permission.Action... actions)
                   throws com.google.protobuf.ServiceException

A utility used to revoke a user's global permissions.

It's also called by the shell, in case you want to find references.

Parameters:

protocol - the AccessControlService protocol proxy

userShortName - the short name of the user to revoke permissions

actions - the permissions to be revoked

Throws:

com.google.protobuf.ServiceException

revoke

public static void revoke(com.google.protobuf.RpcController controller,
                          org.apache.hadoop.hbase.protobuf.generated.AccessControlProtos.AccessControlService.BlockingInterface protocol,
                          String userShortName,
                          TableName tableName,
                          byte[] f,
                          byte[] q,
                          Permission.Action... actions)
                   throws com.google.protobuf.ServiceException

A utility used to revoke a user's table permissions. The permissions will be for a table/column family/qualifier.

It's also called by the shell, in case you want to find references.

Parameters:

protocol - the AccessControlService protocol proxy

userShortName - the short name of the user to revoke permissions

tableName - optional table name

f - optional column family

q - optional qualifier

actions - the permissions to be revoked

Throws:

com.google.protobuf.ServiceException

revoke

public static void revoke(com.google.protobuf.RpcController controller,
                          org.apache.hadoop.hbase.protobuf.generated.AccessControlProtos.AccessControlService.BlockingInterface protocol,
                          String userShortName,
                          String namespace,
                          Permission.Action... actions)
                   throws com.google.protobuf.ServiceException

A utility used to revoke a user's namespace permissions.

It's also called by the shell, in case you want to find references.

Parameters:

protocol - the AccessControlService protocol proxy

userShortName - the short name of the user to revoke permissions

namespace - optional table name

actions - the permissions to be revoked

Throws:

com.google.protobuf.ServiceException

getUserPermissions

public static List<UserPermission> getUserPermissions(com.google.protobuf.RpcController controller,
                                                      org.apache.hadoop.hbase.protobuf.generated.AccessControlProtos.AccessControlService.BlockingInterface protocol)
                                               throws com.google.protobuf.ServiceException

A utility used to get user's global permissions.

It's also called by the shell, in case you want to find references.

Parameters:

protocol - the AccessControlService protocol proxy

Throws:

com.google.protobuf.ServiceException

getUserPermissions

public static List<UserPermission> getUserPermissions(com.google.protobuf.RpcController controller,
                                                      org.apache.hadoop.hbase.protobuf.generated.AccessControlProtos.AccessControlService.BlockingInterface protocol,
                                                      TableName t)
                                               throws com.google.protobuf.ServiceException

A utility used to get user table permissions.

It's also called by the shell, in case you want to find references.

Parameters:

protocol - the AccessControlService protocol proxy

t - optional table name

Throws:

com.google.protobuf.ServiceException

getUserPermissions

public static List<UserPermission> getUserPermissions(com.google.protobuf.RpcController controller,
                                                      org.apache.hadoop.hbase.protobuf.generated.AccessControlProtos.AccessControlService.BlockingInterface protocol,
                                                      byte[] namespace)
                                               throws com.google.protobuf.ServiceException

A utility used to get permissions for selected namespace.

It's also called by the shell, in case you want to find references.

Parameters:

protocol - the AccessControlService protocol proxy

namespace - name of the namespace

Throws:

com.google.protobuf.ServiceException

toUserTablePermissions

public static org.apache.hbase.thirdparty.com.google.common.collect.ListMultimap<String,TablePermission> toUserTablePermissions(org.apache.hadoop.hbase.protobuf.generated.AccessControlProtos.UsersAndPermissions proto)

Convert a protobuf UserTablePermissions to a ListMultimap<String, TablePermission> where key is username.

Parameters:

proto - the protobuf UserPermission

Returns:

the converted UserPermission

buildRevokeRequest

public static org.apache.hadoop.hbase.protobuf.generated.AccessControlProtos.RevokeRequest buildRevokeRequest(String username,
                                                                                                              TableName tableName,
                                                                                                              byte[] family,
                                                                                                              byte[] qualifier,
                                                                                                              org.apache.hadoop.hbase.protobuf.generated.AccessControlProtos.Permission.Action... actions)

Create a request to revoke user permissions.

Parameters:

username - the short user name whose permissions to be revoked

tableName - optional table name the permissions apply

family - optional column family

qualifier - optional qualifier

actions - the permissions to be revoked

Returns:

A AccessControlProtos RevokeRequest