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

Interface FederationStateStore

All Superinterfaces:
FederationApplicationHomeSubClusterStore, FederationDelegationTokenStateStore, FederationMembershipStateStore, FederationPolicyStore, FederationReservationHomeSubClusterStore
All Known Implementing Classes:
MemoryFederationStateStore, SQLFederationStateStore, ZookeeperFederationStateStore
public interface FederationStateStore extends FederationApplicationHomeSubClusterStore, FederationMembershipStateStore, FederationPolicyStore, FederationReservationHomeSubClusterStore, FederationDelegationTokenStateStore
FederationStore extends the three interfaces used to coordinate the state of a federated cluster: FederationApplicationHomeSubClusterStore, FederationMembershipStateStore, FederationPolicyStore, and FederationReservationHomeSubClusterStore.

  • Field Details

    • LOG

      static final org.slf4j.Logger LOG

  • Method Details

    • init

      void init(org.apache.hadoop.conf.Configuration conf) throws org.apache.hadoop.yarn.exceptions.YarnException
      Initialize the FederationStore.
      Parameters:
      conf - the cluster configuration
      Throws:
      org.apache.hadoop.yarn.exceptions.YarnException - if initialization fails

    • close

      void close() throws Exception
      Perform any cleanup operations of the StateStore.
      Throws:
      Exception - if cleanup fails

    • getCurrentVersion

      Version getCurrentVersion()
      Get the Version of the underlying federation state store client.
      Returns:
      the Version of the underlying federation store client

    • loadVersion

      Version loadVersion() throws Exception
      Load the version information from the federation state store.
      Returns:
      the Version of the federation state store
      Throws:
      Exception - an exception occurred in load version.

    • storeVersion

      void storeVersion() throws Exception
      Store the Version information in federation state store.
      Throws:
      Exception - an exception occurred in store version.

    • checkVersion

      default void checkVersion() throws Exception
      Check the version of federation stateStore.
      Throws:
      Exception - an exception occurred in check version.

    • deleteStateStore

      void deleteStateStore() throws Exception
      We will clear the data in stateStore through the deleteStateStore method.
      Throws:
      Exception - an exception occurred in delete store.