Package org.apache.hadoop.hbase.security.access

Class Permission

java.lang.Object

org.apache.hadoop.io.VersionedWritable

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

All Implemented Interfaces:

org.apache.hadoop.io.Writable

Direct Known Subclasses:

GlobalPermission, NamespacePermission, TablePermission

@Public
public class Permission
extends org.apache.hadoop.io.VersionedWritable

Base permissions instance representing the ability to perform a given set of actions.

See Also:

• TablePermission

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Permission.Action
static final class	Permission.Builder
protected static enum	Permission.Scope

Field Summary

Fields

Modifier and Type	Field	Description
protected static final Map<Byte,Permission.Action>	ACTION_BY_CODE
protected EnumSet<Permission.Action>	actions
private static final org.slf4j.Logger	LOG
protected Permission.Scope	scope
protected static final Map<Byte,Permission.Scope>	SCOPE_BY_CODE
protected static final byte	VERSION

Constructor Summary

Constructors

Constructor	Description
Permission()	Empty constructor for Writable implementation.
Permission(byte[] actionCodes)
Permission(Permission.Action... assigned)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
boolean	equalsExceptActions(Object obj)	Check if two permission equals regardless of actions.
Permission.Scope	getAccessScope()
Permission.Action[]	getActions()
byte	getVersion()	Returns the object version number
int	hashCode()
boolean	implies(Permission.Action action)	check if given action is granted
static Permission.Builder	newBuilder()	Build a global permission
static Permission.Builder	newBuilder(String namespace)	Build a namespace permission
static Permission.Builder	newBuilder(TableName tableName)	Build a table permission
protected String	rawExpression()
void	readFields(DataInput in)
void	setActions(Permission.Action[] assigned)
String	toString()
void	write(DataOutput out)

Methods inherited from class java.lang.Object

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

Field Details

VERSION

protected static final byte VERSION

See Also:

• Constant Field Values

LOG

private static final org.slf4j.Logger LOG

ACTION_BY_CODE

protected static final Map<Byte,Permission.Action> ACTION_BY_CODE

SCOPE_BY_CODE

protected static final Map<Byte,Permission.Scope> SCOPE_BY_CODE

actions

protected EnumSet<Permission.Action> actions

scope

protected Permission.Scope scope

Constructor Details

Permission

public Permission()

Empty constructor for Writable implementation. Do not use.

Permission

public Permission(Permission.Action... assigned)

Permission

public Permission(byte[] actionCodes)

Method Details

getActions

public Permission.Action[] getActions()

implies

public boolean implies(Permission.Action action)

check if given action is granted

Parameters:

action - action to be checked

Returns:

true if granted, false otherwise

setActions

public void setActions(Permission.Action[] assigned)

equalsExceptActions

public boolean equalsExceptActions(Object obj)

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.

Parameters:

obj - instance

Returns:

true if equals, false otherwise

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

rawExpression

protected String rawExpression()

getVersion

public byte getVersion()

Returns the object version number

Specified by:

getVersion in class org.apache.hadoop.io.VersionedWritable

readFields

public void readFields(DataInput in)
                throws IOException

Specified by:

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

Overrides:

readFields in class org.apache.hadoop.io.VersionedWritable

Throws:

IOException

write

public void write(DataOutput out)
           throws IOException

Specified by:

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

Overrides:

write in class org.apache.hadoop.io.VersionedWritable

Throws:

IOException

getAccessScope

public Permission.Scope getAccessScope()

newBuilder

public static Permission.Builder newBuilder()

Build a global permission

Returns:

global permission builder

newBuilder

public static Permission.Builder newBuilder(String namespace)

Build a namespace permission

Parameters:

namespace - the specific namespace

Returns:

namespace permission builder

newBuilder

public static Permission.Builder newBuilder(TableName tableName)

Build a table permission

Parameters:

tableName - the specific table name

Returns:

table permission builder