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, Service

@InterfaceAudience.Private
@InterfaceStability.Unstable
public class DelegationTokenRenewer
extends 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

Service.STATE

Field Summary

Fields

Modifier and Type	Field and Description
static String	SCHEME

Constructor Summary

Constructors

Constructor and Description
DelegationTokenRenewer()

Method Summary

Methods

Modifier and Type	Method and Description
void	addApplication(ApplicationId applicationId, Credentials ts, boolean shouldCancelAtEnd) Add application tokens for renewal.
void	applicationFinished(ApplicationId applicationId) Removing delegation token for completed applications.
Set<Token<?>>	getDelegationTokens()
protected void	renewIfServiceIsStarted(List<DelegationTokenRenewer.DelegationTokenToRenew> dtrs)
protected void	renewToken(DelegationTokenRenewer.DelegationTokenToRenew dttr)
protected void	serviceInit(Configuration conf) All initialization code needed by a service.
protected void	serviceStart() Actions called during the INITED to STARTED transition.
protected void	serviceStop() Actions called during the transition to the STOPPED state.
void	setRMContext(RMContext rmContext)
protected void	setTimerForTokenRenewal(DelegationTokenRenewer.DelegationTokenToRenew token) set task to renew the token
void	updateKeepAliveApplications(List<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

SCHEME

public static final String SCHEME

See Also:

Constant Field Values

Constructor Detail

DelegationTokenRenewer

public DelegationTokenRenewer()

Method Detail

serviceInit

protected void serviceInit(Configuration conf)
                    throws Exception

Description copied from class: AbstractService

All initialization code needed by a service. This method will only ever be called once during the lifecycle of a specific service instance. Implementations do not need to be synchronized as the logic in AbstractService.init(Configuration) prevents re-entrancy. The base implementation checks to see if the subclass has created a new configuration instance, and if so, updates the base class value

Overrides:

serviceInit in class AbstractService

Parameters:

conf - configuration

Throws:

Exception - on a failure -these will be caught, possibly wrapped, and wil; trigger a service stop

serviceStart

protected void serviceStart()
                     throws Exception

Description copied from class: AbstractService

Actions called during the INITED to STARTED transition. This method will only ever be called once during the lifecycle of a specific service instance. Implementations do not need to be synchronized as the logic in AbstractService.start() prevents re-entrancy.

Overrides:

serviceStart in class AbstractService

Throws:

Exception - if needed -these will be caught, wrapped, and trigger a service stop

serviceStop

protected void serviceStop()

Description copied from class: AbstractService

Actions called during the transition to the STOPPED state. This method will only ever be called once during the lifecycle of a specific service instance. Implementations do not need to be synchronized as the logic in AbstractService.stop() prevents re-entrancy. Implementations MUST write this to be robust against failures, including checks for null references -and for the first failure to not stop other attempts to shut down parts of the service.

Overrides:

serviceStop in class AbstractService

getDelegationTokens

public Set<Token<?>> getDelegationTokens()

addApplication

public void addApplication(ApplicationId applicationId,
                  Credentials ts,
                  boolean shouldCancelAtEnd)
                    throws IOException

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.

Throws:

IOException

renewIfServiceIsStarted

protected void renewIfServiceIsStarted(List<DelegationTokenRenewer.DelegationTokenToRenew> dtrs)
                                throws IOException

Throws:

IOException

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

applicationFinished

public void applicationFinished(ApplicationId applicationId)

Removing delegation token for completed applications.

Parameters:

applicationId - completed application

updateKeepAliveApplications

public void updateKeepAliveApplications(List<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)