Package org.apache.hadoop.hbase.security.token

Class FsDelegationToken

java.lang.Object

org.apache.hadoop.hbase.security.token.FsDelegationToken

@Private
@Evolving
public class FsDelegationToken
extends Object

Helper class to obtain a filesystem delegation token. Mainly used by Map-Reduce jobs that requires to read/write data to a remote file-system (e.g. BulkLoad, ExportSnapshot).

Field Summary

Fields

Modifier and Type	Field	Description
private org.apache.hadoop.fs.FileSystem	fs
private boolean	hasForwardedToken
private static final org.slf4j.Logger	LOG
private final String	renewer
private final UserProvider	userProvider
private org.apache.hadoop.security.token.Token<?>	userToken

Constructor Summary

Constructors

Constructor	Description
FsDelegationToken(UserProvider userProvider, String renewer)

Method Summary

Modifier and Type	Method	Description
void	acquireDelegationToken(String tokenKind, org.apache.hadoop.fs.FileSystem fs)	Acquire the delegation token for the specified filesystem and token kind.
void	acquireDelegationToken(org.apache.hadoop.fs.FileSystem fs)	Acquire the delegation token for the specified filesystem.
org.apache.hadoop.fs.FileSystem	getFileSystem()
String	getRenewer()	Returns the account name that is allowed to renew the token.
UserProvider	getUserProvider()
org.apache.hadoop.security.token.Token<?>	getUserToken()	Returns the delegation token acquired, or null in case it was not acquired
void	releaseDelegationToken()	Releases a previously acquired delegation token.

Methods inherited from class java.lang.Object

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

Field Details

LOG

private static final org.slf4j.Logger LOG

userProvider

private final UserProvider userProvider

renewer

private final String renewer

hasForwardedToken

private boolean hasForwardedToken

userToken

private org.apache.hadoop.security.token.Token<?> userToken

fs

private org.apache.hadoop.fs.FileSystem fs

Constructor Details

FsDelegationToken

public FsDelegationToken(UserProvider userProvider,
 String renewer)

Method Details

acquireDelegationToken

public void acquireDelegationToken(org.apache.hadoop.fs.FileSystem fs)
                            throws IOException

Acquire the delegation token for the specified filesystem. Before requesting a new delegation token, tries to find one already available. Currently supports checking existing delegation tokens for swebhdfs, webhdfs and hdfs.

Parameters:

fs - the filesystem that requires the delegation token

Throws:

IOException - on fs.getDelegationToken() failure

acquireDelegationToken

public void acquireDelegationToken(String tokenKind,
 org.apache.hadoop.fs.FileSystem fs)
                            throws IOException

Acquire the delegation token for the specified filesystem and token kind. Before requesting a new delegation token, tries to find one already available.

Parameters:

tokenKind - non-null token kind to get delegation token from the UserProvider

fs - the filesystem that requires the delegation token

Throws:

IOException - on fs.getDelegationToken() failure

releaseDelegationToken

public void releaseDelegationToken()

Releases a previously acquired delegation token.

getUserProvider

public UserProvider getUserProvider()

getRenewer

public String getRenewer()

Returns the account name that is allowed to renew the token.

getUserToken

public org.apache.hadoop.security.token.Token<?> getUserToken()

Returns the delegation token acquired, or null in case it was not acquired

getFileSystem

public org.apache.hadoop.fs.FileSystem getFileSystem()