org.apache.hadoop.crypto.key

Interface KeyProviderDelegationTokenExtension.DelegationTokenExtension

All Superinterfaces:

KeyProviderExtension.Extension

All Known Implementing Classes:

LoadBalancingKMSClientProvider

Enclosing class:

KeyProviderDelegationTokenExtension

public static interface KeyProviderDelegationTokenExtension.DelegationTokenExtension
extends KeyProviderExtension.Extension

DelegationTokenExtension is a type of Extension that exposes methods needed to work with Delegation Tokens.

Method Summary

Methods

Modifier and Type	Method and Description
Token<?>[]	addDelegationTokens(String renewer, Credentials credentials) The implementer of this class will take a renewer and add all delegation tokens associated with the renewer to the Credentials object if it is not already present,
Void	cancelDelegationToken(Token<?> token) Cancels the given token.
long	renewDelegationToken(Token<?> token) Renews the given token.

Method Detail

addDelegationTokens

Token<?>[] addDelegationTokens(String renewer,
                             Credentials credentials)
                               throws IOException

The implementer of this class will take a renewer and add all delegation tokens associated with the renewer to the Credentials object if it is not already present,

Parameters:

renewer - the user allowed to renew the delegation tokens

credentials - cache in which to add new delegation tokens

Returns:

list of new delegation tokens

Throws:

IOException - thrown if IOException if an IO error occurs.

renewDelegationToken

long renewDelegationToken(Token<?> token)
                          throws IOException

Renews the given token.

Parameters:

token - The token to be renewed.

Returns:

The token's lifetime after renewal, or 0 if it can't be renewed.

Throws:

IOException

cancelDelegationToken

Void cancelDelegationToken(Token<?> token)
                           throws IOException

Cancels the given token.

Parameters:

token - The token to be cancelled.

Throws:

IOException