org.apache.hadoop.yarn.server.utils

Class AMRMClientUtils

java.lang.Object

org.apache.hadoop.yarn.server.utils.AMRMClientUtils

@InterfaceAudience.Private
public final class AMRMClientUtils
extends Object

Utility class for AMRMClient.

Field Summary

Fields

Modifier and Type	Field and Description
static String	APP_ALREADY_REGISTERED_MESSAGE

Method Summary

Modifier and Type	Method and Description
static org.apache.hadoop.yarn.api.protocolrecords.AllocateResponse	allocateWithReRegister(org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest request, org.apache.hadoop.yarn.api.ApplicationMasterProtocol rmProxy, org.apache.hadoop.yarn.api.protocolrecords.RegisterApplicationMasterRequest registerRequest, org.apache.hadoop.yarn.api.records.ApplicationId appId) Helper method for client calling ApplicationMasterProtocol.allocate that handles re-register if RM fails over.
static <T> T	createRMProxy(org.apache.hadoop.conf.Configuration configuration, 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 org.apache.hadoop.yarn.api.protocolrecords.FinishApplicationMasterResponse	finishAMWithReRegister(org.apache.hadoop.yarn.api.protocolrecords.FinishApplicationMasterRequest request, org.apache.hadoop.yarn.api.ApplicationMasterProtocol rmProxy, org.apache.hadoop.yarn.api.protocolrecords.RegisterApplicationMasterRequest registerRequest, org.apache.hadoop.yarn.api.records.ApplicationId appId) Helper method for client calling ApplicationMasterProtocol.finishApplicationMaster that handles re-register if RM fails over.
static void	handleNotRegisteredExceptionAndReRegister(org.apache.hadoop.yarn.api.records.ApplicationId appId, org.apache.hadoop.yarn.api.ApplicationMasterProtocol rmProxy, org.apache.hadoop.yarn.api.protocolrecords.RegisterApplicationMasterRequest registerRequest) Handle ApplicationNotRegistered exception and re-register.

Methods inherited from class java.lang.Object

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

Field Detail

APP_ALREADY_REGISTERED_MESSAGE

public static final String APP_ALREADY_REGISTERED_MESSAGE

See Also:

Constant Field Values

Method Detail

handleNotRegisteredExceptionAndReRegister

public static void handleNotRegisteredExceptionAndReRegister(org.apache.hadoop.yarn.api.records.ApplicationId appId,
                                                             org.apache.hadoop.yarn.api.ApplicationMasterProtocol rmProxy,
                                                             org.apache.hadoop.yarn.api.protocolrecords.RegisterApplicationMasterRequest registerRequest)
                                                      throws org.apache.hadoop.yarn.exceptions.YarnException

Handle ApplicationNotRegistered exception and re-register.

Parameters:

appId - application Id

rmProxy - RM proxy instance

registerRequest - the AM re-register request

Throws:

org.apache.hadoop.yarn.exceptions.YarnException - if re-register fails

allocateWithReRegister

public static org.apache.hadoop.yarn.api.protocolrecords.AllocateResponse allocateWithReRegister(org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest request,
                                                                                                 org.apache.hadoop.yarn.api.ApplicationMasterProtocol rmProxy,
                                                                                                 org.apache.hadoop.yarn.api.protocolrecords.RegisterApplicationMasterRequest registerRequest,
                                                                                                 org.apache.hadoop.yarn.api.records.ApplicationId appId)
                                                                                          throws org.apache.hadoop.yarn.exceptions.YarnException,
                                                                                                 IOException

Helper method for client calling ApplicationMasterProtocol.allocate that handles re-register if RM fails over.

Parameters:

request - allocate request

rmProxy - RM proxy

registerRequest - the register request for re-register

appId - application id

Returns:

allocate response

Throws:

org.apache.hadoop.yarn.exceptions.YarnException - if RM call fails

IOException - if RM call fails

finishAMWithReRegister

public static org.apache.hadoop.yarn.api.protocolrecords.FinishApplicationMasterResponse finishAMWithReRegister(org.apache.hadoop.yarn.api.protocolrecords.FinishApplicationMasterRequest request,
                                                                                                                org.apache.hadoop.yarn.api.ApplicationMasterProtocol rmProxy,
                                                                                                                org.apache.hadoop.yarn.api.protocolrecords.RegisterApplicationMasterRequest registerRequest,
                                                                                                                org.apache.hadoop.yarn.api.records.ApplicationId appId)
                                                                                                         throws org.apache.hadoop.yarn.exceptions.YarnException,
                                                                                                                IOException

Helper method for client calling ApplicationMasterProtocol.finishApplicationMaster that handles re-register if RM fails over.

Parameters:

request - finishApplicationMaster request

rmProxy - RM proxy

registerRequest - the register request for re-register

appId - application id

Returns:

finishApplicationMaster response

Throws:

org.apache.hadoop.yarn.exceptions.YarnException - if RM call fails

IOException - if RM call fails

createRMProxy

@InterfaceAudience.Public
 @InterfaceStability.Unstable
public static <T> T createRMProxy(org.apache.hadoop.conf.Configuration configuration,
                                                                                          Class<T> protocol,
                                                                                          org.apache.hadoop.security.UserGroupInformation user,
                                                                                          org.apache.hadoop.security.token.Token<? extends org.apache.hadoop.security.token.TokenIdentifier> token)
                                                                                   throws 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:

IOException - on failure