org.elasticsearch.hadoop.mr.security

Class HadoopUser

java.lang.Object

org.elasticsearch.hadoop.mr.security.HadoopUser

All Implemented Interfaces:

User

public class HadoopUser
extends java.lang.Object
implements User

Provides access to user operations from Hadoop's UserGroupInformation class.

Constructor Summary

Constructors

Constructor and Description
HadoopUser(UserGroupInformation ugi, Settings providerSettings)

Method Summary

Modifier and Type	Method and Description
void	addEsToken(EsToken esToken) Adds the given esToken to the user
<T> T	doAs(java.security.PrivilegedAction<T> action) Execute the given action as the user
<T> T	doAs(java.security.PrivilegedExceptionAction<T> action) Execute the given action as the user
java.lang.Iterable<EsToken>	getAllEsTokens()
EsToken	getEsToken(java.lang.String clusterName)
javax.security.auth.kerberos.KerberosPrincipal	getKerberosPrincipal()
UserProvider	getRealUserProvider()
java.lang.String	getUserName()
boolean	isProxyUser()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

HadoopUser

public HadoopUser(UserGroupInformation ugi,
                  Settings providerSettings)

Method Detail

doAs

public <T> T doAs(java.security.PrivilegedAction<T> action)

Description copied from interface: User

Execute the given action as the user

Specified by:

doAs in interface User

Type Parameters:

T - The return type from the action

Parameters:

action - To execute

Returns:

Whatever was returned from the action

doAs

public <T> T doAs(java.security.PrivilegedExceptionAction<T> action)
           throws EsHadoopException

Description copied from interface: User

Execute the given action as the user

Specified by:

doAs in interface User

Type Parameters:

T - The return type from the action

Parameters:

action - To execute

Returns:

Whatever was returned from the action

Throws:

EsHadoopException - Should an exception be thrown during the operation

getEsToken

public EsToken getEsToken(java.lang.String clusterName)

Specified by:

getEsToken in interface User

Parameters:

clusterName - The cluster name

Returns:

a previously added Elasticsearch authentication token, or null if it does not exist

getAllEsTokens

public java.lang.Iterable<EsToken> getAllEsTokens()

Specified by:

getAllEsTokens in interface User

Returns:

all previously added Elasticsearch authentication tokens, or an empty iterable if none exist

addEsToken

public void addEsToken(EsToken esToken)

Description copied from interface: User

Adds the given esToken to the user

Specified by:

addEsToken in interface User

Parameters:

esToken - Authentication token for Elasticsearch

getUserName

public java.lang.String getUserName()

Specified by:

getUserName in interface User

Returns:

the most appropriate and available user name for this user, or null if one cannot be found

getKerberosPrincipal

public javax.security.auth.kerberos.KerberosPrincipal getKerberosPrincipal()

Specified by:

getKerberosPrincipal in interface User

Returns:

the KerberosPrincipal attached to the user, or null if it does not exist

isProxyUser

public boolean isProxyUser()

Specified by:

isProxyUser in interface User

Returns:

true if the current user is a proxy user with a real user underneath it

getRealUserProvider

public UserProvider getRealUserProvider()

Specified by:

getRealUserProvider in interface User

Returns:

Returns a user provider that will select the real user from any currently logged in user.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object