org.apache.hadoop.hbase.security.access

Class TablePermission

java.lang.Object

org.apache.hadoop.io.VersionedWritable

org.apache.hadoop.hbase.security.access.Permission

org.apache.hadoop.hbase.security.access.TablePermission

All Implemented Interfaces:

org.apache.hadoop.io.Writable

Direct Known Subclasses:

UserPermission

@InterfaceAudience.Private
public class TablePermission
extends Permission

Represents an authorization for access for the given actions, optionally restricted to the given column family or column qualifier, over the given table. If the family property is null, it implies full table access.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.hadoop.hbase.security.access.Permission

Permission.Action

Field Summary

Fields

Modifier and Type	Field and Description
private byte[]	family
private String	namespace
private byte[]	qualifier
private TableName	table

Fields inherited from class org.apache.hadoop.hbase.security.access.Permission

ACTION_BY_CODE, actions, VERSION

Constructor Summary

Constructors

Constructor and Description
TablePermission() Nullary constructor for Writable, do not use
TablePermission(String namespace, byte[] actionCodes) Creates a new permission for the given namespace, allowing the actions matching the provided byte codes to be performed.
TablePermission(String namespace, Permission.Action... assigned) Create a new permission for the given namespace, allowing the given actions.
TablePermission(String namespace, TableName table, byte[] family, byte[] qualifier, byte[] actionCodes) Creates a new permission for the given namespace or table, family and column qualifier, allowing the actions matching the provided byte codes to be performed.
TablePermission(String namespace, TableName table, byte[] family, byte[] qualifier, Permission.Action... assigned) Creates a new permission for the given namespace or table, restricted to the given column family and qualifier, allowing the assigned actions to be performed.
TablePermission(TableName table, byte[] family, byte[] qualifier, byte[] actionCodes) Creates a new permission for the given table, family and column qualifier, allowing the actions matching the provided byte codes to be performed.
TablePermission(TableName table, byte[] family, byte[] qualifier, Permission.Action... assigned) Creates a new permission for the given table, restricted to the given column family and qualifier, allowing the assigned actions to be performed.
TablePermission(TableName table, byte[] family, Permission.Action... assigned) Create a new permission for the given table and (optionally) column family, allowing the given actions.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
byte[]	getFamily()
String	getNamespace()
byte[]	getQualifier()
TableName	getTableName()
boolean	hasFamily()
int	hashCode()
boolean	hasNamespace()
boolean	hasQualifier()
boolean	hasTable()
boolean	implies(String namespace, Permission.Action action) Checks that a given table operation is authorized by this permission instance.
boolean	implies(TableName table, byte[] family, byte[] qualifier, Permission.Action action) Checks that a given table operation is authorized by this permission instance.
boolean	implies(TableName table, KeyValue kv, Permission.Action action) Checks if this permission grants access to perform the given action on the given table and key value.
boolean	matchesFamily(TableName table, byte[] family, Permission.Action action) Returns true if this permission matches the given column family at least.
boolean	matchesFamilyQualifier(TableName table, byte[] family, byte[] qualifier, Permission.Action action) Returns if the given permission matches the given qualifier.
void	readFields(DataInput in)
void	setTableName(TableName table)
boolean	tableFieldsEqual(TablePermission other)
String	toString()
void	write(DataOutput out)

Methods inherited from class org.apache.hadoop.hbase.security.access.Permission

getActions, getVersion, implies, setActions

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

table

private TableName table

family

private byte[] family

qualifier

private byte[] qualifier

namespace

private String namespace

Constructor Detail

TablePermission

public TablePermission()

Nullary constructor for Writable, do not use

TablePermission

public TablePermission(TableName table,
                       byte[] family,
                       Permission.Action... assigned)

Create a new permission for the given table and (optionally) column family, allowing the given actions.

Parameters:

table - the table

family - the family, can be null if a global permission on the table

assigned - the list of allowed actions

TablePermission

public TablePermission(TableName table,
                       byte[] family,
                       byte[] qualifier,
                       Permission.Action... assigned)

Creates a new permission for the given table, restricted to the given column family and qualifier, allowing the assigned actions to be performed.

Parameters:

table - the table

family - the family, can be null if a global permission on the table

assigned - the list of allowed actions

TablePermission

public TablePermission(TableName table,
                       byte[] family,
                       byte[] qualifier,
                       byte[] actionCodes)

Creates a new permission for the given table, family and column qualifier, allowing the actions matching the provided byte codes to be performed.

Parameters:

table - the table

family - the family, can be null if a global permission on the table

actionCodes - the list of allowed action codes

TablePermission

public TablePermission(String namespace,
                       TableName table,
                       byte[] family,
                       byte[] qualifier,
                       Permission.Action... assigned)

Creates a new permission for the given namespace or table, restricted to the given column family and qualifier, allowing the assigned actions to be performed.

Parameters:

namespace -

table - the table

family - the family, can be null if a global permission on the table

assigned - the list of allowed actions

TablePermission

public TablePermission(String namespace,
                       TableName table,
                       byte[] family,
                       byte[] qualifier,
                       byte[] actionCodes)

Creates a new permission for the given namespace or table, family and column qualifier, allowing the actions matching the provided byte codes to be performed.

Parameters:

namespace -

table - the table

family - the family, can be null if a global permission on the table

actionCodes - the list of allowed action codes

TablePermission

public TablePermission(String namespace,
                       byte[] actionCodes)

Creates a new permission for the given namespace, allowing the actions matching the provided byte codes to be performed.

Parameters:

namespace -

actionCodes - the list of allowed action codes

TablePermission

public TablePermission(String namespace,
                       Permission.Action... assigned)

Create a new permission for the given namespace, allowing the given actions.

Parameters:

namespace -

assigned - the list of allowed actions

Method Detail

hasTable

public boolean hasTable()

getTableName

public TableName getTableName()

setTableName

public void setTableName(TableName table)

hasFamily

public boolean hasFamily()

getFamily

public byte[] getFamily()

hasQualifier

public boolean hasQualifier()

getQualifier

public byte[] getQualifier()

hasNamespace

public boolean hasNamespace()

getNamespace

public String getNamespace()

implies

public boolean implies(String namespace,
                       Permission.Action action)

Checks that a given table operation is authorized by this permission instance.

Parameters:

namespace - the namespace where the operation is being performed

action - the action being requested

Returns:

true if the action within the given scope is allowed by this permission, false

implies

public boolean implies(TableName table,
                       byte[] family,
                       byte[] qualifier,
                       Permission.Action action)

Checks that a given table operation is authorized by this permission instance.

Parameters:

table - the table where the operation is being performed

family - the column family to which the operation is restricted, if null implies "all"

qualifier - the column qualifier to which the action is restricted, if null implies "all"

action - the action being requested

Returns:

true if the action within the given scope is allowed by this permission, false

implies

public boolean implies(TableName table,
                       KeyValue kv,
                       Permission.Action action)

Checks if this permission grants access to perform the given action on the given table and key value.

Parameters:

table - the table on which the operation is being performed

kv - the KeyValue on which the operation is being requested

action - the action requested

Returns:

true if the action is allowed over the given scope by this permission, otherwise false

matchesFamily

public boolean matchesFamily(TableName table,
                             byte[] family,
                             Permission.Action action)

Returns true if this permission matches the given column family at least. This only indicates a partial match against the table and column family, however, and does not guarantee that implies() for the column same family would return true. In the case of a column-qualifier specific permission, for example, implies() would still return false.

matchesFamilyQualifier

public boolean matchesFamilyQualifier(TableName table,
                                      byte[] family,
                                      byte[] qualifier,
                                      Permission.Action action)

Returns if the given permission matches the given qualifier.

Parameters:

table - the table name to match

family - the column family to match

qualifier - the qualifier name to match

action - the action requested

Returns:

true if the table, family and qualifier match, otherwise false

tableFieldsEqual

public boolean tableFieldsEqual(TablePermission other)

equals

public boolean equals(Object obj)

Overrides:

equals in class Permission

hashCode

public int hashCode()

Overrides:

hashCode in class Permission

toString

public String toString()

Overrides:

toString in class Permission

readFields

public void readFields(DataInput in)
                throws IOException

Specified by:

readFields in interface org.apache.hadoop.io.Writable

Overrides:

readFields in class Permission

Throws:

IOException

write

public void write(DataOutput out)
           throws IOException

Specified by:

write in interface org.apache.hadoop.io.Writable

Overrides:

write in class Permission

Throws:

IOException