gobblin.util

Class ProxiedFileSystemUtils

java.lang.Object

gobblin.util.ProxiedFileSystemUtils

public class ProxiedFileSystemUtils
extends Object

Utility class for creating FileSystem objects while proxied as another user. This class requires access to a user with secure impersonation priveleges. The FileSystem objects returned will have full permissions to access any operations on behalf of the specified user.

As a user, use methods in ProxiedFileSystemCache to generate the proxied file systems.

See Also:

Secure Impersonation, UserGroupInformation TODO figure out the proper generic type for the {@link Token} objects.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ProxiedFileSystemUtils.AuthType

Field Summary

Fields

Modifier and Type	Field and Description
static String	AUTH_TOKEN_PATH
static String	AUTH_TYPE_KEY

Constructor Summary

Constructors

Constructor and Description
ProxiedFileSystemUtils()

Method Summary

Modifier and Type	Method and Description
static boolean	canProxyAs(String userNameToProxyAs, String superUserName, Path superUserKeytabLocation) Returns true if superUserName can proxy as userNameToProxyAs using the specified superUserKeytabLocation, false otherwise.
static Optional<org.apache.hadoop.security.token.Token<?>>	getTokenFromSeqFile(String userNameKey, Path tokenFilePath) Retrives a Token from a given sequence file for a specified user.

Methods inherited from class java.lang.Object

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

Field Detail

AUTH_TYPE_KEY

public static final String AUTH_TYPE_KEY

See Also:

Constant Field Values

AUTH_TOKEN_PATH

public static final String AUTH_TOKEN_PATH

See Also:

Constant Field Values

Constructor Detail

ProxiedFileSystemUtils

public ProxiedFileSystemUtils()

Method Detail

canProxyAs

public static boolean canProxyAs(String userNameToProxyAs,
                                 String superUserName,
                                 Path superUserKeytabLocation)

Returns true if superUserName can proxy as userNameToProxyAs using the specified superUserKeytabLocation, false otherwise.

getTokenFromSeqFile

public static Optional<org.apache.hadoop.security.token.Token<?>> getTokenFromSeqFile(String userNameKey,
                                                                                      Path tokenFilePath)
                                                                               throws IOException

Retrives a Token from a given sequence file for a specified user. The sequence file should contain a list of key, value pairs where each key corresponds to a user and each value corresponds to a Token for that user.

Parameters:

userNameKey - The name of the user to retrieve a Token for

tokenFilePath - The path to the sequence file containing the Tokens

Returns:

A Token for the given user name

Throws:

IOException