AuthResult (Apache HBase 1.2.12 API)

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

Nested Classes
Modifier and Type	Class and Description
`static class`	`AuthResult.Params`

Field Summary

Fields
Modifier and Type	Field and Description
`private Permission.Action`	`action`
`private boolean`	`allowed`
`private Map<byte[],? extends Collection<?>>`	`families`
`private byte[]`	`family`
`private String`	`namespace`
`private AuthResult.Params`	`params`
`private byte[]`	`qualifier`
`private String`	`reason`
`private String`	`request`
`private TableName`	`table`
`private User`	`user`

Constructor Summary

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

Method Summary

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

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

allowed
```
private boolean allowed
```

namespace
```
private final String namespace
```

table
```
private final TableName table
```

action
```
private final Permission.Action action
```

request
```
private final String request
```

reason
```
private String reason
```

user
```
private final User user
```

params
```
private AuthResult.Params params
```

family
```
private final byte[] family
```

qualifier
```
private final byte[] qualifier
```

families

private final Map<byte[],? extends Collection<?>> families

Constructor Detail

AuthResult

public AuthResult(boolean allowed,
          String request,
          String reason,
          User user,
          Permission.Action action,
          TableName table,
          byte[] family,
          byte[] qualifier)

AuthResult

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

AuthResult

public AuthResult(boolean allowed,
          String request,
          String reason,
          User user,
          Permission.Action action,
          String namespace)

Method Detail

isAllowed
```
public boolean isAllowed()
```

getUser
```
public User getUser()
```

getReason
```
public String getReason()
```

getTableName
```
public TableName getTableName()
```

getFamily
```
public byte[] getFamily()
```

getQualifier
```
public byte[] getQualifier()
```

getAction
```
public Permission.Action getAction()
```

getRequest
```
public String getRequest()
```

getParams
```
public AuthResult.Params getParams()
```

setAllowed

public void setAllowed(boolean allowed)

setReason
```
public void setReason(String reason)
```

toFamiliesString

private static String toFamiliesString(Map<byte[],? extends Collection<?>> families,
                      byte[] family,
                      byte[] qual)

toContextString
```
public String toContextString()
```

toString
```
public String toString()
```
Overrides:

toString in class Object

allow

public static AuthResult allow(String request,
               String reason,
               User user,
               Permission.Action action,
               String namespace)

allow

public static AuthResult allow(String request,
               String reason,
               User user,
               Permission.Action action,
               TableName table,
               byte[] family,
               byte[] qualifier)

allow

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

deny

public static AuthResult deny(String request,
              String reason,
              User user,
              Permission.Action action,
              String namespace)

deny

public static AuthResult deny(String request,
              String reason,
              User user,
              Permission.Action action,
              TableName table,
              byte[] family,
              byte[] qualifier)

deny

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

toFamilyString
```
public String toFamilyString()
```

Class AuthResult

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

allowed

namespace

table

action

request

reason

user

params

family

qualifier

families

Constructor Detail

AuthResult

AuthResult

AuthResult

Method Detail

isAllowed

getUser

getReason

getTableName

getFamily

getQualifier

getAction

getRequest

getParams

setAllowed

setReason

toFamiliesString

toContextString

toString

allow

allow

allow

deny

deny

deny

toFamilyString