org.apache.hadoop.yarn.server.nodemanager

Class DeletionService

java.lang.Object

org.apache.hadoop.service.AbstractService

org.apache.hadoop.yarn.server.nodemanager.DeletionService

All Implemented Interfaces:

Closeable, AutoCloseable, Service

public class DeletionService
extends AbstractService

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DeletionService.FileDeletionTask

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

Service.STATE

Constructor Summary

Constructors

Constructor and Description
DeletionService(ContainerExecutor exec)

Method Summary

Methods

Modifier and Type	Method and Description
DeletionService.FileDeletionTask	createFileDeletionTask(String user, Path subDir, Path[] baseDirs) Helper method to create file deletion task.
void	delete(String user, Path subDir, Path... baseDirs) /** Delete the path(s) as this user.
boolean	isTerminated() Determine if the service has completely stopped.
void	scheduleFileDeletionTask(DeletionService.FileDeletionTask fileDeletionTask)
protected void	serviceInit(Configuration conf) All initialization code needed by a service.
protected void	serviceStop() Actions called during the transition to the STOPPED state.

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, serviceStart, 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

DeletionService

public DeletionService(ContainerExecutor exec)

Method Detail

delete

public void delete(String user,
          Path subDir,
          Path... baseDirs)

/** Delete the path(s) as this user.

Parameters:

user - The user to delete as, or the JVM user if null

subDir - the sub directory name

baseDirs - the base directories which contains the subDir's

scheduleFileDeletionTask

public void scheduleFileDeletionTask(DeletionService.FileDeletionTask fileDeletionTask)

serviceInit

protected void serviceInit(Configuration conf)
                    throws Exception

Description copied from class: AbstractService

All initialization code needed by a service. This method will only ever be called once during the lifecycle of a specific service instance. Implementations do not need to be synchronized as the logic in AbstractService.init(Configuration) prevents re-entrancy. The base implementation checks to see if the subclass has created a new configuration instance, and if so, updates the base class value

Overrides:

serviceInit in class AbstractService

Parameters:

conf - configuration

Throws:

Exception - on a failure -these will be caught, possibly wrapped, and wil; trigger a service stop

serviceStop

protected void serviceStop()
                    throws Exception

Description copied from class: AbstractService

Actions called during the transition to the STOPPED state. This method will only ever be called once during the lifecycle of a specific service instance. Implementations do not need to be synchronized as the logic in AbstractService.stop() prevents re-entrancy. Implementations MUST write this to be robust against failures, including checks for null references -and for the first failure to not stop other attempts to shut down parts of the service.

Overrides:

serviceStop in class AbstractService

Throws:

Exception - if needed -these will be caught and logged.

isTerminated

@InterfaceAudience.Private
public boolean isTerminated()

Determine if the service has completely stopped. Used only by unit tests

Returns:

true if service has completely stopped

createFileDeletionTask

public DeletionService.FileDeletionTask createFileDeletionTask(String user,
                                                      Path subDir,
                                                      Path[] baseDirs)

Helper method to create file deletion task. To be used only if we need a way to define dependencies between deletion tasks.

Parameters:

user - user on whose behalf this task is suppose to run

subDir - sub directory as required in delete(String, Path, Path...)

baseDirs - base directories as required in delete(String, Path, Path...)