org.apache.hadoop.lib.service

Interface DelegationTokenManager

All Known Implementing Classes:

DelegationTokenManagerService

@InterfaceAudience.Private
public interface DelegationTokenManager

Service interface to manage HttpFS delegation tokens.

Method Summary

Methods

Modifier and Type	Method and Description
void	cancelToken(Token<DelegationTokenIdentifier> token, String canceler) Cancels a delegation token.
Token<DelegationTokenIdentifier>	createToken(UserGroupInformation ugi, String renewer) Creates a delegation token.
long	renewToken(Token<DelegationTokenIdentifier> token, String renewer) Renews a delegation token.
UserGroupInformation	verifyToken(Token<DelegationTokenIdentifier> token) Verifies a delegation token.

Method Detail

createToken

Token<DelegationTokenIdentifier> createToken(UserGroupInformation ugi,
                                           String renewer)
                                             throws DelegationTokenManagerException

Creates a delegation token.

Parameters:

ugi - UGI creating the token.

renewer - token renewer.

Returns:

new delegation token.

Throws:

DelegationTokenManagerException - thrown if the token could not be created.

renewToken

long renewToken(Token<DelegationTokenIdentifier> token,
              String renewer)
                throws DelegationTokenManagerException

Renews a delegation token.

Parameters:

token - delegation token to renew.

renewer - token renewer.

Returns:

epoc expiration time.

Throws:

DelegationTokenManagerException - thrown if the token could not be renewed.

cancelToken

void cancelToken(Token<DelegationTokenIdentifier> token,
               String canceler)
                 throws DelegationTokenManagerException

Cancels a delegation token.

Parameters:

token - delegation token to cancel.

canceler - token canceler.

Throws:

DelegationTokenManagerException - thrown if the token could not be canceled.

verifyToken

UserGroupInformation verifyToken(Token<DelegationTokenIdentifier> token)
                                 throws DelegationTokenManagerException

Verifies a delegation token.

Parameters:

token - delegation token to verify.

Returns:

the UGI for the token.

Throws:

DelegationTokenManagerException - thrown if the token could not be verified.