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 Summary

Fields

Modifier and Type	Field	Description
static org.slf4j.Logger	LOG

Method Summary

Modifier and Type	Method	Description
default void	checkVersion()	Check the version of federation stateStore.
void	close()	Perform any cleanup operations of the StateStore.
void	deleteStateStore()	We will clear the data in stateStore through the deleteStateStore method.
Version	getCurrentVersion()	Get the Version of the underlying federation state store client.
void	init(org.apache.hadoop.conf.Configuration conf)	Initialize the FederationStore.
Version	loadVersion()	Load the version information from the federation state store.
void	storeVersion()	Store the Version information in federation state store.

Methods inherited from interface org.apache.hadoop.yarn.server.federation.store.FederationApplicationHomeSubClusterStore

addApplicationHomeSubCluster, deleteApplicationHomeSubCluster, getApplicationHomeSubCluster, getApplicationsHomeSubCluster, updateApplicationHomeSubCluster

Methods inherited from interface org.apache.hadoop.yarn.server.federation.store.FederationDelegationTokenStateStore

getCurrentKeyId, getDelegationTokenSeqNum, getMasterKeyByDelegationKey, getTokenByRouterStoreToken, incrementCurrentKeyId, incrementDelegationTokenSeqNum, removeStoredMasterKey, removeStoredToken, setDelegationTokenSeqNum, storeNewMasterKey, storeNewToken, updateStoredToken

Methods inherited from interface org.apache.hadoop.yarn.server.federation.store.FederationMembershipStateStore

deregisterSubCluster, getSubCluster, getSubClusters, registerSubCluster, subClusterHeartbeat

Methods inherited from interface org.apache.hadoop.yarn.server.federation.store.FederationPolicyStore

deleteAllPoliciesConfigurations, deletePoliciesConfigurations, getPoliciesConfigurations, getPolicyConfiguration, setPolicyConfiguration

Methods inherited from interface org.apache.hadoop.yarn.server.federation.store.FederationReservationHomeSubClusterStore

addReservationHomeSubCluster, deleteReservationHomeSubCluster, getReservationHomeSubCluster, getReservationsHomeSubCluster, updateReservationHomeSubCluster

Field Detail

LOG

static final org.slf4j.Logger LOG

Method Detail

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 java.lang.Exception

Perform any cleanup operations of the StateStore.

Throws:

java.lang.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 java.lang.Exception

Load the version information from the federation state store.

Returns:

the Version of the federation state store

Throws:

java.lang.Exception - an exception occurred in load version.

storeVersion

void storeVersion()
           throws java.lang.Exception

Store the Version information in federation state store.

Throws:

java.lang.Exception - an exception occurred in store version.

checkVersion

default void checkVersion()
                   throws java.lang.Exception

Check the version of federation stateStore.

Throws:

java.lang.Exception - an exception occurred in check version.

deleteStateStore

void deleteStateStore()
               throws java.lang.Exception

We will clear the data in stateStore through the deleteStateStore method.

Throws:

java.lang.Exception - an exception occurred in delete store.