org.apache.hadoop.yarn.server.resourcemanager.recovery

Class FileSystemRMStateStore

java.lang.Object

org.apache.hadoop.service.AbstractService

org.apache.hadoop.yarn.server.resourcemanager.recovery.RMStateStore

org.apache.hadoop.yarn.server.resourcemanager.recovery.FileSystemRMStateStore

All Implemented Interfaces:

Closeable, AutoCloseable, Service

@InterfaceAudience.Private
@InterfaceStability.Unstable
public class FileSystemRMStateStore
extends RMStateStore

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.hadoop.yarn.server.resourcemanager.recovery.RMStateStore

RMStateStore.ApplicationAttemptState, RMStateStore.ApplicationState, RMStateStore.RMDTSecretManagerState, RMStateStore.RMState

Nested classes/interfaces inherited from interface org.apache.hadoop.service.Service

Service.STATE

Field Summary

Fields

Modifier and Type	Field and Description
protected FileSystem	fs
static org.apache.commons.logging.Log	LOG

Fields inherited from class org.apache.hadoop.yarn.server.resourcemanager.recovery.RMStateStore

AM_CLIENT_TOKEN_MASTER_KEY_NAME, AM_RM_TOKEN_SERVICE

Constructor Summary

Constructors

Constructor and Description
FileSystemRMStateStore()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	closeInternal() Derived classes close themselves using this method.
void	initInternal(Configuration conf) Derived classes initialize themselves using this method.
RMStateStore.RMState	loadState() Blocking API The derived class must recover state from the store and return a new RMState object populated with that state This must not be called on the dispatcher thread
void	removeApplicationState(RMStateStore.ApplicationState appState) Blocking API Derived classes must implement this method to remove the state of an application and its attempts
void	removeRMDelegationTokenState(RMDelegationTokenIdentifier identifier) Blocking API Derived classes must implement this method to remove the state of RMDelegationToken
void	removeRMDTMasterKeyState(DelegationKey masterKey) Blocking API Derived classes must implement this method to remove the state of DelegationToken Master Key
protected void	startInternal() Derived classes start themselves using this method.
void	storeApplicationAttemptState(String attemptId, ApplicationAttemptStateDataPBImpl attemptStateDataPB) Blocking API Derived classes must implement this method to store the state of an application attempt
void	storeApplicationState(String appId, ApplicationStateDataPBImpl appStateDataPB) Blocking API Derived classes must implement this method to store the state of an application.
void	storeRMDelegationTokenAndSequenceNumberState(RMDelegationTokenIdentifier identifier, Long renewDate, int latestSequenceNumber) Blocking API Derived classes must implement this method to store the state of RMDelegationToken and sequence number
void	storeRMDTMasterKeyState(DelegationKey masterKey) Blocking API Derived classes must implement this method to store the state of DelegationToken Master Key

Methods inherited from class org.apache.hadoop.yarn.server.resourcemanager.recovery.RMStateStore

removeApplication, removeApplication, removeRMDelegationToken, removeRMDTMasterKey, serviceInit, serviceStart, serviceStop, setRMDispatcher, storeApplication, storeApplicationAttempt, storeRMDelegationTokenAndSequenceNumber, storeRMDTMasterKey

Methods inherited from class org.apache.hadoop.service.AbstractService

close, getBlockers, getConfig, getFailureCause, getFailureState, getLifecycleHistory, getName, getServiceState, getStartTime, init, isInState, noteFailure, putBlocker, registerGlobalListener, registerServiceListener, removeBlocker, setConfig, start, stop, toString, unregisterGlobalListener, unregisterServiceListener, waitForServiceToStop

Methods inherited from class java.lang.Object

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

Field Detail

LOG

public static final org.apache.commons.logging.Log LOG

fs

protected FileSystem fs

Constructor Detail

FileSystemRMStateStore

public FileSystemRMStateStore()

Method Detail

initInternal

public void initInternal(Configuration conf)
                  throws Exception

Description copied from class: RMStateStore

Derived classes initialize themselves using this method.

Specified by:

initInternal in class RMStateStore

Throws:

Exception

startInternal

protected void startInternal()
                      throws Exception

Description copied from class: RMStateStore

Derived classes start themselves using this method. The base class is started and the event dispatcher is ready to use at this point

Specified by:

startInternal in class RMStateStore

Throws:

Exception

closeInternal

protected void closeInternal()
                      throws Exception

Description copied from class: RMStateStore

Derived classes close themselves using this method. The base class will be closed and the event dispatcher will be shutdown after this

Specified by:

closeInternal in class RMStateStore

Throws:

Exception

loadState

public RMStateStore.RMState loadState()
                               throws Exception

Description copied from class: RMStateStore

Blocking API The derived class must recover state from the store and return a new RMState object populated with that state This must not be called on the dispatcher thread

Specified by:

loadState in class RMStateStore

Throws:

Exception

storeApplicationState

public void storeApplicationState(String appId,
                         ApplicationStateDataPBImpl appStateDataPB)
                           throws Exception

Description copied from class: RMStateStore

Blocking API Derived classes must implement this method to store the state of an application.

Specified by:

storeApplicationState in class RMStateStore

Throws:

Exception

storeApplicationAttemptState

public void storeApplicationAttemptState(String attemptId,
                                ApplicationAttemptStateDataPBImpl attemptStateDataPB)
                                  throws Exception

Description copied from class: RMStateStore

Blocking API Derived classes must implement this method to store the state of an application attempt

Specified by:

storeApplicationAttemptState in class RMStateStore

Throws:

Exception

removeApplicationState

public void removeApplicationState(RMStateStore.ApplicationState appState)
                            throws Exception

Description copied from class: RMStateStore

Blocking API Derived classes must implement this method to remove the state of an application and its attempts

Specified by:

removeApplicationState in class RMStateStore

Throws:

Exception

storeRMDelegationTokenAndSequenceNumberState

public void storeRMDelegationTokenAndSequenceNumberState(RMDelegationTokenIdentifier identifier,
                                                Long renewDate,
                                                int latestSequenceNumber)
                                                  throws Exception

Description copied from class: RMStateStore

Blocking API Derived classes must implement this method to store the state of RMDelegationToken and sequence number

Specified by:

storeRMDelegationTokenAndSequenceNumberState in class RMStateStore

Throws:

Exception

removeRMDelegationTokenState

public void removeRMDelegationTokenState(RMDelegationTokenIdentifier identifier)
                                  throws Exception

Description copied from class: RMStateStore

Blocking API Derived classes must implement this method to remove the state of RMDelegationToken

Specified by:

removeRMDelegationTokenState in class RMStateStore

Throws:

Exception

storeRMDTMasterKeyState

public void storeRMDTMasterKeyState(DelegationKey masterKey)
                             throws Exception

Description copied from class: RMStateStore

Blocking API Derived classes must implement this method to store the state of DelegationToken Master Key

Specified by:

storeRMDTMasterKeyState in class RMStateStore

Throws:

Exception

removeRMDTMasterKeyState

public void removeRMDTMasterKeyState(DelegationKey masterKey)
                              throws Exception

Description copied from class: RMStateStore

Blocking API Derived classes must implement this method to remove the state of DelegationToken Master Key

Specified by:

removeRMDTMasterKeyState in class RMStateStore

Throws:

Exception