org.apache.hadoop.fs.azurebfs.extensions

Interface CustomDelegationTokenManager

@InterfaceAudience.LimitedPrivate(value="authorization-subsystems")
 @InterfaceStability.Unstable
public interface CustomDelegationTokenManager

Interface for Managing the Delegation tokens. Implementations which also implement BoundDTExtension will have the its bind() called after initialize) and before any calls to getDelegationToken(String). It will not be bound during token renew or cancel operations: there is no Filesystem to bind to in those operations.

Method Summary

Modifier and Type	Method and Description
void	cancelDelegationToken(org.apache.hadoop.security.token.Token<?> token) Cancel the delegation token.
org.apache.hadoop.security.token.Token<org.apache.hadoop.security.token.delegation.web.DelegationTokenIdentifier>	getDelegationToken(String renewer) Get Delegation token.
void	initialize(org.apache.hadoop.conf.Configuration configuration) Initialize with supported configuration.
long	renewDelegationToken(org.apache.hadoop.security.token.Token<?> token) Renew the delegation token.

Method Detail

initialize

void initialize(org.apache.hadoop.conf.Configuration configuration)
         throws IOException

Initialize with supported configuration. This method is invoked when the (URI, Configuration)} method is invoked.

Parameters:

configuration - Configuration object

Throws:

IOException - if instance can not be configured.

getDelegationToken

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

Get Delegation token.

Parameters:

renewer - delegation token renewer

Returns:

delegation token

Throws:

IOException - when error in getting the delegation token

renewDelegationToken

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

Renew the delegation token.

Parameters:

token - delegation token.

Returns:

renewed time.

Throws:

IOException - when error in renewing the delegation token

cancelDelegationToken

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

Cancel the delegation token.

Parameters:

token - delegation token.

Throws:

IOException - when error in cancelling the delegation token.