alluxio.security.authentication

Class AuthenticatedClientUser

java.lang.Object

alluxio.security.authentication.AuthenticatedClientUser

@ThreadSafe
public final class AuthenticatedClientUser
extends Object

An instance of this class represents a client user connecting to PlainSaslServer. It is maintained in a ThreadLocal variable based on the Thrift RPC mechanism. TThreadPoolServer allocates a thread to serve a connection from client side and take back it when connection is closed. During the thread alive cycle, all the RPC happens in this thread. These RPC methods implemented in server side could get the client user by this class.

Method Summary

Modifier and Type	Method and Description
static User	get() Gets the User from the ThreadLocal variable.
static String	getClientUser() Gets the user name from the ThreadLocal variable.
static User	getOrNull()
static void	remove() Removes the User from the ThreadLocal variable.
static void	set(String userName) Creates a User and sets it to the ThreadLocal variable.
static void	set(User user) Sets User to the ThreadLocal variable.

Methods inherited from class java.lang.Object

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

Method Detail

set

public static void set(String userName)

Creates a User and sets it to the ThreadLocal variable.

Parameters:

userName - the name of the client user

set

public static void set(User user)

Sets User to the ThreadLocal variable.

Parameters:

user - the client user object

get

public static User get()
                throws IOException

Gets the User from the ThreadLocal variable.

Returns:

the client user, null if the user is not present

Throws:

IOException

getOrNull

public static User getOrNull()

Returns:

the user or null if the user is not set

getClientUser

public static String getClientUser()
                            throws AccessControlException

Gets the user name from the ThreadLocal variable.

Returns:

the client user in string

Throws:

AccessControlException - there is no authenticated user for this thread or the authentication is not enabled

remove

public static void remove()

Removes the User from the ThreadLocal variable.