org.apache.tez.client

Class FrameworkClient

java.lang.Object

org.apache.tez.client.FrameworkClient

Direct Known Subclasses:

TezYarnClient

@InterfaceAudience.Private
public abstract class FrameworkClient
extends Object

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
FrameworkClient()

Method Summary

Modifier and Type	Method and Description
abstract void	close()
abstract org.apache.hadoop.yarn.client.api.YarnClientApplication	createApplication()
static FrameworkClient	createFrameworkClient(TezConfiguration tezConf)
abstract String	getAmHost()
abstract int	getAmPort()
TezAppMasterStatus	getAMStatus(org.apache.hadoop.conf.Configuration conf, org.apache.hadoop.yarn.api.records.ApplicationId appId, org.apache.hadoop.security.UserGroupInformation ugi)
abstract org.apache.hadoop.yarn.api.records.ApplicationReport	getApplicationReport(org.apache.hadoop.yarn.api.records.ApplicationId appId)
DAGClient	getDAGClient(org.apache.hadoop.yarn.api.records.ApplicationId appId, String dagId, TezConfiguration tezConf, org.apache.hadoop.security.UserGroupInformation ugi)
protected DAGClientAMProtocolBlockingPB	getProxy(org.apache.hadoop.conf.Configuration conf, org.apache.hadoop.yarn.api.records.ApplicationId sessionAppId, org.apache.hadoop.security.UserGroupInformation ugi)
abstract void	init(TezConfiguration tezConf) Initialize the framework client.
abstract boolean	isRunning()
abstract void	killApplication(org.apache.hadoop.yarn.api.records.ApplicationId appId)
boolean	shutdownSession(org.apache.hadoop.conf.Configuration conf, org.apache.hadoop.yarn.api.records.ApplicationId sessionAppId, org.apache.hadoop.security.UserGroupInformation ugi) Shuts down session and returns a boolean=true if a proxy was successfully created and through that proxy a shutdownSession was called.
abstract void	start()
abstract void	stop()
abstract org.apache.hadoop.yarn.api.records.ApplicationId	submitApplication(org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext appSubmissionContext)
DAGClient	submitDag(DAG dag, DAGClientAMProtocolRPC.SubmitDAGRequestProto request, String clientName, org.apache.hadoop.yarn.api.records.ApplicationId sessionAppId, long clientTimeout, org.apache.hadoop.security.UserGroupInformation ugi, TezConfiguration tezConf)
protected DAGClientAMProtocolBlockingPB	waitForProxy(long clientTimeout, org.apache.hadoop.conf.Configuration conf, org.apache.hadoop.yarn.api.records.ApplicationId sessionAppId, org.apache.hadoop.security.UserGroupInformation ugi)

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

FrameworkClient

public FrameworkClient()

Method Detail

createFrameworkClient

public static FrameworkClient createFrameworkClient(TezConfiguration tezConf)

init

public abstract void init(TezConfiguration tezConf)

Initialize the framework client.

The actual implementation of FramworkClient may modify the configuration instances that are passed in to configure required functionality

Parameters:

tezConf - the TezConfiguration instance being used by the cluster

start

public abstract void start()

stop

public abstract void stop()

close

public abstract void close()
                    throws IOException

Throws:

IOException

createApplication

public abstract org.apache.hadoop.yarn.client.api.YarnClientApplication createApplication()
                                                                                   throws org.apache.hadoop.yarn.exceptions.YarnException,
                                                                                          IOException

Throws:

org.apache.hadoop.yarn.exceptions.YarnException

IOException

submitApplication

public abstract org.apache.hadoop.yarn.api.records.ApplicationId submitApplication(org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext appSubmissionContext)
                                                                            throws org.apache.hadoop.yarn.exceptions.YarnException,
                                                                                   IOException,
                                                                                   TezException

Throws:

org.apache.hadoop.yarn.exceptions.YarnException

IOException

TezException

killApplication

public abstract void killApplication(org.apache.hadoop.yarn.api.records.ApplicationId appId)
                              throws org.apache.hadoop.yarn.exceptions.YarnException,
                                     IOException

Throws:

org.apache.hadoop.yarn.exceptions.YarnException

IOException

getApplicationReport

public abstract org.apache.hadoop.yarn.api.records.ApplicationReport getApplicationReport(org.apache.hadoop.yarn.api.records.ApplicationId appId)
                                                                                   throws org.apache.hadoop.yarn.exceptions.YarnException,
                                                                                          IOException

Throws:

org.apache.hadoop.yarn.exceptions.YarnException

IOException

getAmHost

public abstract String getAmHost()

getAmPort

public abstract int getAmPort()

isRunning

public abstract boolean isRunning()
                           throws IOException

Throws:

IOException

getAMStatus

public TezAppMasterStatus getAMStatus(org.apache.hadoop.conf.Configuration conf,
                                      org.apache.hadoop.yarn.api.records.ApplicationId appId,
                                      org.apache.hadoop.security.UserGroupInformation ugi)
                               throws TezException,
                                      com.google.protobuf.ServiceException,
                                      IOException

Throws:

TezException

com.google.protobuf.ServiceException

IOException

submitDag

public DAGClient submitDag(DAG dag,
                           DAGClientAMProtocolRPC.SubmitDAGRequestProto request,
                           String clientName,
                           org.apache.hadoop.yarn.api.records.ApplicationId sessionAppId,
                           long clientTimeout,
                           org.apache.hadoop.security.UserGroupInformation ugi,
                           TezConfiguration tezConf)
                    throws IOException,
                           TezException,
                           DAGSubmissionTimedOut

Throws:

IOException

TezException

DAGSubmissionTimedOut

waitForProxy

protected DAGClientAMProtocolBlockingPB waitForProxy(long clientTimeout,
                                                     org.apache.hadoop.conf.Configuration conf,
                                                     org.apache.hadoop.yarn.api.records.ApplicationId sessionAppId,
                                                     org.apache.hadoop.security.UserGroupInformation ugi)
                                              throws IOException,
                                                     TezException,
                                                     InterruptedException

Throws:

IOException

TezException

InterruptedException

shutdownSession

public boolean shutdownSession(org.apache.hadoop.conf.Configuration conf,
                               org.apache.hadoop.yarn.api.records.ApplicationId sessionAppId,
                               org.apache.hadoop.security.UserGroupInformation ugi)
                        throws TezException,
                               IOException,
                               com.google.protobuf.ServiceException

Shuts down session and returns a boolean=true if a proxy was successfully created and through that proxy a shutdownSession was called.

Throws:

TezException

IOException

com.google.protobuf.ServiceException

getProxy

protected DAGClientAMProtocolBlockingPB getProxy(org.apache.hadoop.conf.Configuration conf,
                                                 org.apache.hadoop.yarn.api.records.ApplicationId sessionAppId,
                                                 org.apache.hadoop.security.UserGroupInformation ugi)
                                          throws TezException,
                                                 IOException

Throws:

TezException

IOException

getDAGClient

public DAGClient getDAGClient(org.apache.hadoop.yarn.api.records.ApplicationId appId,
                              String dagId,
                              TezConfiguration tezConf,
                              org.apache.hadoop.security.UserGroupInformation ugi)