Package org.apache.hadoop.yarn.server.nodemanager.containermanager

Class AuxServices

java.lang.Object

org.apache.hadoop.service.AbstractService

org.apache.hadoop.yarn.server.nodemanager.containermanager.AuxServices

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, org.apache.hadoop.service.Service, org.apache.hadoop.service.ServiceStateChangeListener, org.apache.hadoop.yarn.event.EventHandler<AuxServicesEvent>

public class AuxServices
extends org.apache.hadoop.service.AbstractService
implements org.apache.hadoop.service.ServiceStateChangeListener, org.apache.hadoop.yarn.event.EventHandler<AuxServicesEvent>

Nested Class Summary

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

org.apache.hadoop.service.Service.STATE

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	CLASS_NAME
static java.lang.String	NM_AUX_SERVICE_DIR
static org.apache.hadoop.fs.permission.FsPermission	NM_AUX_SERVICE_DIR_PERM
static java.lang.String	SYSTEM_CLASSES

Method Summary

Modifier and Type	Method	Description
protected void	addService(java.lang.String name, org.apache.hadoop.yarn.server.api.AuxiliaryService service, AuxServiceRecord serviceRecord)	Adds a service to the service map.
java.util.Map<java.lang.String,java.nio.ByteBuffer>	getMetaData()
java.util.Map<java.lang.String,java.nio.ByteBuffer>	getMetaData(org.apache.hadoop.yarn.server.api.ContainerInitializationContext ctx)
java.util.Collection<AuxServiceRecord>	getServiceRecords()	Gets current aux service records.
void	handle(AuxServicesEvent event)
boolean	isManifestEnabled()	Returns whether aux services manifest / dynamic loading is enabled.
protected void	loadManifest(org.apache.hadoop.conf.Configuration conf, boolean startServices)	Updates current aux services based on changes found in the manifest.
protected org.apache.hadoop.fs.Path	maybeDownloadJars(java.lang.String sName, java.lang.String className, java.lang.String remoteFile, AuxServiceFile.TypeEnum type, org.apache.hadoop.conf.Configuration conf)	Copies the specified remote file to local NM aux service directory.
protected static AuxServiceRecord	newAuxService(java.lang.String name, java.lang.String className)
void	reload(AuxServiceRecords services)	Reloads auxiliary services.
protected void	reloadManifest()	Reloads auxiliary services manifest.
void	serviceInit(org.apache.hadoop.conf.Configuration conf)
void	serviceStart()
void	serviceStop()
protected static void	setClasspath(AuxServiceRecord service, java.lang.String classpath)
protected static void	setSystemClasses(AuxServiceRecord service, java.lang.String systemClasses)
void	stateChanged(org.apache.hadoop.service.Service service)

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

NM_AUX_SERVICE_DIR

public static final java.lang.String NM_AUX_SERVICE_DIR

See Also:

Constant Field Values

NM_AUX_SERVICE_DIR_PERM

public static final org.apache.hadoop.fs.permission.FsPermission NM_AUX_SERVICE_DIR_PERM

CLASS_NAME

public static final java.lang.String CLASS_NAME

See Also:

Constant Field Values

SYSTEM_CLASSES

public static final java.lang.String SYSTEM_CLASSES

See Also:

Constant Field Values

Method Detail

isManifestEnabled

public boolean isManifestEnabled()

Returns whether aux services manifest / dynamic loading is enabled.

addService

protected final void addService(java.lang.String name,
                                org.apache.hadoop.yarn.server.api.AuxiliaryService service,
                                AuxServiceRecord serviceRecord)

Adds a service to the service map.

Parameters:

name - aux service name

service - aux service

serviceRecord - aux service record

getServiceRecords

public java.util.Collection<AuxServiceRecord> getServiceRecords()

Gets current aux service records.

Returns:

a collection of service records

getMetaData

public java.util.Map<java.lang.String,java.nio.ByteBuffer> getMetaData()

Returns:

the meta data for all registered services, that have been started. If a service has not been started no metadata will be available. The key is the name of the service as defined in the configuration.

getMetaData

public java.util.Map<java.lang.String,java.nio.ByteBuffer> getMetaData(org.apache.hadoop.yarn.server.api.ContainerInitializationContext ctx)

maybeDownloadJars

@VisibleForTesting
protected org.apache.hadoop.fs.Path maybeDownloadJars(java.lang.String sName,
                                                      java.lang.String className,
                                                      java.lang.String remoteFile,
                                                      AuxServiceFile.TypeEnum type,
                                                      org.apache.hadoop.conf.Configuration conf)
                                               throws java.io.IOException

Copies the specified remote file to local NM aux service directory. If the same file already exists (as determined by modification time), the file will not be copied again.

Parameters:

sName - service name

className - service class name

remoteFile - location of the file to download

type - type of file (STATIC for a jar or ARCHIVE for a tarball)

conf - configuration

Returns:

path of the downloaded file

Throws:

java.io.IOException

reloadManifest

@VisibleForTesting
protected void reloadManifest()
                       throws java.io.IOException

Reloads auxiliary services manifest. Must be called after service init.

Throws:

java.io.IOException - if manifest can't be loaded

reload

public void reload(AuxServiceRecords services)
            throws java.io.IOException

Reloads auxiliary services. Must be called after service init.

Parameters:

services - a list of auxiliary services

Throws:

java.io.IOException - if aux services have not been started yet or dynamic reloading is not enabled

loadManifest

@VisibleForTesting
protected void loadManifest(org.apache.hadoop.conf.Configuration conf,
                            boolean startServices)
                     throws java.io.IOException

Updates current aux services based on changes found in the manifest.

Parameters:

conf - configuration

startServices - if true starts services, otherwise only inits services

Throws:

java.io.IOException

serviceInit

public void serviceInit(org.apache.hadoop.conf.Configuration conf)
                 throws java.lang.Exception

Overrides:

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

Throws:

java.lang.Exception

serviceStart

public void serviceStart()
                  throws java.lang.Exception

Overrides:

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

Throws:

java.lang.Exception

serviceStop

public void serviceStop()
                 throws java.lang.Exception

Overrides:

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

Throws:

java.lang.Exception

stateChanged

public void stateChanged(org.apache.hadoop.service.Service service)

Specified by:

stateChanged in interface org.apache.hadoop.service.ServiceStateChangeListener

handle

public void handle(AuxServicesEvent event)

Specified by:

handle in interface org.apache.hadoop.yarn.event.EventHandler<AuxServicesEvent>

newAuxService

protected static AuxServiceRecord newAuxService(java.lang.String name,
                                                java.lang.String className)

setClasspath

protected static void setClasspath(AuxServiceRecord service,
                                   java.lang.String classpath)

setSystemClasses

protected static void setSystemClasses(AuxServiceRecord service,
                                       java.lang.String systemClasses)