org.apache.hadoop.hbase.security
Class User

java.lang.Object
  org.apache.hadoop.hbase.security.User

public abstract class User
extends java.lang.Object

Wrapper to abstract out usage of user and group information in HBase.

This class provides a common interface for interacting with user and group information across changing APIs in different versions of Hadoop. It only provides access to the common set of functionality in UserGroupInformation currently needed by HBase, but can be extended as needs change.

Note: this class does not attempt to support any of the Kerberos authentication methods exposed in security-enabled Hadoop (for the moment at least), as they're not yet needed. Properly supporting authentication is left up to implementation in secure HBase.

Field Summary

protected org.apache.hadoop.security.UserGroupInformation

ugi

Constructor Summary

User()

Method Summary

static User	createUserForTesting(org.apache.hadoop.conf.Configuration conf, java.lang.String name, java.lang.String[] groups) Generates a new User instance specifically for use in test code.
static User	getCurrent() Returns the User instance within current execution context.
java.lang.String	getName() Returns the full user name.
abstract java.lang.String	getShortName() Returns the shortened version of the user name -- the portion that maps to an operating system user name.
abstract <T> T	runAs(java.security.PrivilegedAction<T> action) Executes the given action within the context of this user.
abstract <T> T	runAs(java.security.PrivilegedExceptionAction<T> action) Executes the given action within the context of this user.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

ugi

protected org.apache.hadoop.security.UserGroupInformation ugi

Constructor Detail

User

public User()

Method Detail

getName

public java.lang.String getName()

Returns the full user name. For Kerberos principals this will include the host and realm portions of the principal name.

Returns:

User full name.

getShortName

public abstract java.lang.String getShortName()

Returns the shortened version of the user name -- the portion that maps to an operating system user name.

Returns:

Short name

runAs

public abstract <T> T runAs(java.security.PrivilegedAction<T> action)

Executes the given action within the context of this user.

runAs

public abstract <T> T runAs(java.security.PrivilegedExceptionAction<T> action)
                 throws java.io.IOException,
                        java.lang.InterruptedException

Executes the given action within the context of this user.

Throws:

java.io.IOException

java.lang.InterruptedException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getCurrent

public static User getCurrent()

Returns the User instance within current execution context.

createUserForTesting

public static User createUserForTesting(org.apache.hadoop.conf.Configuration conf,
                                        java.lang.String name,
                                        java.lang.String[] groups)

Generates a new User instance specifically for use in test code.

Parameters:

name - the full username

groups - the group names to which the test user will belong

Returns:

a new User instance