Package org.apache.hadoop.crypto.key

Interface KeyProviderDelegationTokenExtension.DelegationTokenExtension

All Superinterfaces:

DelegationTokenIssuer, KeyProviderExtension.Extension

All Known Implementing Classes:

KMSClientProvider, LoadBalancingKMSClientProvider

Enclosing class:

KeyProviderDelegationTokenExtension

public static interface KeyProviderDelegationTokenExtension.DelegationTokenExtension
extends KeyProviderExtension.Extension, DelegationTokenIssuer

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

Field Summary

Fields inherited from interface org.apache.hadoop.security.token.DelegationTokenIssuer

TOKEN_LOG

Method Summary

Modifier and Type	Method	Description
Void	cancelDelegationToken(Token<?> token)	Cancels the given token.
long	renewDelegationToken(Token<?> token)	Renews the given token.
Token<?>	selectDelegationToken(Credentials creds)

Methods inherited from interface org.apache.hadoop.security.token.DelegationTokenIssuer

addDelegationTokens, getAdditionalTokenIssuers, getCanonicalServiceName, getDelegationToken

Method Details

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 - raised on errors performing I/O.

cancelDelegationToken

Void cancelDelegationToken(Token<?> token)
                    throws IOException

Cancels the given token.

Parameters:

token - The token to be cancelled.

Throws:

IOException - raised on errors performing I/O.

selectDelegationToken

@VisibleForTesting
@Private
@Unstable
Token<?> selectDelegationToken(Credentials creds)