org.apache.hadoop.yarn.server.timelineservice.security

Class TimelineV2DelegationTokenSecretManagerService.TimelineV2DelegationTokenSecretManager

java.lang.Object

org.apache.hadoop.security.token.SecretManager<TokenIdent>

org.apache.hadoop.security.token.delegation.AbstractDelegationTokenSecretManager<org.apache.hadoop.yarn.security.client.TimelineDelegationTokenIdentifier>

org.apache.hadoop.yarn.server.timelineservice.security.TimelineV2DelegationTokenSecretManagerService.TimelineV2DelegationTokenSecretManager

Enclosing class:

TimelineV2DelegationTokenSecretManagerService

@InterfaceAudience.Private
@InterfaceStability.Unstable
public static class TimelineV2DelegationTokenSecretManagerService.TimelineV2DelegationTokenSecretManager
extends org.apache.hadoop.security.token.delegation.AbstractDelegationTokenSecretManager<org.apache.hadoop.yarn.security.client.TimelineDelegationTokenIdentifier>

Delegation token secret manager for ATSv2.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.hadoop.security.token.delegation.AbstractDelegationTokenSecretManager

org.apache.hadoop.security.token.delegation.AbstractDelegationTokenSecretManager.DelegationTokenInformation

Nested classes/interfaces inherited from class org.apache.hadoop.security.token.SecretManager

org.apache.hadoop.security.token.SecretManager.InvalidToken

Field Summary

Fields inherited from class org.apache.hadoop.security.token.delegation.AbstractDelegationTokenSecretManager

allKeys, currentId, currentTokens, delegationTokenSequenceNumber, noInterruptsLock, running, storeTokenTrackingId

Constructor Summary

Constructors

Constructor and Description
TimelineV2DelegationTokenSecretManagerService.TimelineV2DelegationTokenSecretManager(long delegationKeyUpdateInterval, long delegationTokenMaxLifetime, long delegationTokenRenewInterval, long delegationTokenRemoverScanInterval) Create a timeline v2 secret manager.

Method Summary

Methods

Modifier and Type	Method and Description
org.apache.hadoop.yarn.security.client.TimelineDelegationTokenIdentifier	createIdentifier()
org.apache.hadoop.security.token.Token<org.apache.hadoop.yarn.security.client.TimelineDelegationTokenIdentifier>	generateToken(org.apache.hadoop.security.UserGroupInformation ugi, String renewer)
protected void	logExpireToken(org.apache.hadoop.yarn.security.client.TimelineDelegationTokenIdentifier ident)

Methods inherited from class org.apache.hadoop.security.token.delegation.AbstractDelegationTokenSecretManager

addKey, addPersistedDelegationToken, cancelToken, checkToken, createPassword, createSecretKey, decodeTokenIdentifier, getAllKeys, getCurrentKeyId, getDelegationKey, getDelegationTokenSeqNum, getTokenInfo, getTokenTrackingId, getTrackingIdIfEnabled, incrementCurrentKeyId, incrementDelegationTokenSeqNum, isRunning, logUpdateMasterKey, removeStoredMasterKey, removeStoredToken, renewToken, reset, retrievePassword, setCurrentKeyId, setDelegationTokenSeqNum, startThreads, stopThreads, storeDelegationKey, storeNewMasterKey, storeNewToken, storeToken, updateDelegationKey, updateStoredToken, updateToken, verifyToken

Methods inherited from class org.apache.hadoop.security.token.SecretManager

checkAvailableForRead, createPassword, generateSecret, retriableRetrievePassword

Methods inherited from class java.lang.Object

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

Constructor Detail

TimelineV2DelegationTokenSecretManagerService.TimelineV2DelegationTokenSecretManager

public TimelineV2DelegationTokenSecretManagerService.TimelineV2DelegationTokenSecretManager(long delegationKeyUpdateInterval,
                                                                                    long delegationTokenMaxLifetime,
                                                                                    long delegationTokenRenewInterval,
                                                                                    long delegationTokenRemoverScanInterval)

Create a timeline v2 secret manager.

Parameters:

delegationKeyUpdateInterval - the number of milliseconds for rolling new secret keys.

delegationTokenMaxLifetime - the maximum lifetime of the delegation tokens in milliseconds

delegationTokenRenewInterval - how often the tokens must be renewed in milliseconds

delegationTokenRemoverScanInterval - how often the tokens are scanned for expired tokens in milliseconds

Method Detail

generateToken

public org.apache.hadoop.security.token.Token<org.apache.hadoop.yarn.security.client.TimelineDelegationTokenIdentifier> generateToken(org.apache.hadoop.security.UserGroupInformation ugi,
                                                                                                                             String renewer)

createIdentifier

public org.apache.hadoop.yarn.security.client.TimelineDelegationTokenIdentifier createIdentifier()

Specified by:

createIdentifier in class org.apache.hadoop.security.token.SecretManager<org.apache.hadoop.yarn.security.client.TimelineDelegationTokenIdentifier>

logExpireToken

protected void logExpireToken(org.apache.hadoop.yarn.security.client.TimelineDelegationTokenIdentifier ident)
                       throws IOException

Overrides:

logExpireToken in class org.apache.hadoop.security.token.delegation.AbstractDelegationTokenSecretManager<org.apache.hadoop.yarn.security.client.TimelineDelegationTokenIdentifier>

Throws:

IOException