org.apache.hadoop.yarn.client

Class RMProxy<T>

java.lang.Object

org.apache.hadoop.yarn.client.RMProxy<T>

Direct Known Subclasses:

ClientRMProxy

@InterfaceAudience.Public
@InterfaceStability.Evolving
public class RMProxy<T>
extends Object

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RMProxy()

Method Summary

Methods

Modifier and Type	Method and Description
void	checkAllowedProtocols(Class<?> protocol) Verify the passed protocol is supported.
static org.apache.hadoop.io.retry.RetryPolicy	createRetryPolicy(org.apache.hadoop.conf.Configuration conf, boolean isHAEnabled) Fetch retry policy from Configuration
protected static org.apache.hadoop.io.retry.RetryPolicy	createRetryPolicy(org.apache.hadoop.conf.Configuration conf, long retryTime, long retryInterval, boolean isHAEnabled) Fetch retry policy from Configuration and create the retry policy with specified retryTime and retry interval.
protected static <T> T	createRMProxy(org.apache.hadoop.conf.Configuration configuration, Class<T> protocol, RMProxy<T> instance) Currently, used by Client and AM only Create a proxy for the specified protocol.
protected static <T> T	createRMProxy(org.apache.hadoop.conf.Configuration configuration, Class<T> protocol, RMProxy<T> instance, long retryTime, long retryInterval) Currently, used by NodeManagers only.
<T> T	getProxy(org.apache.hadoop.conf.Configuration conf, Class<T> protocol, InetSocketAddress rmAddress) Get a proxy to the RM at the specified address.
InetSocketAddress	getRMAddress(org.apache.hadoop.yarn.conf.YarnConfiguration conf, Class<?> protocol) Get the ResourceManager address from the provided Configuration for the given protocol.

Methods inherited from class java.lang.Object

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

Constructor Detail

RMProxy

protected RMProxy()

Method Detail

checkAllowedProtocols

@InterfaceAudience.Private
public void checkAllowedProtocols(Class<?> protocol)

Verify the passed protocol is supported.

getRMAddress

@InterfaceAudience.Private
public InetSocketAddress getRMAddress(org.apache.hadoop.yarn.conf.YarnConfiguration conf,
                                                       Class<?> protocol)
                               throws IOException

Get the ResourceManager address from the provided Configuration for the given protocol.

Throws:

IOException

createRMProxy

@InterfaceAudience.Private
protected static <T> T createRMProxy(org.apache.hadoop.conf.Configuration configuration,
                                            Class<T> protocol,
                                            RMProxy<T> instance)
                          throws IOException

Currently, used by Client and AM only Create a proxy for the specified protocol. For non-HA, this is a direct connection to the ResourceManager address. When HA is enabled, the proxy handles the failover between the ResourceManagers as well.

Throws:

IOException

createRMProxy

@InterfaceAudience.Private
protected static <T> T createRMProxy(org.apache.hadoop.conf.Configuration configuration,
                                            Class<T> protocol,
                                            RMProxy<T> instance,
                                            long retryTime,
                                            long retryInterval)
                          throws IOException

Currently, used by NodeManagers only. Create a proxy for the specified protocol. For non-HA, this is a direct connection to the ResourceManager address. When HA is enabled, the proxy handles the failover between the ResourceManagers as well.

Throws:

IOException

getProxy

@InterfaceAudience.Private
public <T> T getProxy(org.apache.hadoop.conf.Configuration conf,
                                       Class<T> protocol,
                                       InetSocketAddress rmAddress)
           throws IOException

Get a proxy to the RM at the specified address. To be used to create a RetryProxy.

Throws:

IOException

createRetryPolicy

@InterfaceAudience.Private
public static org.apache.hadoop.io.retry.RetryPolicy createRetryPolicy(org.apache.hadoop.conf.Configuration conf,
                                                                                 boolean isHAEnabled)

Fetch retry policy from Configuration

createRetryPolicy

protected static org.apache.hadoop.io.retry.RetryPolicy createRetryPolicy(org.apache.hadoop.conf.Configuration conf,
                                                       long retryTime,
                                                       long retryInterval,
                                                       boolean isHAEnabled)

Fetch retry policy from Configuration and create the retry policy with specified retryTime and retry interval.