org.apache.hadoop.yarn.api.protocolrecords

Class RegisterApplicationMasterResponse

java.lang.Object

org.apache.hadoop.yarn.api.protocolrecords.RegisterApplicationMasterResponse

Direct Known Subclasses:

RegisterApplicationMasterResponsePBImpl

@InterfaceAudience.Public
@InterfaceStability.Stable
public abstract class RegisterApplicationMasterResponse
extends Object

The response sent by the ResourceManager to a new ApplicationMaster on registration.

The response contains critical details such as:

• Maximum capability for allocated resources in the cluster.
• ApplicationACLs for the application.
• ClientToAMToken master key.

See Also:

ApplicationMasterProtocol.registerApplicationMaster(RegisterApplicationMasterRequest)

Constructor Summary

Constructors

Constructor and Description
RegisterApplicationMasterResponse()

Method Summary

Methods

Modifier and Type	Method and Description
abstract Map<ApplicationAccessType,String>	getApplicationACLs() Get the ApplicationACLs for the application.
abstract ByteBuffer	getClientToAMTokenMasterKey() Get ClientToAMToken master key.
abstract Resource	getMaximumResourceCapability() Get the maximum capability for any Resource allocated by the ResourceManager in the cluster.
static RegisterApplicationMasterResponse	newInstance(Resource minCapability, Resource maxCapability, Map<ApplicationAccessType,String> acls, ByteBuffer key)
abstract void	setApplicationACLs(Map<ApplicationAccessType,String> acls) Set the ApplicationACLs for the application.
abstract void	setClientToAMTokenMasterKey(ByteBuffer key) Set ClientToAMToken master key.
abstract void	setMaximumResourceCapability(Resource capability)

Methods inherited from class java.lang.Object

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

Constructor Detail

RegisterApplicationMasterResponse

public RegisterApplicationMasterResponse()

Method Detail

newInstance

@InterfaceAudience.Private
@InterfaceStability.Unstable
public static RegisterApplicationMasterResponse newInstance(Resource minCapability,
                                                                                                  Resource maxCapability,
                                                                                                  Map<ApplicationAccessType,String> acls,
                                                                                                  ByteBuffer key)

getMaximumResourceCapability

@InterfaceAudience.Public
@InterfaceStability.Stable
public abstract Resource getMaximumResourceCapability()

Get the maximum capability for any Resource allocated by the ResourceManager in the cluster.

Returns:

maximum capability of allocated resources in the cluster

setMaximumResourceCapability

@InterfaceAudience.Private
@InterfaceStability.Unstable
public abstract void setMaximumResourceCapability(Resource capability)

getApplicationACLs

@InterfaceAudience.Public
@InterfaceStability.Stable
public abstract Map<ApplicationAccessType,String> getApplicationACLs()

Get the ApplicationACLs for the application.

Returns:

all the ApplicationACLs

setApplicationACLs

@InterfaceAudience.Private
@InterfaceStability.Unstable
public abstract void setApplicationACLs(Map<ApplicationAccessType,String> acls)

Set the ApplicationACLs for the application.

Parameters:

acls -

getClientToAMTokenMasterKey

@InterfaceAudience.Public
@InterfaceStability.Stable
public abstract ByteBuffer getClientToAMTokenMasterKey()

Get ClientToAMToken master key.

The ClientToAMToken master key is sent to ApplicationMaster by ResourceManager via RegisterApplicationMasterResponse , used to verify corresponding ClientToAMToken.

setClientToAMTokenMasterKey

@InterfaceAudience.Public
@InterfaceStability.Stable
public abstract void setClientToAMTokenMasterKey(ByteBuffer key)

Set ClientToAMToken master key.