org.apache.slider.server.appmaster.rpc

Class RpcBinder

java.lang.Object

org.apache.slider.server.appmaster.rpc.RpcBinder

public class RpcBinder
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.slf4j.Logger	log

Constructor Summary

Constructors

Constructor and Description
RpcBinder()

Method Summary

Methods

Modifier and Type	Method and Description
static SliderClusterProtocol	connectToServer(InetSocketAddress addr, org.apache.hadoop.security.UserGroupInformation currentUser, org.apache.hadoop.conf.Configuration conf, int rpcTimeout) Connect to a server.
static org.apache.hadoop.ipc.Server	createProtobufServer(InetSocketAddress addr, org.apache.hadoop.conf.Configuration conf, org.apache.hadoop.security.token.SecretManager<? extends org.apache.hadoop.security.token.TokenIdentifier> secretManager, int numHandlers, com.google.protobuf.BlockingService blockingService, String portRangeConfig) Create a protobuf server bonded to the specific socket address
static SliderClusterProtocol	createProxy(org.apache.hadoop.conf.Configuration conf, String host, int port, org.apache.hadoop.yarn.api.records.Token clientToAMToken, int rpcTimeout)
static SliderClusterProtocol	getProxy(org.apache.hadoop.conf.Configuration conf, org.apache.hadoop.yarn.api.ApplicationClientProtocol rmClient, org.apache.hadoop.yarn.api.records.ApplicationReport application, int connectTimeout, int rpcTimeout) This loops for a limited period trying to get the Proxy - by doing so it handles AM failover
static SliderClusterProtocol	getProxy(org.apache.hadoop.conf.Configuration conf, org.apache.hadoop.yarn.api.records.ApplicationReport application, int rpcTimeout) Get a proxy from the application report
static Class<SliderClusterProtocolPB>	registerSliderAPI(org.apache.hadoop.conf.Configuration conf) Add the protobuf engine to the configuration.
static boolean	verifyBondedToProtobuf(org.apache.hadoop.conf.Configuration conf, Class<SliderClusterProtocolPB> sliderClusterAPIClass) Verify that the conf is set up for protobuf transport of Slider RPC

Methods inherited from class java.lang.Object

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

Field Detail

log

protected static final org.slf4j.Logger log

Constructor Detail

RpcBinder

public RpcBinder()

Method Detail

createProtobufServer

public static org.apache.hadoop.ipc.Server createProtobufServer(InetSocketAddress addr,
                                                org.apache.hadoop.conf.Configuration conf,
                                                org.apache.hadoop.security.token.SecretManager<? extends org.apache.hadoop.security.token.TokenIdentifier> secretManager,
                                                int numHandlers,
                                                com.google.protobuf.BlockingService blockingService,
                                                String portRangeConfig)
                                                         throws IOException

Create a protobuf server bonded to the specific socket address

Parameters:

addr - address to listen to; 0.0.0.0 as hostname acceptable

conf - config

secretManager - token secret handler

numHandlers - threads to service requests

blockingService - service to handle

portRangeConfig - range of ports

Returns:

the IPC server itself

Throws:

IOException

registerSliderAPI

public static Class<SliderClusterProtocolPB> registerSliderAPI(org.apache.hadoop.conf.Configuration conf)

Add the protobuf engine to the configuration. Harmless and inexpensive if repeated.

Parameters:

conf - configuration to patch

Returns:

the protocol class

verifyBondedToProtobuf

public static boolean verifyBondedToProtobuf(org.apache.hadoop.conf.Configuration conf,
                             Class<SliderClusterProtocolPB> sliderClusterAPIClass)

Verify that the conf is set up for protobuf transport of Slider RPC

Parameters:

conf - configuration

sliderClusterAPIClass - class for the API

Returns:

true if the RPC engine is protocol buffers

connectToServer

public static SliderClusterProtocol connectToServer(InetSocketAddress addr,
                                    org.apache.hadoop.security.UserGroupInformation currentUser,
                                    org.apache.hadoop.conf.Configuration conf,
                                    int rpcTimeout)
                                             throws IOException

Connect to a server. May include setting up retry policies

Parameters:

addr -

currentUser -

conf -

rpcTimeout -

Returns:

Throws:

IOException

getProxy

public static SliderClusterProtocol getProxy(org.apache.hadoop.conf.Configuration conf,
                             org.apache.hadoop.yarn.api.ApplicationClientProtocol rmClient,
                             org.apache.hadoop.yarn.api.records.ApplicationReport application,
                             int connectTimeout,
                             int rpcTimeout)
                                      throws IOException,
                                             org.apache.hadoop.yarn.exceptions.YarnException,
                                             InterruptedException

This loops for a limited period trying to get the Proxy - by doing so it handles AM failover

Parameters:

conf - configuration to patch and use

rmClient - client of the resource manager

application - application to work with

connectTimeout - timeout for the whole proxy operation to timeout (milliseconds). Use 0 to indicate "do not attempt to wait" -fail fast.

rpcTimeout - timeout for RPCs to block during communications

Returns:

the proxy

Throws:

IOException - IO problems

org.apache.hadoop.yarn.exceptions.YarnException - Slider-generated exceptions related to the binding failing. This can include the application finishing or timeouts

InterruptedException - if a sleep operation waiting for the cluster to respond is interrupted.

getProxy

public static SliderClusterProtocol getProxy(org.apache.hadoop.conf.Configuration conf,
                             org.apache.hadoop.yarn.api.records.ApplicationReport application,
                             int rpcTimeout)
                                      throws IOException,
                                             SliderException,
                                             InterruptedException

Get a proxy from the application report

Parameters:

conf - config to use

application - app report

rpcTimeout - timeout in RPC operations

Returns:

the proxy

Throws:

IOException

SliderException

InterruptedException

createProxy

public static SliderClusterProtocol createProxy(org.apache.hadoop.conf.Configuration conf,
                                String host,
                                int port,
                                org.apache.hadoop.yarn.api.records.Token clientToAMToken,
                                int rpcTimeout)
                                         throws SliderException,
                                                IOException,
                                                InterruptedException

Parameters:

conf - config to use

host - hosname

port - port

clientToAMToken - auth token: only used in a secure cluster. converted via ConverterUtils.convertFromYarn(org.apache.hadoop.yarn.api.records.Token, InetSocketAddress)

rpcTimeout - timeout in RPC operations

Returns:

the proxy

Throws:

SliderException

IOException

InterruptedException