Package org.apache.hadoop.crypto.key

Class KeyProviderDelegationTokenExtension

java.lang.Object

org.apache.hadoop.crypto.key.KeyProvider

org.apache.hadoop.crypto.key.KeyProviderExtension<KeyProviderDelegationTokenExtension.DelegationTokenExtension>

org.apache.hadoop.crypto.key.KeyProviderDelegationTokenExtension

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, DelegationTokenIssuer

public class KeyProviderDelegationTokenExtension
extends KeyProviderExtension<KeyProviderDelegationTokenExtension.DelegationTokenExtension>
implements DelegationTokenIssuer

A KeyProvider extension with the ability to add a renewer's Delegation Tokens to the provided Credentials.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	KeyProviderDelegationTokenExtension.DelegationTokenExtension	DelegationTokenExtension is a type of Extension that exposes methods needed to work with Delegation Tokens.

Nested classes/interfaces inherited from class org.apache.hadoop.crypto.key.KeyProviderExtension

KeyProviderExtension.Extension

Nested classes/interfaces inherited from class org.apache.hadoop.crypto.key.KeyProvider

KeyProvider.KeyVersion, KeyProvider.Metadata, KeyProvider.Options

Field Summary

Fields inherited from class org.apache.hadoop.crypto.key.KeyProvider

DEFAULT_BITLENGTH, DEFAULT_BITLENGTH_NAME, DEFAULT_CIPHER, DEFAULT_CIPHER_NAME, JCEKS_KEY_SERIAL_FILTER, JCEKS_KEY_SERIALFILTER_DEFAULT

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

TOKEN_LOG

Method Summary

Modifier and Type	Method	Description
static KeyProviderDelegationTokenExtension	createKeyProviderDelegationTokenExtension(KeyProvider keyProvider)	Creates a KeyProviderDelegationTokenExtension using a given KeyProvider.
java.lang.String	getCanonicalServiceName()	The service name used as the alias for the token in the credential token map.
Token<?>	getDelegationToken(java.lang.String renewer)	Unconditionally get a new token with the optional renewer.

Methods inherited from class org.apache.hadoop.crypto.key.KeyProviderExtension

createKey, createKey, deleteKey, flush, getCurrentKey, getExtension, getKeyProvider, getKeys, getKeysMetadata, getKeyVersion, getKeyVersions, getMetadata, invalidateCache, isTransient, rollNewVersion, rollNewVersion, toString

Methods inherited from class org.apache.hadoop.crypto.key.KeyProvider

buildVersionName, close, findProvider, generateKey, getBaseName, getConf, needsPassword, noPasswordError, noPasswordWarning, options

Methods inherited from class java.lang.Object

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

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

addDelegationTokens, getAdditionalTokenIssuers

Method Detail

getCanonicalServiceName

public java.lang.String getCanonicalServiceName()

Description copied from interface: DelegationTokenIssuer

The service name used as the alias for the token in the credential token map. addDelegationTokens will use this to determine if a token exists, and if not, add a new token with this alias.

Specified by:

getCanonicalServiceName in interface DelegationTokenIssuer

Returns:

the token.

getDelegationToken

public Token<?> getDelegationToken(java.lang.String renewer)
                            throws java.io.IOException

Description copied from interface: DelegationTokenIssuer

Unconditionally get a new token with the optional renewer. Returning null indicates the service does not issue tokens.

Specified by:

getDelegationToken in interface DelegationTokenIssuer

Parameters:

renewer - renewer.

Returns:

the token.

Throws:

java.io.IOException - raised on errors performing I/O.

createKeyProviderDelegationTokenExtension

public static KeyProviderDelegationTokenExtension createKeyProviderDelegationTokenExtension(KeyProvider keyProvider)

Creates a KeyProviderDelegationTokenExtension using a given KeyProvider.

If the given KeyProvider implements the KeyProviderDelegationTokenExtension.DelegationTokenExtension interface the KeyProvider itself will provide the extension functionality, otherwise a default extension implementation will be used.

Parameters:

keyProvider - KeyProvider to use to create the KeyProviderDelegationTokenExtension extension.

Returns:

a KeyProviderDelegationTokenExtension instance using the given KeyProvider.