org.apache.hadoop.fs.azurebfs.security

Class AbfsDelegationTokenManager

java.lang.Object

org.apache.hadoop.fs.azurebfs.security.AbfsDelegationTokenManager

All Implemented Interfaces:

Closeable, AutoCloseable, BoundDTExtension

public class AbfsDelegationTokenManager
extends Object
implements BoundDTExtension

Class for delegation token Manager. Instantiates the class declared in ConfigurationKeys.FS_AZURE_DELEGATION_TOKEN_PROVIDER_TYPE and issues tokens from it.

Constructor Summary

Constructors

Constructor and Description
AbfsDelegationTokenManager(org.apache.hadoop.conf.Configuration conf) Create the custom delegation token manager and call its CustomDelegationTokenManager.initialize(Configuration) method.

Method Summary

Modifier and Type	Method and Description
void	bind(URI fsURI, org.apache.hadoop.conf.Configuration conf) Bind to a filesystem instance by passing the binding information down to any token manager which implements BoundDTExtension.
void	cancelDelegationToken(org.apache.hadoop.security.token.Token<?> token)
void	close() Close.
String	getCanonicalServiceName() Query the token manager for the service name; if it does not implement the extension interface, null is returned.
org.apache.hadoop.security.token.Token<org.apache.hadoop.security.token.delegation.web.DelegationTokenIdentifier>	getDelegationToken(String renewer) Get a delegation token by invoking CustomDelegationTokenManager.getDelegationToken(String).
CustomDelegationTokenManager	getTokenManager()
long	renewDelegationToken(org.apache.hadoop.security.token.Token<?> token)
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.hadoop.fs.azurebfs.extensions.BoundDTExtension

getUserAgentSuffix

Constructor Detail

AbfsDelegationTokenManager

public AbfsDelegationTokenManager(org.apache.hadoop.conf.Configuration conf)
                           throws IOException

Create the custom delegation token manager and call its CustomDelegationTokenManager.initialize(Configuration) method.

Parameters:

conf - configuration

Throws:

IOException - failure during initialization.

RuntimeException - classloading problems.

Method Detail

bind

public void bind(URI fsURI,
                 org.apache.hadoop.conf.Configuration conf)
          throws IOException

Bind to a filesystem instance by passing the binding information down to any token manager which implements BoundDTExtension. This is not invoked before renew or cancel operations, but is guaranteed to be invoked before calls to getDelegationToken(String).

Specified by:

bind in interface BoundDTExtension

Parameters:

fsURI - URI of the filesystem.

conf - configuration of this extension.

Throws:

IOException - bind failure.

getCanonicalServiceName

public String getCanonicalServiceName()

Query the token manager for the service name; if it does not implement the extension interface, null is returned.

Specified by:

getCanonicalServiceName in interface BoundDTExtension

Returns:

the canonical service name.

close

public void close()

Close. If the token manager is closeable, it has its Closeable.close() method (quietly) invoked.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

getDelegationToken

public org.apache.hadoop.security.token.Token<org.apache.hadoop.security.token.delegation.web.DelegationTokenIdentifier> getDelegationToken(String renewer)
                                                                                                                                     throws IOException

Get a delegation token by invoking CustomDelegationTokenManager.getDelegationToken(String). If the token returned already has a Kind; that is used. If not, then the token kind is set to AbfsDelegationTokenIdentifier.TOKEN_KIND, which implicitly resets any token renewer class.

Parameters:

renewer - the principal permitted to renew the token.

Returns:

a token for the filesystem.

Throws:

IOException - failure.

renewDelegationToken

public long renewDelegationToken(org.apache.hadoop.security.token.Token<?> token)
                          throws IOException

Throws:

IOException

cancelDelegationToken

public void cancelDelegationToken(org.apache.hadoop.security.token.Token<?> token)
                           throws IOException

Throws:

IOException

getTokenManager

@VisibleForTesting
public CustomDelegationTokenManager getTokenManager()

toString

public String toString()

Overrides:

toString in class Object