Package org.apache.hadoop.yarn.client

Class AMRMClientUtils

java.lang.Object

org.apache.hadoop.yarn.client.AMRMClientUtils

@Private
public final class AMRMClientUtils
extends java.lang.Object

Utility class for AMRMClient.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	APP_ALREADY_REGISTERED_MESSAGE
static java.lang.String	EXPECTED_HB_RESPONSEID_MESSAGE
static int	PRE_REGISTER_RESPONSE_ID
static java.lang.String	RECEIVED_HB_RESPONSEID_MESSAGE

Method Summary

Modifier and Type	Method	Description
static void	addToOutstandingSchedulingRequests(java.util.Collection<org.apache.hadoop.yarn.api.records.SchedulingRequest> requests, java.util.Map<java.util.Set<java.lang.String>,java.util.List<org.apache.hadoop.yarn.api.records.SchedulingRequest>> outstandingSchedRequests)
static java.lang.String	assembleInvalidResponseIdExceptionMessage(org.apache.hadoop.yarn.api.records.ApplicationAttemptId appAttemptId, int expected, int received)	Generate the exception message when RM receives an AM heartbeat with invalid responseId.
static <T> T	createRMProxy(org.apache.hadoop.conf.Configuration configuration, java.lang.Class<T> protocol, org.apache.hadoop.security.UserGroupInformation user, org.apache.hadoop.security.token.Token<? extends org.apache.hadoop.security.token.TokenIdentifier> token)	Create a proxy for the specified protocol.
static int	getNextResponseId(int responseId)
static boolean	isMatchingSchedulingRequests(org.apache.hadoop.yarn.api.records.SchedulingRequest schedReq1, org.apache.hadoop.yarn.api.records.SchedulingRequest schedReq2)
static int	parseExpectedResponseIdFromException(java.lang.String exceptionMessage)	Parse the expected responseId from the exception generated by RM when processing AM heartbeat.
static void	removeFromOutstandingSchedulingRequests(java.util.Collection<org.apache.hadoop.yarn.api.records.Container> containers, java.util.Map<java.util.Set<java.lang.String>,java.util.List<org.apache.hadoop.yarn.api.records.SchedulingRequest>> outstandingSchedRequests)

Methods inherited from class java.lang.Object

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

Field Detail

PRE_REGISTER_RESPONSE_ID

public static final int PRE_REGISTER_RESPONSE_ID

See Also:

Constant Field Values

APP_ALREADY_REGISTERED_MESSAGE

public static final java.lang.String APP_ALREADY_REGISTERED_MESSAGE

See Also:

Constant Field Values

EXPECTED_HB_RESPONSEID_MESSAGE

public static final java.lang.String EXPECTED_HB_RESPONSEID_MESSAGE

See Also:

Constant Field Values

RECEIVED_HB_RESPONSEID_MESSAGE

public static final java.lang.String RECEIVED_HB_RESPONSEID_MESSAGE

See Also:

Constant Field Values

Method Detail

createRMProxy

@Public
@Unstable
public static <T> T createRMProxy(org.apache.hadoop.conf.Configuration configuration,
                                  java.lang.Class<T> protocol,
                                  org.apache.hadoop.security.UserGroupInformation user,
                                  org.apache.hadoop.security.token.Token<? extends org.apache.hadoop.security.token.TokenIdentifier> token)
                           throws java.io.IOException

Create a proxy for the specified protocol.

Type Parameters:

T - Type information of the proxy

Parameters:

configuration - Configuration to generate ClientRMProxy

protocol - Protocol for the proxy

user - the user on whose behalf the proxy is being created

token - the auth token to use for connection

Returns:

Proxy to the RM

Throws:

java.io.IOException - on failure

assembleInvalidResponseIdExceptionMessage

public static java.lang.String assembleInvalidResponseIdExceptionMessage(org.apache.hadoop.yarn.api.records.ApplicationAttemptId appAttemptId,
                                                                         int expected,
                                                                         int received)

Generate the exception message when RM receives an AM heartbeat with invalid responseId.

Parameters:

appAttemptId - the app attempt

expected - the expected responseId value

received - the received responseId value

Returns:

the assembled exception message

parseExpectedResponseIdFromException

public static int parseExpectedResponseIdFromException(java.lang.String exceptionMessage)

Parse the expected responseId from the exception generated by RM when processing AM heartbeat.

Parameters:

exceptionMessage - the exception message thrown by RM

Returns:

the parsed expected responseId, -1 if failed

getNextResponseId

public static int getNextResponseId(int responseId)

addToOutstandingSchedulingRequests

public static void addToOutstandingSchedulingRequests(java.util.Collection<org.apache.hadoop.yarn.api.records.SchedulingRequest> requests,
                                                      java.util.Map<java.util.Set<java.lang.String>,java.util.List<org.apache.hadoop.yarn.api.records.SchedulingRequest>> outstandingSchedRequests)

isMatchingSchedulingRequests

public static boolean isMatchingSchedulingRequests(org.apache.hadoop.yarn.api.records.SchedulingRequest schedReq1,
                                                   org.apache.hadoop.yarn.api.records.SchedulingRequest schedReq2)

removeFromOutstandingSchedulingRequests

public static void removeFromOutstandingSchedulingRequests(java.util.Collection<org.apache.hadoop.yarn.api.records.Container> containers,
                                                           java.util.Map<java.util.Set<java.lang.String>,java.util.List<org.apache.hadoop.yarn.api.records.SchedulingRequest>> outstandingSchedRequests)