Package org.apache.hadoop.yarn.server.federation.store

Interface FederationDelegationTokenStateStore

All Known Subinterfaces:
FederationStateStore
All Known Implementing Classes:
MemoryFederationStateStore, SQLFederationStateStore, ZookeeperFederationStateStore
@Private @Unstable public interface FederationDelegationTokenStateStore
FederationDelegationTokenStateStore maintains the state of all DelegationToken that have been submitted to the federated cluster.

  • Method Details

    • storeNewMasterKey

      RouterMasterKeyResponse storeNewMasterKey(RouterMasterKeyRequest request) throws org.apache.hadoop.yarn.exceptions.YarnException, IOException
      The Router Supports Store NewMasterKey. During this Process, Facade will call the specific StateStore to store the MasterKey.
      Parameters:
      request - The request contains RouterMasterKey, which is an abstraction for DelegationKey
      Returns:
      routerMasterKeyResponse
      Throws:
      org.apache.hadoop.yarn.exceptions.YarnException - if the call to the state store is unsuccessful
      IOException - An IO Error occurred

    • removeStoredMasterKey

      RouterMasterKeyResponse removeStoredMasterKey(RouterMasterKeyRequest request) throws org.apache.hadoop.yarn.exceptions.YarnException, IOException
      The Router Supports Remove MasterKey. During this Process, Facade will call the specific StateStore to remove the MasterKey.
      Parameters:
      request - The request contains RouterMasterKey, which is an abstraction for DelegationKey
      Returns:
      routerMasterKeyResponse
      Throws:
      org.apache.hadoop.yarn.exceptions.YarnException - if the call to the state store is unsuccessful
      IOException - An IO Error occurred

    • getMasterKeyByDelegationKey

      RouterMasterKeyResponse getMasterKeyByDelegationKey(RouterMasterKeyRequest request) throws org.apache.hadoop.yarn.exceptions.YarnException, IOException
      The Router Supports GetMasterKeyByDelegationKey.
      Parameters:
      request - The request contains RouterMasterKey, which is an abstraction for DelegationKey
      Returns:
      routerMasterKeyResponse
      Throws:
      org.apache.hadoop.yarn.exceptions.YarnException - if the call to the state store is unsuccessful
      IOException - An IO Error occurred

    • storeNewToken

      RouterRMTokenResponse storeNewToken(RouterRMTokenRequest request) throws org.apache.hadoop.yarn.exceptions.YarnException, IOException
      The Router Supports Store RMDelegationTokenIdentifier.
      Parameters:
      request - The request contains RouterRMToken (RMDelegationTokenIdentifier and renewDate)
      Returns:
      routerRMTokenResponse.
      Throws:
      org.apache.hadoop.yarn.exceptions.YarnException - if the call to the state store is unsuccessful
      IOException - An IO Error occurred

    • updateStoredToken

      RouterRMTokenResponse updateStoredToken(RouterRMTokenRequest request) throws org.apache.hadoop.yarn.exceptions.YarnException, IOException
      The Router Supports Update RMDelegationTokenIdentifier.
      Parameters:
      request - The request contains RouterRMToken (RMDelegationTokenIdentifier and renewDate)
      Returns:
      RouterRMTokenResponse.
      Throws:
      org.apache.hadoop.yarn.exceptions.YarnException - if the call to the state store is unsuccessful
      IOException - An IO Error occurred

    • removeStoredToken

      RouterRMTokenResponse removeStoredToken(RouterRMTokenRequest request) throws org.apache.hadoop.yarn.exceptions.YarnException, IOException
      The Router Supports Remove RMDelegationTokenIdentifier.
      Parameters:
      request - The request contains RouterRMToken (RMDelegationTokenIdentifier and renewDate)
      Returns:
      RouterRMTokenResponse.
      Throws:
      org.apache.hadoop.yarn.exceptions.YarnException - if the call to the state store is unsuccessful
      IOException - An IO Error occurred

    • getTokenByRouterStoreToken

      RouterRMTokenResponse getTokenByRouterStoreToken(RouterRMTokenRequest request) throws org.apache.hadoop.yarn.exceptions.YarnException, IOException
      The Router Supports GetTokenByRouterStoreToken.
      Parameters:
      request - The request contains RouterRMToken (RMDelegationTokenIdentifier and renewDate)
      Returns:
      RouterRMTokenResponse.
      Throws:
      org.apache.hadoop.yarn.exceptions.YarnException - if the call to the state store is unsuccessful
      IOException - An IO Error occurred

    • incrementDelegationTokenSeqNum

      int incrementDelegationTokenSeqNum()
      The Router Supports incrementDelegationTokenSeqNum.
      Returns:
      DelegationTokenSeqNum.

    • getDelegationTokenSeqNum

      int getDelegationTokenSeqNum()
      The Router Supports getDelegationTokenSeqNum.
      Returns:
      DelegationTokenSeqNum.

    • setDelegationTokenSeqNum

      void setDelegationTokenSeqNum(int seqNum)
      The Router Supports setDelegationTokenSeqNum.
      Parameters:
      seqNum - DelegationTokenSeqNum.

    • getCurrentKeyId

      int getCurrentKeyId()
      The Router Supports getCurrentKeyId.
      Returns:
      CurrentKeyId.

    • incrementCurrentKeyId

      int incrementCurrentKeyId()
      The Router Supports incrementCurrentKeyId.
      Returns:
      CurrentKeyId.