org.apache.reef.runtime.yarn.client.unmanaged

Class YarnProxyUser

java.lang.Object

org.apache.reef.runtime.yarn.client.unmanaged.YarnProxyUser

All Implemented Interfaces:

UserCredentials

public final class YarnProxyUser
extends Object
implements UserCredentials

A holder class for the proxy UserGroupInformation object required for Unmanaged YARN Application Master in REEF-on-REEF or REEF-on-Spark mode.

Method Summary

Methods

Modifier and Type	Method and Description
<T> T	doAs(PrivilegedExceptionAction<T> action) Execute the privileged action as a given user.
org.apache.hadoop.security.UserGroupInformation	get() Get the YARN proxy user information.
boolean	isSet() Check if the proxy user is set.
void	set(String name, UserCredentials hostUser) Set YARN user.
void	set(String proxyName, org.apache.hadoop.security.UserGroupInformation hostUGI, org.apache.hadoop.security.token.Token<? extends org.apache.hadoop.security.token.TokenIdentifier>... tokens) Create YARN proxy user and add security tokens to its credentials.
String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

get

public org.apache.hadoop.security.UserGroupInformation get()
                                                    throws IOException

Get the YARN proxy user information. If not set, return the (global) current user.

Returns:

Proxy user group information, if set; otherwise, return current YARN user.

Throws:

IOException - if proxy user is not set AND unable to obtain current YARN user information.

isSet

public boolean isSet()

Check if the proxy user is set.

Specified by:

isSet in interface UserCredentials

Returns:

true if proxy user set, false otherwise.

set

public void set(String name,
       UserCredentials hostUser)
         throws IOException

Set YARN user. This method can be called only once per class instance.

Specified by:

set in interface UserCredentials

Parameters:

name - Name of the new proxy user.

hostUser - User credentials to copy. Must be an instance of YarnProxyUser.

Throws:

IOException - if unable to copy.

set

@SafeVarargs
public final void set(String proxyName,
                   org.apache.hadoop.security.UserGroupInformation hostUGI,
                   org.apache.hadoop.security.token.Token<? extends org.apache.hadoop.security.token.TokenIdentifier>... tokens)

Create YARN proxy user and add security tokens to its credentials. This method can be called only once per class instance.

Parameters:

proxyName - Name of the new proxy user.

hostUGI - YARN user to impersonate the proxy.

tokens - Security tokens to add to the new proxy user's credentials.

doAs

public <T> T doAs(PrivilegedExceptionAction<T> action)
       throws Exception

Execute the privileged action as a given user. If user credentials are not set, execute the action outside the user context.

Specified by:

doAs in interface UserCredentials

Type Parameters:

T - action return type.

Parameters:

action - an action to run.

Returns:

result of an action.

Throws:

Exception - whatever the action can throw.

toString

public String toString()

Overrides:

toString in class Object