org.apache.hadoop.yarn.server.resourcemanager

Class ApplicationMasterService

java.lang.Object

org.apache.hadoop.service.AbstractService

org.apache.hadoop.yarn.server.resourcemanager.ApplicationMasterService

All Implemented Interfaces:

Closeable, AutoCloseable, Service, ApplicationMasterProtocol

@InterfaceAudience.Private
public class ApplicationMasterService
extends AbstractService
implements ApplicationMasterProtocol

Nested Class Summary

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

Service.STATE

Constructor Summary

Constructors

Constructor and Description
ApplicationMasterService(RMContext rmContext, YarnScheduler scheduler)

Method Summary

Methods

Modifier and Type	Method and Description
AllocateResponse	allocate(AllocateRequest request) The main interface between an ApplicationMaster and the ResourceManager.
FinishApplicationMasterResponse	finishApplicationMaster(FinishApplicationMasterRequest request) The interface used by an ApplicationMaster to notify the ResourceManager about its completion (success or failed).
InetSocketAddress	getBindAddress()
boolean	hasApplicationMasterRegistered(ApplicationAttemptId appAttemptId)
void	refreshServiceAcls(Configuration configuration, PolicyProvider policyProvider)
void	registerAppAttempt(ApplicationAttemptId attemptId)
RegisterApplicationMasterResponse	registerApplicationMaster(RegisterApplicationMasterRequest request) The interface used by a new ApplicationMaster to register with the ResourceManager.
protected void	serviceStart() Actions called during the INITED to STARTED transition.
protected void	serviceStop() Actions called during the transition to the STOPPED state.
void	unregisterAttempt(ApplicationAttemptId attemptId)

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

ApplicationMasterService

public ApplicationMasterService(RMContext rmContext,
                        YarnScheduler scheduler)

Method Detail

serviceStart

protected void serviceStart()
                     throws Exception

Description copied from class: AbstractService

Actions called during the INITED to STARTED transition. 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.start() prevents re-entrancy.

Overrides:

serviceStart in class AbstractService

Throws:

Exception - if needed -these will be caught, wrapped, and trigger a service stop

getBindAddress

@InterfaceAudience.Private
public InetSocketAddress getBindAddress()

registerApplicationMaster

public RegisterApplicationMasterResponse registerApplicationMaster(RegisterApplicationMasterRequest request)
                                                            throws YarnException,
                                                                   IOException

Description copied from interface: ApplicationMasterProtocol

The interface used by a new ApplicationMaster to register with the ResourceManager.

The ApplicationMaster needs to provide details such as RPC Port, HTTP tracking url etc. as specified in RegisterApplicationMasterRequest.

The ResourceManager responds with critical details such as maximum resource capabilities in the cluster as specified in RegisterApplicationMasterResponse.

Specified by:

registerApplicationMaster in interface ApplicationMasterProtocol

Parameters:

request - registration request

Returns:

registration respose

Throws:

YarnException

InvalidApplicationMasterRequestException - The exception is thrown when an ApplicationMaster tries to register more then once.

IOException

See Also:

RegisterApplicationMasterRequest, RegisterApplicationMasterResponse

finishApplicationMaster

public FinishApplicationMasterResponse finishApplicationMaster(FinishApplicationMasterRequest request)
                                                        throws YarnException,
                                                               IOException

Description copied from interface: ApplicationMasterProtocol

The interface used by an ApplicationMaster to notify the ResourceManager about its completion (success or failed).

The ApplicationMaster has to provide details such as final state, diagnostics (in case of failures) etc. as specified in FinishApplicationMasterRequest.

The ResourceManager responds with FinishApplicationMasterResponse.

Specified by:

finishApplicationMaster in interface ApplicationMasterProtocol

Parameters:

request - completion request

Returns:

completion response

Throws:

YarnException

IOException

See Also:

FinishApplicationMasterRequest, FinishApplicationMasterResponse

hasApplicationMasterRegistered

public boolean hasApplicationMasterRegistered(ApplicationAttemptId appAttemptId)

Parameters:

appAttemptId -

Returns:

true if application is registered for the respective attemptid

allocate

public AllocateResponse allocate(AllocateRequest request)
                          throws YarnException,
                                 IOException

Description copied from interface: ApplicationMasterProtocol

The main interface between an ApplicationMaster and the ResourceManager.

The ApplicationMaster uses this interface to provide a list of ResourceRequest and returns unused Container allocated to it via AllocateRequest. Optionally, the ApplicationMaster can also blacklist resources which it doesn't want to use.

This also doubles up as a heartbeat to let the ResourceManager know that the ApplicationMaster is alive. Thus, applications should periodically make this call to be kept alive. The frequency depends on YarnConfiguration.RM_AM_EXPIRY_INTERVAL_MS which defaults to YarnConfiguration.DEFAULT_RM_AM_EXPIRY_INTERVAL_MS.

The ResourceManager responds with list of allocated Container, status of completed containers and headroom information for the application.

The ApplicationMaster can use the available headroom (resources) to decide how to utilized allocated resources and make informed decisions about future resource requests.

Specified by:

allocate in interface ApplicationMasterProtocol

Parameters:

request - allocation request

Returns:

allocation response

Throws:

YarnException

InvalidApplicationMasterRequestException - This exception is thrown when an ApplicationMaster calls allocate without registering first.

InvalidResourceBlacklistRequestException - This exception is thrown when an application provides an invalid specification for blacklist of resources.

InvalidResourceRequestException - This exception is thrown when a ResourceRequest is out of the range of the configured lower and upper limits on the resources.

IOException

See Also:

AllocateRequest, AllocateResponse

registerAppAttempt

public void registerAppAttempt(ApplicationAttemptId attemptId)

unregisterAttempt

public void unregisterAttempt(ApplicationAttemptId attemptId)

refreshServiceAcls

public void refreshServiceAcls(Configuration configuration,
                      PolicyProvider policyProvider)

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.