org.springframework.yarn.am.cluster

Class AbstractContainerClusterAppmaster

java.lang.Object

org.springframework.yarn.support.LifecycleObjectSupport

org.springframework.yarn.am.AbstractAppmaster

org.springframework.yarn.am.AbstractServicesAppmaster

org.springframework.yarn.am.AbstractEventingAppmaster

org.springframework.yarn.am.cluster.AbstractContainerClusterAppmaster

All Implemented Interfaces:

java.util.EventListener, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanFactoryAware, org.springframework.beans.factory.InitializingBean, org.springframework.context.ApplicationListener<AbstractYarnEvent>, org.springframework.context.Lifecycle, org.springframework.context.Phased, org.springframework.context.SmartLifecycle, ContainerClusterAppmaster, YarnAppmaster

Direct Known Subclasses:

ManagedContainerClusterAppmaster

public abstract class AbstractContainerClusterAppmaster
extends AbstractEventingAppmaster
implements ContainerClusterAppmaster

Base implementation of a ContainerClusterAppmaster.

Author:

Janne Valkealahti

Constructor Summary

Constructors

Constructor and Description
AbstractContainerClusterAppmaster()

Method Summary

Methods

Modifier and Type	Method and Description
ContainerCluster	createContainerCluster(java.lang.String clusterId, ProjectionData projectionData)
ContainerCluster	createContainerCluster(java.lang.String clusterId, java.lang.String clusterDef, ProjectionData projectionData, java.util.Map<java.lang.String,java.lang.Object> extraProperties)
void	destroyContainerCluster(java.lang.String id)
protected Grid	doCreateGrid()
protected ProjectedGrid	doCreateProjectedGrid(Grid grid)
protected void	doStart() Subclasses may implement this method with the start behavior.
protected void	doStop() Subclasses may implement this method with the stop behavior.
java.util.Map<java.lang.String,ContainerCluster>	getContainerClusters()
protected void	handleSatisfyStateData(ContainerCluster cluster, SatisfyStateData satisfyData)
protected void	killContainer(org.apache.hadoop.yarn.api.records.Container container)
void	modifyContainerCluster(java.lang.String id, ProjectionData data)
protected void	onContainerAllocated(org.apache.hadoop.yarn.api.records.Container container) Invoked when ContainerAllocationEvent is received as an application event.
protected void	onContainerCompleted(org.apache.hadoop.yarn.api.records.ContainerStatus status) Invoked when ContainerCompletedEvent is received as an application event.
protected java.util.List<java.lang.String>	onContainerLaunchCommands(org.apache.hadoop.yarn.api.records.Container container, ContainerCluster cluster, java.util.List<java.lang.String> commands) Called when a container is launched for sub classes to do a final modifications in these commands.
protected void	onContainerLaunched(org.apache.hadoop.yarn.api.records.Container container) Invoked when ContainerLaunchedEvent is received as an application event.
protected void	onInit() Global application master instance specific ApplicationAttemptId is build during this init method.
void	setGridProjectionFactoryLocator(GridProjectionFactoryLocator gridProjectionFactoryLocator) Sets the GridProjectionFactoryLocator used to find factories which are creating an instances of GridProjections.
void	setProjectionDataRegistry(ProjectionDataRegistry projectionDataRegistry)
void	setStateMachineFactory(EnumStateMachineFactory<ClusterState,ClusterEvent> stateMachineFactory)
void	startContainerCluster(java.lang.String id)
void	stopContainerCluster(java.lang.String id)
void	submitApplication() Submit and run application.

Methods inherited from class org.springframework.yarn.am.AbstractEventingAppmaster

getRegisteredContainers, onApplicationEvent, onContainerLaunchRequestFailed, shutdownContainers

Methods inherited from class org.springframework.yarn.am.AbstractServicesAppmaster

getAllocator, getLauncher, getMonitor, setAllocator, setLauncher, setMonitor

Methods inherited from class org.springframework.yarn.am.AbstractAppmaster

addAppmasterStateListener, finishAppmaster, getApplicationAttemptId, getAppmasterClientService, getAppmasterService, getAppmasterTrackService, getCmTemplate, getCommands, getCommands, getConfiguration, getContainerAssign, getContainerShutdown, getEnvironment, getEnvironment, getParameters, getResourceLocalizer, getTemplate, notifyCompleted, registerAppmaster, setCommands, setCommands, setCommands, setCommands, setConfiguration, setContainerAssign, setEnvironment, setEnvironment, setFinalApplicationStatus, setParameters, setResourceLocalizer, setTemplate

Methods inherited from class org.springframework.yarn.support.LifecycleObjectSupport

afterPropertiesSet, getBeanFactory, getPhase, getTaskExecutor, getTaskScheduler, getYarnEventPublisher, isAutoStartup, isRunning, setAutoStartup, setBeanFactory, setPhase, setTaskExecutor, setTaskScheduler, setYarnEventPublisher, start, stop, stop

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.yarn.am.YarnAppmaster

addAppmasterStateListener, setEnvironment, setParameters

Constructor Detail

AbstractContainerClusterAppmaster

public AbstractContainerClusterAppmaster()

Method Detail

onInit

protected void onInit()
               throws java.lang.Exception

Description copied from class: AbstractAppmaster

Global application master instance specific ApplicationAttemptId is build during this init method.

Overrides:

onInit in class AbstractEventingAppmaster

Throws:

java.lang.Exception - exception

See Also:

LifecycleObjectSupport.onInit()

doStart

protected void doStart()

Description copied from class: LifecycleObjectSupport

Subclasses may implement this method with the start behavior. This method will be invoked while holding the LifecycleObjectSupport.lifecycleLock.

Overrides:

doStart in class LifecycleObjectSupport

doStop

protected void doStop()

Description copied from class: LifecycleObjectSupport

Subclasses may implement this method with the stop behavior. This method will be invoked while holding the LifecycleObjectSupport.lifecycleLock.

Overrides:

doStop in class AbstractAppmaster

submitApplication

public void submitApplication()

Description copied from interface: YarnAppmaster

Submit and run application.

Specified by:

submitApplication in interface YarnAppmaster

onContainerAllocated

protected void onContainerAllocated(org.apache.hadoop.yarn.api.records.Container container)

Description copied from class: AbstractEventingAppmaster

Invoked when ContainerAllocationEvent is received as an application event. Wrapped Container is passed to a method.

Overrides:

onContainerAllocated in class AbstractEventingAppmaster

Parameters:

container - the container

onContainerLaunched

protected void onContainerLaunched(org.apache.hadoop.yarn.api.records.Container container)

Description copied from class: AbstractEventingAppmaster

Invoked when ContainerLaunchedEvent is received as an application event. Wrapped Container is passed to a method.

Overrides:

onContainerLaunched in class AbstractEventingAppmaster

Parameters:

container - the container

onContainerCompleted

protected void onContainerCompleted(org.apache.hadoop.yarn.api.records.ContainerStatus status)

Description copied from class: AbstractEventingAppmaster

Invoked when ContainerCompletedEvent is received as an application event. Wrapped ContainerStatus is passed to a method.

Overrides:

onContainerCompleted in class AbstractEventingAppmaster

Parameters:

status - the container status

getContainerClusters

public java.util.Map<java.lang.String,ContainerCluster> getContainerClusters()

Specified by:

getContainerClusters in interface ContainerClusterAppmaster

createContainerCluster

public ContainerCluster createContainerCluster(java.lang.String clusterId,
                                      ProjectionData projectionData)

Specified by:

createContainerCluster in interface ContainerClusterAppmaster

createContainerCluster

public ContainerCluster createContainerCluster(java.lang.String clusterId,
                                      java.lang.String clusterDef,
                                      ProjectionData projectionData,
                                      java.util.Map<java.lang.String,java.lang.Object> extraProperties)

Specified by:

createContainerCluster in interface ContainerClusterAppmaster

startContainerCluster

public void startContainerCluster(java.lang.String id)

Specified by:

startContainerCluster in interface ContainerClusterAppmaster

stopContainerCluster

public void stopContainerCluster(java.lang.String id)

Specified by:

stopContainerCluster in interface ContainerClusterAppmaster

destroyContainerCluster

public void destroyContainerCluster(java.lang.String id)

Specified by:

destroyContainerCluster in interface ContainerClusterAppmaster

modifyContainerCluster

public void modifyContainerCluster(java.lang.String id,
                          ProjectionData data)

Specified by:

modifyContainerCluster in interface ContainerClusterAppmaster

setStateMachineFactory

@Autowired
public void setStateMachineFactory(EnumStateMachineFactory<ClusterState,ClusterEvent> stateMachineFactory)

setGridProjectionFactoryLocator

@Autowired
public void setGridProjectionFactoryLocator(GridProjectionFactoryLocator gridProjectionFactoryLocator)

Sets the GridProjectionFactoryLocator used to find factories which are creating an instances of GridProjections.

Parameters:

gridProjectionFactoryLocator - the grid projection factory locator

setProjectionDataRegistry

@Autowired(required=false)
public void setProjectionDataRegistry(ProjectionDataRegistry projectionDataRegistry)

doCreateGrid

protected Grid doCreateGrid()

doCreateProjectedGrid

protected ProjectedGrid doCreateProjectedGrid(Grid grid)

handleSatisfyStateData

protected void handleSatisfyStateData(ContainerCluster cluster,
                          SatisfyStateData satisfyData)

killContainer

protected void killContainer(org.apache.hadoop.yarn.api.records.Container container)

onContainerLaunchCommands

protected java.util.List<java.lang.String> onContainerLaunchCommands(org.apache.hadoop.yarn.api.records.Container container,
                                                         ContainerCluster cluster,
                                                         java.util.List<java.lang.String> commands)

Called when a container is launched for sub classes to do a final modifications in these commands. Default implementation returns commands as is.

Parameters:

container - the container

cluster - the cluster

commands - the original commands

Returns:

modified commands