org.apache.flink.client.cli

Class DefaultCLI

java.lang.Object

org.apache.flink.client.cli.DefaultCLI

All Implemented Interfaces:

CustomCommandLine<StandaloneClusterClient>

public class DefaultCLI
extends Object
implements CustomCommandLine<StandaloneClusterClient>

The default CLI which is used for interaction with standalone clusters.

Constructor Summary

Constructors

Constructor and Description
DefaultCLI()

Method Summary

Methods

Modifier and Type	Method and Description
void	addGeneralOptions(org.apache.commons.cli.Options baseOptions) Adds custom options to the existing general options.
void	addRunOptions(org.apache.commons.cli.Options baseOptions) Adds custom options to the existing run options.
StandaloneClusterClient	createCluster(String applicationName, org.apache.commons.cli.CommandLine commandLine, Configuration config, List<URL> userJarFiles) Creates the client for the cluster
String	getId() Gets the unique identifier of this CustomCommandLine
boolean	isActive(org.apache.commons.cli.CommandLine commandLine, Configuration configuration) Signals whether the custom command-line wants to execute or not
StandaloneClusterClient	retrieveCluster(org.apache.commons.cli.CommandLine commandLine, Configuration config) Retrieves a client for a running cluster

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultCLI

public DefaultCLI()

Method Detail

isActive

public boolean isActive(org.apache.commons.cli.CommandLine commandLine,
               Configuration configuration)

Description copied from interface: CustomCommandLine

Signals whether the custom command-line wants to execute or not

Specified by:

isActive in interface CustomCommandLine<StandaloneClusterClient>

Parameters:

commandLine - The command-line options

configuration - The Flink configuration

Returns:

True if the command-line wants to run, False otherwise

getId

public String getId()

Description copied from interface: CustomCommandLine

Gets the unique identifier of this CustomCommandLine

Specified by:

getId in interface CustomCommandLine<StandaloneClusterClient>

Returns:

A unique identifier

addRunOptions

public void addRunOptions(org.apache.commons.cli.Options baseOptions)

Description copied from interface: CustomCommandLine

Adds custom options to the existing run options.

Specified by:

addRunOptions in interface CustomCommandLine<StandaloneClusterClient>

Parameters:

baseOptions - The existing options.

addGeneralOptions

public void addGeneralOptions(org.apache.commons.cli.Options baseOptions)

Description copied from interface: CustomCommandLine

Adds custom options to the existing general options.

Specified by:

addGeneralOptions in interface CustomCommandLine<StandaloneClusterClient>

Parameters:

baseOptions - The existing options.

retrieveCluster

public StandaloneClusterClient retrieveCluster(org.apache.commons.cli.CommandLine commandLine,
                                      Configuration config)

Description copied from interface: CustomCommandLine

Retrieves a client for a running cluster

Specified by:

retrieveCluster in interface CustomCommandLine<StandaloneClusterClient>

Parameters:

commandLine - The command-line parameters from the CliFrontend

config - The Flink config

Returns:

Client if a cluster could be retrieved

createCluster

public StandaloneClusterClient createCluster(String applicationName,
                                    org.apache.commons.cli.CommandLine commandLine,
                                    Configuration config,
                                    List<URL> userJarFiles)
                                      throws UnsupportedOperationException

Description copied from interface: CustomCommandLine

Creates the client for the cluster

Specified by:

createCluster in interface CustomCommandLine<StandaloneClusterClient>

Parameters:

applicationName - The application name to use

commandLine - The command-line options parsed by the CliFrontend

config - The Flink config to use

userJarFiles - User jar files to include in the classpath of the cluster.

Returns:

The client to communicate with the cluster which the CustomCommandLine brought up.

Throws:

UnsupportedOperationException - if the operation is not supported