org.apache.hadoop.yarn.server.resourcemanager.security

Class DelegationTokenRenewer

java.lang.Object

org.apache.hadoop.service.AbstractService

org.apache.hadoop.yarn.server.resourcemanager.security.DelegationTokenRenewer

All Implemented Interfaces:

Closeable, AutoCloseable, org.apache.hadoop.service.Service

@InterfaceAudience.Private
@InterfaceStability.Unstable
public class DelegationTokenRenewer
extends org.apache.hadoop.service.AbstractService

Service to renew application delegation tokens.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	DelegationTokenRenewer.DelegationTokenToRenew class that is used for keeping tracks of DT to renew

Nested classes/interfaces inherited from interface org.apache.hadoop.service.Service

org.apache.hadoop.service.Service.STATE

Field Summary

Fields

Modifier and Type	Field and Description
static long	DEFAULT_RM_SYSTEM_CREDENTIALS_VALID_TIME_REMAINING
static org.apache.hadoop.io.Text	HDFS_DELEGATION_KIND
static String	RM_SYSTEM_CREDENTIALS_VALID_TIME_REMAINING
static String	SCHEME

Constructor Summary

Constructors

Constructor and Description
DelegationTokenRenewer()

Method Summary

Methods

Modifier and Type	Method and Description
void	addApplicationAsync(org.apache.hadoop.yarn.api.records.ApplicationId applicationId, org.apache.hadoop.security.Credentials ts, boolean shouldCancelAtEnd, String user) Asynchronously add application tokens for renewal.
void	addApplicationAsyncDuringRecovery(org.apache.hadoop.yarn.api.records.ApplicationId applicationId, org.apache.hadoop.security.Credentials ts, boolean shouldCancelAtEnd, String user) Asynchronously add application tokens for renewal.
void	addApplicationSync(org.apache.hadoop.yarn.api.records.ApplicationId applicationId, org.apache.hadoop.security.Credentials ts, boolean shouldCancelAtEnd, String user) Synchronously renew delegation tokens.
void	applicationFinished(org.apache.hadoop.yarn.api.records.ApplicationId applicationId) Removing delegation token for completed applications.
protected ThreadPoolExecutor	createNewThreadPoolService(org.apache.hadoop.conf.Configuration conf)
protected ConcurrentMap<org.apache.hadoop.security.token.Token<?>,DelegationTokenRenewer.DelegationTokenToRenew>	getAllTokens()
Set<org.apache.hadoop.security.token.Token<?>>	getDelegationTokens()
protected org.apache.hadoop.security.token.Token<?>[]	obtainSystemTokensForUser(String user, org.apache.hadoop.security.Credentials credentials)
protected void	renewToken(DelegationTokenRenewer.DelegationTokenToRenew dttr)
protected void	serviceInit(org.apache.hadoop.conf.Configuration conf)
protected void	serviceStart()
protected void	serviceStop()
void	setRMContext(RMContext rmContext)
protected void	setTimerForTokenRenewal(DelegationTokenRenewer.DelegationTokenToRenew token) set task to renew the token
void	updateKeepAliveApplications(List<org.apache.hadoop.yarn.api.records.ApplicationId> appIds) Add a list of applications to the keep alive list.

Methods inherited from class org.apache.hadoop.service.AbstractService

close, getBlockers, getConfig, getFailureCause, getFailureState, getLifecycleHistory, getName, getServiceState, getStartTime, init, isInState, noteFailure, putBlocker, registerGlobalListener, registerServiceListener, removeBlocker, setConfig, start, stop, toString, unregisterGlobalListener, unregisterServiceListener, waitForServiceToStop

Methods inherited from class java.lang.Object

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

Field Detail

HDFS_DELEGATION_KIND

public static final org.apache.hadoop.io.Text HDFS_DELEGATION_KIND

SCHEME

public static final String SCHEME

See Also:

Constant Field Values

RM_SYSTEM_CREDENTIALS_VALID_TIME_REMAINING

public static final String RM_SYSTEM_CREDENTIALS_VALID_TIME_REMAINING

See Also:

Constant Field Values

DEFAULT_RM_SYSTEM_CREDENTIALS_VALID_TIME_REMAINING

public static final long DEFAULT_RM_SYSTEM_CREDENTIALS_VALID_TIME_REMAINING

See Also:

Constant Field Values

Constructor Detail

DelegationTokenRenewer

public DelegationTokenRenewer()

Method Detail

serviceInit

protected void serviceInit(org.apache.hadoop.conf.Configuration conf)
                    throws Exception

Overrides:

serviceInit in class org.apache.hadoop.service.AbstractService

Throws:

Exception

createNewThreadPoolService

protected ThreadPoolExecutor createNewThreadPoolService(org.apache.hadoop.conf.Configuration conf)

serviceStart

protected void serviceStart()
                     throws Exception

Overrides:

serviceStart in class org.apache.hadoop.service.AbstractService

Throws:

Exception

serviceStop

protected void serviceStop()

Overrides:

serviceStop in class org.apache.hadoop.service.AbstractService

getDelegationTokens

public Set<org.apache.hadoop.security.token.Token<?>> getDelegationTokens()

addApplicationAsync

public void addApplicationAsync(org.apache.hadoop.yarn.api.records.ApplicationId applicationId,
                       org.apache.hadoop.security.Credentials ts,
                       boolean shouldCancelAtEnd,
                       String user)

Asynchronously add application tokens for renewal.

Parameters:

applicationId - added application

ts - tokens

shouldCancelAtEnd - true if tokens should be canceled when the app is done else false.

user - user

addApplicationAsyncDuringRecovery

public void addApplicationAsyncDuringRecovery(org.apache.hadoop.yarn.api.records.ApplicationId applicationId,
                                     org.apache.hadoop.security.Credentials ts,
                                     boolean shouldCancelAtEnd,
                                     String user)

Asynchronously add application tokens for renewal.

Parameters:

applicationId - added application

ts - tokens

shouldCancelAtEnd - true if tokens should be canceled when the app is done else false.

user - user

addApplicationSync

public void addApplicationSync(org.apache.hadoop.yarn.api.records.ApplicationId applicationId,
                      org.apache.hadoop.security.Credentials ts,
                      boolean shouldCancelAtEnd,
                      String user)
                        throws IOException,
                               InterruptedException

Synchronously renew delegation tokens.

Parameters:

user - user

Throws:

IOException

InterruptedException

setTimerForTokenRenewal

protected void setTimerForTokenRenewal(DelegationTokenRenewer.DelegationTokenToRenew token)
                                throws IOException

set task to renew the token

Throws:

IOException

renewToken

protected void renewToken(DelegationTokenRenewer.DelegationTokenToRenew dttr)
                   throws IOException

Throws:

IOException

obtainSystemTokensForUser

protected org.apache.hadoop.security.token.Token<?>[] obtainSystemTokensForUser(String user,
                                                                    org.apache.hadoop.security.Credentials credentials)
                                                                         throws IOException,
                                                                                InterruptedException

Throws:

IOException

InterruptedException

applicationFinished

public void applicationFinished(org.apache.hadoop.yarn.api.records.ApplicationId applicationId)

Removing delegation token for completed applications.

Parameters:

applicationId - completed application

updateKeepAliveApplications

public void updateKeepAliveApplications(List<org.apache.hadoop.yarn.api.records.ApplicationId> appIds)

Add a list of applications to the keep alive list. If an appId already exists, update it's keep-alive time.

Parameters:

appIds - the list of applicationIds to be kept alive.

setRMContext

public void setRMContext(RMContext rmContext)

getAllTokens

protected ConcurrentMap<org.apache.hadoop.security.token.Token<?>,DelegationTokenRenewer.DelegationTokenToRenew> getAllTokens()