Package 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
@Private @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, tokenOwnerStats

  • Constructor Summary

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

  • Method Summary

    Modifier and Type
    Method
    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, addTokenForOwnerStats, cancelToken, checkToken, createPassword, createSecretKey, decodeTokenIdentifier, getAllKeys, getCandidateTokensForCleanup, getCurrentKeyId, getCurrentTokensSize, getDelegationKey, getDelegationTokenSeqNum, getMetrics, getTokenInfo, getTokenRenewInterval, getTokenTrackingId, getTopTokenRealOwners, getTrackingIdIfEnabled, incrementCurrentKeyId, incrementDelegationTokenSeqNum, isRunning, logExpireTokens, logUpdateMasterKey, removeExpiredStoredToken, removeStoredMasterKey, removeStoredToken, renewToken, reset, retrievePassword, rollMasterKey, setCurrentKeyId, setDelegationTokenSeqNum, startThreads, stopThreads, storeDelegationKey, storeNewMasterKey, storeNewToken, storeToken, syncTokenOwnerStats, updateDelegationKey, updateStoredToken, updateToken, verifyToken

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

    checkAvailableForRead, createPassword, generateSecret, retriableRetrievePassword, update, validateSecretKeyLength

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • TimelineV2DelegationTokenSecretManager

      public 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 Details

    • 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