org.springframework.yarn.am
Class AbstractAppmaster

java.lang.Object
  extended by org.springframework.yarn.support.LifecycleObjectSupport
      extended by org.springframework.yarn.am.AbstractAppmaster
All Implemented Interfaces:
Aware, BeanFactoryAware, InitializingBean, Lifecycle, Phased, SmartLifecycle
Direct Known Subclasses:
AbstractServicesAppmaster

public abstract class AbstractAppmaster
extends LifecycleObjectSupport

Base class providing functionality for common application master instances.

Author:
Janne Valkealahti

Constructor Summary
AbstractAppmaster()
           
 
Method Summary
 void addAppmasterStateListener(AppmasterStateListener listener)
          Adds the appmaster state listener.
protected  void doStop()
          Subclasses may implement this method with the stop behavior.
protected  FinishApplicationMasterResponse finishAppmaster()
          Finish appmaster by sending request to resource manager.
protected  ApplicationAttemptId getApplicationAttemptId()
          Gets the application attempt id.
protected  AppmasterService getAppmasterClientService()
          Gets a client facing AppmasterService set to this instance.
protected  AppmasterService getAppmasterService()
          Gets a AppmasterService set to this instance.
protected  AppmasterTrackService getAppmasterTrackService()
          Gets a AppmasterTrackService set to this instance.
 List<String> getCommands()
          Gets the commands.
 Configuration getConfiguration()
          Gets the Yarn configuration.
 ContainerAssign<Object> getContainerAssign()
          Gets the container assign.
 Map<String,String> getEnvironment()
          Gets the environment variables.
 Properties getParameters()
          Gets the parameters.
 ResourceLocalizer getResourceLocalizer()
          Gets the resource localizer.
 AppmasterRmOperations getTemplate()
          Gets the AppmasterRmOperations template.
protected  void notifyCompleted()
          Notify completed state to appmaster state listeners.
protected  void onInit()
          Global application master instance specific ApplicationAttemptId is build during this init method.
protected  RegisterApplicationMasterResponse registerAppmaster()
          Register appmaster.
 void setCommands(List<String> commands)
          Sets the commands.
 void setCommands(String[] commands)
          Sets the commands.
 void setConfiguration(Configuration configuration)
          Sets the Yarn configuration.
 void setContainerAssign(ContainerAssign<Object> containerAssign)
          Sets the container assign.
 void setEnvironment(Map<String,String> environment)
          Sets the environment variables.
protected  void setFinalApplicationStatus(FinalApplicationStatus finalApplicationStatus)
          Sets the final application status.
 void setParameters(Properties parameters)
          Sets the parameters.
 void setResourceLocalizer(ResourceLocalizer resourceLocalizer)
          Sets the resource localizer.
 void setTemplate(AppmasterRmOperations template)
          Sets the AppmasterRmOperations template.
 
Methods inherited from class org.springframework.yarn.support.LifecycleObjectSupport
afterPropertiesSet, doStart, 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
 

Constructor Detail

AbstractAppmaster

public AbstractAppmaster()
Method Detail

onInit

protected void onInit()
               throws Exception
Global application master instance specific ApplicationAttemptId is build during this init method.

Overrides:
onInit in class LifecycleObjectSupport
Throws:
Exception
See Also:
LifecycleObjectSupport.onInit()

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 LifecycleObjectSupport

getTemplate

public AppmasterRmOperations getTemplate()
Gets the AppmasterRmOperations template.

Returns:
the AppmasterRmOperations template

setTemplate

public void setTemplate(AppmasterRmOperations template)
Sets the AppmasterRmOperations template.

Parameters:
template - the new AppmasterRmOperations template

getEnvironment

public Map<String,String> getEnvironment()
Gets the environment variables.

Returns:
the environment variables

setEnvironment

public void setEnvironment(Map<String,String> environment)
Sets the environment variables.

Parameters:
environment - the environment variables

getParameters

public Properties getParameters()
Gets the parameters.

Returns:
the parameters

setParameters

public void setParameters(Properties parameters)
Sets the parameters.

Parameters:
parameters - the new parameters

getConfiguration

public Configuration getConfiguration()
Gets the Yarn configuration.

Returns:
the Yarn configuration

setConfiguration

public void setConfiguration(Configuration configuration)
Sets the Yarn configuration.

Parameters:
configuration - the new Yarn configuration

getCommands

public List<String> getCommands()
Gets the commands.

Returns:
the commands

setCommands

public void setCommands(List<String> commands)
Sets the commands.

Parameters:
commands - the new commands

setCommands

public void setCommands(String[] commands)
Sets the commands.

Parameters:
commands - the new commands

getApplicationAttemptId

protected ApplicationAttemptId getApplicationAttemptId()
Gets the application attempt id.

Returns:
the application attempt id

setResourceLocalizer

public void setResourceLocalizer(ResourceLocalizer resourceLocalizer)
Sets the resource localizer.

Parameters:
resourceLocalizer - the new resource localizer

getResourceLocalizer

public ResourceLocalizer getResourceLocalizer()
Gets the resource localizer.

Returns:
the resource localizer

addAppmasterStateListener

public void addAppmasterStateListener(AppmasterStateListener listener)
Adds the appmaster state listener.

Parameters:
listener - the listener

getContainerAssign

public ContainerAssign<Object> getContainerAssign()
Gets the container assign.

Returns:
the container assign

setContainerAssign

public void setContainerAssign(ContainerAssign<Object> containerAssign)
Sets the container assign.

Parameters:
containerAssign - the new container assign

setFinalApplicationStatus

protected void setFinalApplicationStatus(FinalApplicationStatus finalApplicationStatus)
Sets the final application status.

Parameters:
finalApplicationStatus - the new final application status

notifyCompleted

protected void notifyCompleted()
Notify completed state to appmaster state listeners.


getAppmasterService

protected AppmasterService getAppmasterService()
Gets a AppmasterService set to this instance.

Returns:
the instance of AppmasterService

getAppmasterClientService

protected AppmasterService getAppmasterClientService()
Gets a client facing AppmasterService set to this instance.

Returns:
the instance of AppmasterService

getAppmasterTrackService

protected AppmasterTrackService getAppmasterTrackService()
Gets a AppmasterTrackService set to this instance.

Returns:
the instance of AppmasterTrackService

registerAppmaster

protected RegisterApplicationMasterResponse registerAppmaster()
Register appmaster.

Returns:
the register application master response

finishAppmaster

protected FinishApplicationMasterResponse finishAppmaster()
Finish appmaster by sending request to resource manager. Default application status is FinalApplicationStatus.SUCCEEDED which can be changed using method setFinalApplicationStatus(FinalApplicationStatus).

Returns:
the finish application master response