Package org.apache.hadoop.security.token.delegation.web

Class DelegationTokenManager

java.lang.Object

org.apache.hadoop.security.token.delegation.web.DelegationTokenManager

@Private
@Evolving
public class DelegationTokenManager
extends java.lang.Object

Delegation Token Manager used by the KerberosDelegationTokenAuthenticationHandler.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	ENABLE_ZK_KEY
static java.lang.String	MAX_LIFETIME
static long	MAX_LIFETIME_DEFAULT
static java.lang.String	PREFIX
static java.lang.String	REMOVAL_SCAN_INTERVAL
static long	REMOVAL_SCAN_INTERVAL_DEFAULT
static java.lang.String	RENEW_INTERVAL
static long	RENEW_INTERVAL_DEFAULT
static java.lang.String	UPDATE_INTERVAL
static long	UPDATE_INTERVAL_DEFAULT

Constructor Summary

Constructors

Constructor	Description
DelegationTokenManager(Configuration conf, Text tokenKind)

Method Summary

Modifier and Type	Method	Description
void	cancelToken(Token<? extends AbstractDelegationTokenIdentifier> token, java.lang.String canceler)
Token<? extends AbstractDelegationTokenIdentifier>	createToken(UserGroupInformation ugi, java.lang.String renewer)
Token<? extends AbstractDelegationTokenIdentifier>	createToken(UserGroupInformation ugi, java.lang.String renewer, java.lang.String service)
void	destroy()
AbstractDelegationTokenSecretManager	getDelegationTokenSecretManager()
void	init()
long	renewToken(Token<? extends AbstractDelegationTokenIdentifier> token, java.lang.String renewer)
void	setExternalDelegationTokenSecretManager(AbstractDelegationTokenSecretManager secretManager)	Sets an external DelegationTokenSecretManager instance to manage creation and verification of Delegation Tokens.
UserGroupInformation	verifyToken(Token<? extends AbstractDelegationTokenIdentifier> token)

Methods inherited from class java.lang.Object

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

Field Detail

ENABLE_ZK_KEY

public static final java.lang.String ENABLE_ZK_KEY

See Also:

Constant Field Values

PREFIX

public static final java.lang.String PREFIX

See Also:

Constant Field Values

UPDATE_INTERVAL

public static final java.lang.String UPDATE_INTERVAL

See Also:

Constant Field Values

UPDATE_INTERVAL_DEFAULT

public static final long UPDATE_INTERVAL_DEFAULT

See Also:

Constant Field Values

MAX_LIFETIME

public static final java.lang.String MAX_LIFETIME

See Also:

Constant Field Values

MAX_LIFETIME_DEFAULT

public static final long MAX_LIFETIME_DEFAULT

See Also:

Constant Field Values

RENEW_INTERVAL

public static final java.lang.String RENEW_INTERVAL

See Also:

Constant Field Values

RENEW_INTERVAL_DEFAULT

public static final long RENEW_INTERVAL_DEFAULT

See Also:

Constant Field Values

REMOVAL_SCAN_INTERVAL

public static final java.lang.String REMOVAL_SCAN_INTERVAL

See Also:

Constant Field Values

REMOVAL_SCAN_INTERVAL_DEFAULT

public static final long REMOVAL_SCAN_INTERVAL_DEFAULT

See Also:

Constant Field Values

Constructor Detail

DelegationTokenManager

public DelegationTokenManager(Configuration conf,
                              Text tokenKind)

Method Detail

setExternalDelegationTokenSecretManager

public void setExternalDelegationTokenSecretManager(AbstractDelegationTokenSecretManager secretManager)

Sets an external DelegationTokenSecretManager instance to manage creation and verification of Delegation Tokens.

This is useful for use cases where secrets must be shared across multiple services.

Parameters:

secretManager - a DelegationTokenSecretManager instance

init

public void init()

destroy

public void destroy()

createToken

public Token<? extends AbstractDelegationTokenIdentifier> createToken(UserGroupInformation ugi,
                                                                      java.lang.String renewer)

createToken

public Token<? extends AbstractDelegationTokenIdentifier> createToken(UserGroupInformation ugi,
                                                                      java.lang.String renewer,
                                                                      java.lang.String service)

renewToken

public long renewToken(Token<? extends AbstractDelegationTokenIdentifier> token,
                       java.lang.String renewer)
                throws java.io.IOException

Throws:

java.io.IOException

cancelToken

public void cancelToken(Token<? extends AbstractDelegationTokenIdentifier> token,
                        java.lang.String canceler)
                 throws java.io.IOException

Throws:

java.io.IOException

verifyToken

public UserGroupInformation verifyToken(Token<? extends AbstractDelegationTokenIdentifier> token)
                                 throws java.io.IOException

Throws:

java.io.IOException

getDelegationTokenSecretManager

@VisibleForTesting
public AbstractDelegationTokenSecretManager getDelegationTokenSecretManager()