org.apache.tez.serviceplugins.api

Class ContainerLauncher

java.lang.Object

org.apache.tez.serviceplugins.api.ContainerLauncher

All Implemented Interfaces:

ServicePluginLifecycle

@InterfaceAudience.Public
@InterfaceStability.Unstable
public abstract class ContainerLauncher
extends Object
implements ServicePluginLifecycle

Plugin to allow custom container launchers to be written to launch containers on different types of executors.

Constructor Summary

Constructors

Constructor and Description
ContainerLauncher(ContainerLauncherContext containerLauncherContext)

Method Summary

Methods

Modifier and Type	Method and Description
ContainerLauncherContext	getContext() Get the ContainerLauncherContext associated with this instance of the container launcher, which is used to communicate with the rest of the system
void	initialize() An entry point for initialization.
abstract void	launchContainer(ContainerLaunchRequest launchRequest) Get the ContainerLauncherContext associated with this instance of the container launcher, which is used to communicate with the rest of the system
void	shutdown() Stop the service.
void	start() An entry point for starting the service.
abstract void	stopContainer(ContainerStopRequest stopRequest) A request to stop a specific container

Methods inherited from class java.lang.Object

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

Constructor Detail

ContainerLauncher

public ContainerLauncher(ContainerLauncherContext containerLauncherContext)

Method Detail

initialize

public void initialize()
                throws Exception

An entry point for initialization. Order of service setup. Constructor, initialize(), start() - when starting a service.

Specified by:

initialize in interface ServicePluginLifecycle

Throws:

Exception

start

public void start()
           throws Exception

An entry point for starting the service. Order of service setup. Constructor, initialize(), start() - when starting a service.

Specified by:

start in interface ServicePluginLifecycle

Throws:

Exception

shutdown

public void shutdown()
              throws Exception

Stop the service. This could be invoked at any point, when the service is no longer required - including in case of errors.

Specified by:

shutdown in interface ServicePluginLifecycle

Throws:

Exception

getContext

public final ContainerLauncherContext getContext()

Get the ContainerLauncherContext associated with this instance of the container launcher, which is used to communicate with the rest of the system

Returns:

an instance of ContainerLauncherContext

launchContainer

public abstract void launchContainer(ContainerLaunchRequest launchRequest)
                              throws ServicePluginException

Get the ContainerLauncherContext associated with this instance of the container launcher, which is used to communicate with the rest of the system

Parameters:

launchRequest - the actual launch request

Throws:

ServicePluginException - when the service runs into a fatal error which it cannot handle. This will cause the app to shutdown.

stopContainer

public abstract void stopContainer(ContainerStopRequest stopRequest)
                            throws ServicePluginException

A request to stop a specific container

Parameters:

stopRequest - the actual stop request

Throws:

ServicePluginException - when the service runs into a fatal error which it cannot handle. This will cause the app to shutdown.