org.apache.flink.client.cli

Class CliFrontend

java.lang.Object

org.apache.flink.client.cli.CliFrontend

public class CliFrontend
extends Object

Implementation of a simple command line frontend for executing programs.

Constructor Summary

Constructors

Constructor and Description
CliFrontend(org.apache.flink.configuration.Configuration configuration, List<CustomCommandLine<?>> customCommandLines)

Method Summary

Modifier and Type	Method and Description
protected void	cancel(String[] args) Executes the CANCEL action.
protected void	executeProgram(PackagedProgram program, ClusterClient<?> client, int parallelism)
CustomCommandLine<?>	getActiveCustomCommandLine(org.apache.commons.cli.CommandLine commandLine) Gets the custom command-line for the arguments.
org.apache.flink.configuration.Configuration	getConfiguration() Getter which returns a copy of the associated configuration.
static String	getConfigurationDirectoryFromEnv()
org.apache.commons.cli.Options	getCustomCommandLineOptions()
protected void	info(String[] args) Executes the info action.
protected void	list(String[] args) Executes the list action.
static List<CustomCommandLine<?>>	loadCustomCommandLines(org.apache.flink.configuration.Configuration configuration, String configurationDirectory)
static void	main(String[] args) Submits the job based on the arguments.
protected void	modify(String[] args)
int	parseParameters(String[] args) Parses the command line arguments and starts the requested action.
protected void	run(String[] args) Executions the run action.
protected void	savepoint(String[] args) Executes the SAVEPOINT action.
protected void	stop(String[] args) Executes the STOP action.

Methods inherited from class java.lang.Object

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

Constructor Detail

CliFrontend

public CliFrontend(org.apache.flink.configuration.Configuration configuration,
                   List<CustomCommandLine<?>> customCommandLines)
            throws Exception

Throws:

Exception

Method Detail

getConfiguration

public org.apache.flink.configuration.Configuration getConfiguration()

Getter which returns a copy of the associated configuration.

Returns:

Copy of the associated configuration

getCustomCommandLineOptions

public org.apache.commons.cli.Options getCustomCommandLineOptions()

run

protected void run(String[] args)
            throws Exception

Executions the run action.

Parameters:

args - Command line arguments for the run action.

Throws:

Exception

info

protected void info(String[] args)
             throws CliArgsException,
                    FileNotFoundException,
                    ProgramInvocationException

Executes the info action.

Parameters:

args - Command line arguments for the info action.

Throws:

CliArgsException

FileNotFoundException

ProgramInvocationException

list

protected void list(String[] args)
             throws Exception

Executes the list action.

Parameters:

args - Command line arguments for the list action.

Throws:

Exception

stop

protected void stop(String[] args)
             throws Exception

Executes the STOP action.

Parameters:

args - Command line arguments for the stop action.

Throws:

Exception

cancel

protected void cancel(String[] args)
               throws Exception

Executes the CANCEL action.

Parameters:

args - Command line arguments for the cancel action.

Throws:

Exception

savepoint

protected void savepoint(String[] args)
                  throws Exception

Executes the SAVEPOINT action.

Parameters:

args - Command line arguments for the savepoint action.

Throws:

Exception

modify

protected void modify(String[] args)
               throws CliArgsException,
                      org.apache.flink.util.FlinkException

Throws:

CliArgsException

org.apache.flink.util.FlinkException

executeProgram

protected void executeProgram(PackagedProgram program,
                              ClusterClient<?> client,
                              int parallelism)
                       throws ProgramMissingJobException,
                              ProgramInvocationException

Throws:

ProgramMissingJobException

ProgramInvocationException

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

main

public static void main(String[] args)

Submits the job based on the arguments.

getConfigurationDirectoryFromEnv

public static String getConfigurationDirectoryFromEnv()

loadCustomCommandLines

public static List<CustomCommandLine<?>> loadCustomCommandLines(org.apache.flink.configuration.Configuration configuration,
                                                                String configurationDirectory)

getActiveCustomCommandLine

public CustomCommandLine<?> getActiveCustomCommandLine(org.apache.commons.cli.CommandLine commandLine)

Gets the custom command-line for the arguments.

Parameters:

commandLine - The input to the command-line.

Returns:

custom command-line which is active (may only be one at a time)