Superusers (Apache HBase 1.2.12 API)

java.lang.Object
- org.apache.hadoop.hbase.security.Superusers

```
@InterfaceAudience.Private
public final class Superusers
extends Object
```
Keeps lists of superusers and super groups loaded from HBase configuration, checks if certain user is regarded as superuser.

Field Summary

Fields
Modifier and Type	Field and Description
`private static org.apache.commons.logging.Log`	`LOG`
`private static List<String>`	`superGroups`
`static String`	`SUPERUSER_CONF_KEY` Configuration key for superusers
`private static List<String>`	`superUsers`
`private static User`	`systemUser`

Constructor Summary

Constructors
Modifier Constructor and Description

private Superusers()

Constructors
Modifier	Constructor and Description
`private`	`Superusers()`

Method Summary

Methods
Modifier and Type	Method and Description
`static User`	`getSystemUser()`
`static void`	`initialize(org.apache.hadoop.conf.Configuration conf)` Should be called only once to pre-load list of super users and super groups from Configuration.
`static boolean`	`isSuperUser(String user)` Deprecated. this method is for backward compatibility, use `isSuperUser(User)` instead
`static boolean`	`isSuperUser(User user)`

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

- Field Detail
  - LOG
```
private static final org.apache.commons.logging.Log LOG
```
  - SUPERUSER_CONF_KEY
```
public static final String SUPERUSER_CONF_KEY
```
    Configuration key for superusers
    
    See Also:
    Constant Field Values
  - superUsers
```
private static List<String> superUsers
```
  - superGroups
```
private static List<String> superGroups
```
  - systemUser
```
private static User systemUser
```
- Constructor Detail
  - Superusers
```
private Superusers()
```
- Method Detail
  - initialize
```
public static void initialize(org.apache.hadoop.conf.Configuration conf)
                       throws IOException
```
    Should be called only once to pre-load list of super users and super groups from Configuration. This operation is idempotent.
    
    Parameters:
    conf - configuration to load users from
    
    Throws:
    
    IOException - if unable to initialize lists of superusers or super groups
    
    IllegalStateException - if current user is null
  - isSuperUser
```
public static boolean isSuperUser(User user)
```
    Parameters:
    user - to check
    
    Returns:
    true if current user is a super user (whether as user running process, declared as individual superuser or member of supergroup), false otherwise.
    
    Throws:
    
    IllegalStateException - if lists of superusers/super groups haven't been initialized properly
  - isSuperUser
```
@Deprecated
public static boolean isSuperUser(String user)
```
    Deprecated. this method is for backward compatibility, use isSuperUser(User) instead
    
    Parameters:
    user - to check
    
    Returns:
    true if current user is a super user (whether as user running process, or declared as superuser in configuration), false otherwise.
    
    Throws:
    
    IllegalStateException - if lists of superusers/super groups haven't been initialized properly
  - getSystemUser
```
public static User getSystemUser()
```

Class Superusers

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LOG

SUPERUSER_CONF_KEY

superUsers

superGroups

systemUser

Constructor Detail

Superusers

Method Detail

initialize

isSuperUser

isSuperUser

getSystemUser