Package 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

@Public
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, Permission.Builder, Permission.Scope

Field Summary

Fields

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

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

ACTION_BY_CODE, actions, scope, SCOPE_BY_CODE, VERSION

Constructor Summary

Constructors

Constructor	Description
TablePermission(TableName table, byte[] family, byte[] qualifier, Permission.Action... assigned)	Construct a table:family:qualifier permission.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
boolean	equalsExceptActions(Object obj)	Check if two permission equals regardless of actions.
private boolean	failCheckFamily(byte[] family)
private boolean	failCheckQualifier(byte[] qual)
private boolean	failCheckTable(TableName table)
byte[]	getFamily()
String	getNamespace()
byte[]	getQualifier()
TableName	getTableName()
boolean	hasFamily()
int	hashCode()
boolean	hasQualifier()
boolean	implies(TableName table, byte[] family, byte[] qualifier, Permission.Action action)	Check if given action can performs on given table:family:qualifier.
boolean	implies(TableName table, byte[] family, Permission.Action action)	Check if given action can performs on given table:family.
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.
protected String	rawExpression()
void	readFields(DataInput in)
boolean	tableFieldsEqual(TablePermission tp)	Check if fields of table in table permission equals.
String	toString()
void	write(DataOutput out)

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

getAccessScope, getActions, getVersion, implies, newBuilder, newBuilder, newBuilder, setActions

Methods inherited from class java.lang.Object

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

Field Details

table

private TableName table

family

private byte[] family

qualifier

private byte[] qualifier

Constructor Details

TablePermission

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

Construct a table:family:qualifier permission.

Parameters:

table - table name

family - family name

qualifier - qualifier name

assigned - assigned actions

Method Details

getTableName

public TableName getTableName()

hasFamily

public boolean hasFamily()

getFamily

public byte[] getFamily()

hasQualifier

public boolean hasQualifier()

getQualifier

public byte[] getQualifier()

getNamespace

public String getNamespace()

implies

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

Check if given action can performs on given table:family:qualifier.

Parameters:

table - table name

family - family name

qualifier - qualifier name

action - one of [Read, Write, Create, Exec, Admin]

Returns:

true if can, false otherwise

implies

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

Check if given action can performs on given table:family.

Parameters:

table - table name

family - family name

action - one of [Read, Write, Create, Exec, Admin]

Returns:

true if can, false otherwise

failCheckTable

private boolean failCheckTable(TableName table)

failCheckFamily

private boolean failCheckFamily(byte[] family)

failCheckQualifier

private boolean failCheckQualifier(byte[] qual)

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

tableFieldsEqual

public boolean tableFieldsEqual(TablePermission tp)

Check if fields of table in table permission equals.

Parameters:

tp - to be checked table permission

Returns:

true if equals, false otherwise

equalsExceptActions

public boolean equalsExceptActions(Object obj)

Description copied from class: Permission

Check if two permission equals regardless of actions. It is useful when merging a new permission with an existed permission which needs to check two permissions's fields.

Overrides:

equalsExceptActions in class Permission

Parameters:

obj - instance

Returns:

true if equals, false otherwise

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

rawExpression

protected String rawExpression()

Overrides:

rawExpression 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