org.apache.hadoop.yarn.server.nodemanager.recovery

Class NMStateStoreService

java.lang.Object

org.apache.hadoop.service.AbstractService

org.apache.hadoop.yarn.server.nodemanager.recovery.NMStateStoreService

All Implemented Interfaces:

Closeable, AutoCloseable, org.apache.hadoop.service.Service

Direct Known Subclasses:

NMLeveldbStateStoreService, NMNullStateStoreService

@InterfaceAudience.Private
@InterfaceStability.Unstable
public abstract class NMStateStoreService
extends org.apache.hadoop.service.AbstractService

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NMStateStoreService.LocalResourceTrackerState
static class	NMStateStoreService.RecoveredDeletionServiceState
static class	NMStateStoreService.RecoveredLocalizationState
static class	NMStateStoreService.RecoveredUserResources

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

org.apache.hadoop.service.Service.STATE

Constructor Summary

Constructors

Constructor and Description
NMStateStoreService(String name)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canRecover()
protected abstract void	closeStorage()
abstract void	finishResourceLocalization(String user, org.apache.hadoop.yarn.api.records.ApplicationId appId, YarnServerNodemanagerRecoveryProtos.LocalizedResourceProto proto) Record the completion of a resource localization
protected abstract void	initStorage(org.apache.hadoop.conf.Configuration conf)
abstract NMStateStoreService.RecoveredDeletionServiceState	loadDeletionServiceState()
abstract NMStateStoreService.RecoveredLocalizationState	loadLocalizationState() Load the state of localized resources
abstract void	removeDeletionTask(int taskId)
abstract void	removeLocalizedResource(String user, org.apache.hadoop.yarn.api.records.ApplicationId appId, org.apache.hadoop.fs.Path localPath) Remove records related to a resource localization
void	serviceInit(org.apache.hadoop.conf.Configuration conf) Initialize the state storage
void	serviceStart() Start the state storage for use
void	serviceStop() Shutdown the state storage.
abstract void	startResourceLocalization(String user, org.apache.hadoop.yarn.api.records.ApplicationId appId, org.apache.hadoop.yarn.proto.YarnProtos.LocalResourceProto proto, org.apache.hadoop.fs.Path localPath) Record the start of localization for a resource
protected abstract void	startStorage()
abstract void	storeDeletionTask(int taskId, YarnServerNodemanagerRecoveryProtos.DeletionServiceDeleteTaskProto taskProto)

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

Constructor Detail

NMStateStoreService

public NMStateStoreService(String name)

Method Detail

serviceInit

public void serviceInit(org.apache.hadoop.conf.Configuration conf)
                 throws IOException

Initialize the state storage

Overrides:

serviceInit in class org.apache.hadoop.service.AbstractService

Throws:

IOException

serviceStart

public void serviceStart()
                  throws IOException

Start the state storage for use

Overrides:

serviceStart in class org.apache.hadoop.service.AbstractService

Throws:

IOException

serviceStop

public void serviceStop()
                 throws IOException

Shutdown the state storage.

Overrides:

serviceStop in class org.apache.hadoop.service.AbstractService

Throws:

IOException

canRecover

public boolean canRecover()

loadLocalizationState

public abstract NMStateStoreService.RecoveredLocalizationState loadLocalizationState()
                                                                              throws IOException

Load the state of localized resources

Returns:

recovered localized resource state

Throws:

IOException

startResourceLocalization

public abstract void startResourceLocalization(String user,
                             org.apache.hadoop.yarn.api.records.ApplicationId appId,
                             org.apache.hadoop.yarn.proto.YarnProtos.LocalResourceProto proto,
                             org.apache.hadoop.fs.Path localPath)
                                        throws IOException

Record the start of localization for a resource

Parameters:

user - the username or null if the resource is public

appId - the application ID if the resource is app-specific or null

proto - the resource request

localPath - local filesystem path where the resource will be stored

Throws:

IOException

finishResourceLocalization

public abstract void finishResourceLocalization(String user,
                              org.apache.hadoop.yarn.api.records.ApplicationId appId,
                              YarnServerNodemanagerRecoveryProtos.LocalizedResourceProto proto)
                                         throws IOException

Record the completion of a resource localization

Parameters:

user - the username or null if the resource is public

appId - the application ID if the resource is app-specific or null

proto - the serialized localized resource

Throws:

IOException

removeLocalizedResource

public abstract void removeLocalizedResource(String user,
                           org.apache.hadoop.yarn.api.records.ApplicationId appId,
                           org.apache.hadoop.fs.Path localPath)
                                      throws IOException

Remove records related to a resource localization

Parameters:

user - the username or null if the resource is public

appId - the application ID if the resource is app-specific or null

localPath - local filesystem path where the resource will be stored

Throws:

IOException

loadDeletionServiceState

public abstract NMStateStoreService.RecoveredDeletionServiceState loadDeletionServiceState()
                                                                                    throws IOException

Throws:

IOException

storeDeletionTask

public abstract void storeDeletionTask(int taskId,
                     YarnServerNodemanagerRecoveryProtos.DeletionServiceDeleteTaskProto taskProto)
                                throws IOException

Throws:

IOException

removeDeletionTask

public abstract void removeDeletionTask(int taskId)
                                 throws IOException

Throws:

IOException

initStorage

protected abstract void initStorage(org.apache.hadoop.conf.Configuration conf)
                             throws IOException

Throws:

IOException

startStorage

protected abstract void startStorage()
                              throws IOException

Throws:

IOException

closeStorage

protected abstract void closeStorage()
                              throws IOException

Throws:

IOException