org.apache.hadoop.hbase.security.access

Class AuthResult

java.lang.Object

org.apache.hadoop.hbase.security.access.AuthResult

@InterfaceAudience.Private
public class AuthResult
extends Object

Represents the result of an authorization check for logging and error reporting.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AuthResult.Params

Constructor Summary

Constructors

Constructor and Description
AuthResult(boolean allowed, String request, String reason, org.apache.hadoop.hbase.security.User user, org.apache.hadoop.hbase.security.access.Permission.Action action, String namespace)
AuthResult(boolean allowed, String request, String reason, org.apache.hadoop.hbase.security.User user, org.apache.hadoop.hbase.security.access.Permission.Action action, org.apache.hadoop.hbase.TableName table, byte[] family, byte[] qualifier)
AuthResult(boolean allowed, String request, String reason, org.apache.hadoop.hbase.security.User user, org.apache.hadoop.hbase.security.access.Permission.Action action, org.apache.hadoop.hbase.TableName table, Map<byte[],? extends Collection<?>> families)

Method Summary

Modifier and Type	Method and Description
static AuthResult	allow(String request, String reason, org.apache.hadoop.hbase.security.User user, org.apache.hadoop.hbase.security.access.Permission.Action action, String namespace)
static AuthResult	allow(String request, String reason, org.apache.hadoop.hbase.security.User user, org.apache.hadoop.hbase.security.access.Permission.Action action, org.apache.hadoop.hbase.TableName table, byte[] family, byte[] qualifier)
static AuthResult	allow(String request, String reason, org.apache.hadoop.hbase.security.User user, org.apache.hadoop.hbase.security.access.Permission.Action action, org.apache.hadoop.hbase.TableName table, Map<byte[],? extends Collection<?>> families)
static AuthResult	deny(String request, String reason, org.apache.hadoop.hbase.security.User user, org.apache.hadoop.hbase.security.access.Permission.Action action, String namespace)
static AuthResult	deny(String request, String reason, org.apache.hadoop.hbase.security.User user, org.apache.hadoop.hbase.security.access.Permission.Action action, org.apache.hadoop.hbase.TableName table, byte[] family, byte[] qualifier)
static AuthResult	deny(String request, String reason, org.apache.hadoop.hbase.security.User user, org.apache.hadoop.hbase.security.access.Permission.Action action, org.apache.hadoop.hbase.TableName table, Map<byte[],? extends Collection<?>> families)
org.apache.hadoop.hbase.security.access.Permission.Action	getAction()
byte[]	getFamily()
AuthResult.Params	getParams()
byte[]	getQualifier()
String	getReason()
String	getRequest()
org.apache.hadoop.hbase.TableName	getTableName()
org.apache.hadoop.hbase.security.User	getUser()
boolean	isAllowed()
void	setAllowed(boolean allowed)
void	setReason(String reason)
String	toContextString()
String	toFamilyString()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthResult

public AuthResult(boolean allowed,
                  String request,
                  String reason,
                  org.apache.hadoop.hbase.security.User user,
                  org.apache.hadoop.hbase.security.access.Permission.Action action,
                  org.apache.hadoop.hbase.TableName table,
                  byte[] family,
                  byte[] qualifier)

AuthResult

public AuthResult(boolean allowed,
                  String request,
                  String reason,
                  org.apache.hadoop.hbase.security.User user,
                  org.apache.hadoop.hbase.security.access.Permission.Action action,
                  org.apache.hadoop.hbase.TableName table,
                  Map<byte[],? extends Collection<?>> families)

AuthResult

public AuthResult(boolean allowed,
                  String request,
                  String reason,
                  org.apache.hadoop.hbase.security.User user,
                  org.apache.hadoop.hbase.security.access.Permission.Action action,
                  String namespace)

Method Detail

isAllowed

public boolean isAllowed()

getUser

public org.apache.hadoop.hbase.security.User getUser()

getReason

public String getReason()

getTableName

public org.apache.hadoop.hbase.TableName getTableName()

getFamily

public byte[] getFamily()

getQualifier

public byte[] getQualifier()

getAction

public org.apache.hadoop.hbase.security.access.Permission.Action getAction()

getRequest

public String getRequest()

getParams

public AuthResult.Params getParams()

setAllowed

public void setAllowed(boolean allowed)

setReason

public void setReason(String reason)

toContextString

public String toContextString()

toString

public String toString()

Overrides:

toString in class Object

allow

public static AuthResult allow(String request,
                               String reason,
                               org.apache.hadoop.hbase.security.User user,
                               org.apache.hadoop.hbase.security.access.Permission.Action action,
                               String namespace)

allow

public static AuthResult allow(String request,
                               String reason,
                               org.apache.hadoop.hbase.security.User user,
                               org.apache.hadoop.hbase.security.access.Permission.Action action,
                               org.apache.hadoop.hbase.TableName table,
                               byte[] family,
                               byte[] qualifier)

allow

public static AuthResult allow(String request,
                               String reason,
                               org.apache.hadoop.hbase.security.User user,
                               org.apache.hadoop.hbase.security.access.Permission.Action action,
                               org.apache.hadoop.hbase.TableName table,
                               Map<byte[],? extends Collection<?>> families)

deny

public static AuthResult deny(String request,
                              String reason,
                              org.apache.hadoop.hbase.security.User user,
                              org.apache.hadoop.hbase.security.access.Permission.Action action,
                              String namespace)

deny

public static AuthResult deny(String request,
                              String reason,
                              org.apache.hadoop.hbase.security.User user,
                              org.apache.hadoop.hbase.security.access.Permission.Action action,
                              org.apache.hadoop.hbase.TableName table,
                              byte[] family,
                              byte[] qualifier)

deny

public static AuthResult deny(String request,
                              String reason,
                              org.apache.hadoop.hbase.security.User user,
                              org.apache.hadoop.hbase.security.access.Permission.Action action,
                              org.apache.hadoop.hbase.TableName table,
                              Map<byte[],? extends Collection<?>> families)

toFamilyString

public String toFamilyString()