org.apache.flink.client

Class CliFrontend

java.lang.Object

org.apache.flink.client.CliFrontend

public class CliFrontend
extends Object

Implementation of a simple command line frontend for executing programs.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ACTION_INFO
static String	ACTION_RUN
static String	YARN_DEPLOY_JOBMANAGER A special host name used to run a job by deploying Flink into a YARN cluster, if this string is specified as the JobManager address
static String	YARN_DYNAMIC_PROPERTIES_SEPARATOR
static String	YARN_PROPERTIES_DYNAMIC_PROPERTIES_STRING
static String	YARN_PROPERTIES_FILE
static String	YARN_PROPERTIES_JOBMANAGER_KEY
static String	YARN_PROPERTIES_PARALLELISM

Constructor Summary

Constructors

Constructor and Description
CliFrontend()
CliFrontend(String configDir)

Method Summary

Methods

Modifier and Type	Method and Description
protected PackagedProgram	buildProgram(ProgramOptions options) Creates a Packaged program from the given command line options.
protected int	cancel(String[] args) Executes the CANCEL action.
protected int	executeProgramBlocking(PackagedProgram program, Client client, int parallelism)
protected int	executeProgramDetached(PackagedProgram program, Client client, int parallelism)
protected Client	getClient(CommandLineOptions options, String programName, int userParallelism) Retrieves a Client object from the given command line options and other parameters.
Configuration	getConfiguration() Getter which returns a copy of the associated configuration
static String	getConfigurationDirectoryFromEnv()
static List<Tuple2<String,String>>	getDynamicProperties(String dynamicPropertiesEncoded)
FlinkPlan	getFlinkPlan()
protected ActorGateway	getJobManagerGateway(CommandLineOptions options) Retrieves the ActorGateway for the JobManager.
PackagedProgram	getPackagedProgram()
protected int	info(String[] args) Executes the info action.
protected int	list(String[] args) Executes the list action.
static void	main(String[] args) Submits the job based on the arguments
int	parseParameters(String[] args) Parses the command line arguments and starts the requested action.
protected int	run(String[] args) Executions the run action.
void	shutdown()
protected void	updateConfig(CommandLineOptions options) Updates the associated configuration with the given command line options
protected void	writeJobManagerAddressToConfig(InetSocketAddress address) Writes the given job manager address to the associated configuration object

Methods inherited from class java.lang.Object

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

Field Detail

ACTION_RUN

public static final String ACTION_RUN

See Also:

Constant Field Values

ACTION_INFO

public static final String ACTION_INFO

See Also:

Constant Field Values

YARN_PROPERTIES_FILE

public static final String YARN_PROPERTIES_FILE

See Also:

Constant Field Values

YARN_PROPERTIES_JOBMANAGER_KEY

public static final String YARN_PROPERTIES_JOBMANAGER_KEY

See Also:

Constant Field Values

YARN_PROPERTIES_PARALLELISM

public static final String YARN_PROPERTIES_PARALLELISM

See Also:

Constant Field Values

YARN_PROPERTIES_DYNAMIC_PROPERTIES_STRING

public static final String YARN_PROPERTIES_DYNAMIC_PROPERTIES_STRING

See Also:

Constant Field Values

YARN_DYNAMIC_PROPERTIES_SEPARATOR

public static final String YARN_DYNAMIC_PROPERTIES_SEPARATOR

See Also:

Constant Field Values

YARN_DEPLOY_JOBMANAGER

public static final String YARN_DEPLOY_JOBMANAGER

A special host name used to run a job by deploying Flink into a YARN cluster, if this string is specified as the JobManager address

See Also:

Constant Field Values

Constructor Detail

CliFrontend

public CliFrontend()
            throws Exception

Throws:

Exception - Thrown if the configuration directory was not found, the configuration could not be loaded, or the YARN properties could not be parsed.

CliFrontend

public CliFrontend(String configDir)
            throws Exception

Throws:

Exception

Method Detail

getConfiguration

public Configuration getConfiguration()

Getter which returns a copy of the associated configuration

Returns:

Copy of the associated configuration

run

protected int run(String[] args)

Executions the run action.

Parameters:

args - Command line arguments for the run action.

info

protected int info(String[] args)

Executes the info action.

Parameters:

args - Command line arguments for the info action.

list

protected int list(String[] args)

Executes the list action.

Parameters:

args - Command line arguments for the list action.

cancel

protected int cancel(String[] args)

Executes the CANCEL action.

Parameters:

args - Command line arguments for the cancel action.

executeProgramDetached

protected int executeProgramDetached(PackagedProgram program,
                         Client client,
                         int parallelism)

executeProgramBlocking

protected int executeProgramBlocking(PackagedProgram program,
                         Client client,
                         int parallelism)

buildProgram

protected PackagedProgram buildProgram(ProgramOptions options)
                                throws FileNotFoundException,
                                       ProgramInvocationException

Creates a Packaged program from the given command line options.

Returns:

A PackagedProgram (upon success)

Throws:

FileNotFoundException

ProgramInvocationException

writeJobManagerAddressToConfig

protected void writeJobManagerAddressToConfig(InetSocketAddress address)

Writes the given job manager address to the associated configuration object

Parameters:

address - Address to write to the configuration

updateConfig

protected void updateConfig(CommandLineOptions options)

Updates the associated configuration with the given command line options

Parameters:

options - Command line options

getJobManagerGateway

protected ActorGateway getJobManagerGateway(CommandLineOptions options)
                                     throws Exception

Retrieves the ActorGateway for the JobManager. The JobManager address is retrieved from the provided CommandLineOptions.

Parameters:

options - CommandLineOptions specifying the JobManager URL

Returns:

Gateway to the JobManager

Throws:

Exception

getClient

protected Client getClient(CommandLineOptions options,
               String programName,
               int userParallelism)
                    throws Exception

Retrieves a Client object from the given command line options and other parameters.

Parameters:

options - Command line options which contain JobManager address

programName - Program name

userParallelism - Given user parallelism

Returns:

Throws:

Exception

parseParameters

public int parseParameters(String[] args)

Parses the command line arguments and starts the requested action.

Parameters:

args - command line arguments of the client.

Returns:

The return code of the program

getFlinkPlan

public FlinkPlan getFlinkPlan()

getPackagedProgram

public PackagedProgram getPackagedProgram()

shutdown

public void shutdown()

main

public static void main(String[] args)

Submits the job based on the arguments

getConfigurationDirectoryFromEnv

public static String getConfigurationDirectoryFromEnv()

getDynamicProperties

public static List<Tuple2<String,String>> getDynamicProperties(String dynamicPropertiesEncoded)