org.apache.flink.client.program

Class PackagedProgram

java.lang.Object

org.apache.flink.client.program.PackagedProgram

public class PackagedProgram
extends Object

This class encapsulates represents a program, packaged in a jar file. It supplies functionality to extract nested libraries, search for the program entry point, and extract a program plan.

Field Summary

Fields

Modifier and Type	Field and Description
static String	MANIFEST_ATTRIBUTE_ASSEMBLER_CLASS Property name of the entry in JAR manifest file that describes the Flink specific entry point.
static String	MANIFEST_ATTRIBUTE_MAIN_CLASS Property name of the entry in JAR manifest file that describes the class with the main method.

Constructor Summary

Constructors

Constructor and Description
PackagedProgram(File jarFile, List<URL> classpaths, String... args) Creates an instance that wraps the plan defined in the jar file using the given argument.
PackagedProgram(File jarFile, List<URL> classpaths, String entryPointClassName, String... args) Creates an instance that wraps the plan defined in the jar file using the given arguments.
PackagedProgram(File jarFile, String... args) Creates an instance that wraps the plan defined in the jar file using the given argument.
PackagedProgram(File jarFile, String entryPointClassName, String... args) Creates an instance that wraps the plan defined in the jar file using the given arguments.

Method Summary

Modifier and Type	Method and Description
void	deleteExtractedLibraries() Deletes all temporary files created for contained packaged libraries.
List<URL>	getAllLibraries()
String[]	getArguments()
List<URL>	getClasspaths() Returns the classpaths that are required by the program.
String	getDescription() Returns the description provided by the Program class.
String	getMainClassName()
JobWithJars	getPlanWithJars() Returns the plan with all required jars.
String	getPreviewPlan() Returns the analyzed plan without any optimizations.
String	getSavepointPath()
ClassLoader	getUserCodeClassLoader() Gets the ClassLoader that must be used to load user code classes.
void	invokeInteractiveModeForExecution() This method assumes that the context environment is prepared, or the execution will be a local execution by default.
boolean	isUsingInteractiveMode()
boolean	isUsingProgramEntryPoint()
void	setSavepointPath(String savepointPath)

Methods inherited from class java.lang.Object

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

Field Detail

MANIFEST_ATTRIBUTE_ASSEMBLER_CLASS

public static final String MANIFEST_ATTRIBUTE_ASSEMBLER_CLASS

Property name of the entry in JAR manifest file that describes the Flink specific entry point.

See Also:

Constant Field Values

MANIFEST_ATTRIBUTE_MAIN_CLASS

public static final String MANIFEST_ATTRIBUTE_MAIN_CLASS

Property name of the entry in JAR manifest file that describes the class with the main method.

See Also:

Constant Field Values

Constructor Detail

PackagedProgram

public PackagedProgram(File jarFile,
                       String... args)
                throws ProgramInvocationException

Creates an instance that wraps the plan defined in the jar file using the given argument.

Parameters:

jarFile - The jar file which contains the plan and a Manifest which defines the program-class

args - Optional. The arguments used to create the pact plan, depend on implementation of the pact plan. See getDescription().

Throws:

ProgramInvocationException - This invocation is thrown if the Program can't be properly loaded. Causes may be a missing / wrong class or manifest files.

PackagedProgram

public PackagedProgram(File jarFile,
                       List<URL> classpaths,
                       String... args)
                throws ProgramInvocationException

Creates an instance that wraps the plan defined in the jar file using the given argument.

Parameters:

jarFile - The jar file which contains the plan and a Manifest which defines the program-class

classpaths - Additional classpath URLs needed by the Program.

args - Optional. The arguments used to create the pact plan, depend on implementation of the pact plan. See getDescription().

Throws:

ProgramInvocationException - This invocation is thrown if the Program can't be properly loaded. Causes may be a missing / wrong class or manifest files.

PackagedProgram

public PackagedProgram(File jarFile,
                       String entryPointClassName,
                       String... args)
                throws ProgramInvocationException

Creates an instance that wraps the plan defined in the jar file using the given arguments. For generating the plan the class defined in the className parameter is used.

Parameters:

jarFile - The jar file which contains the plan.

entryPointClassName - Name of the class which generates the plan. Overrides the class defined in the jar file manifest

args - Optional. The arguments used to create the pact plan, depend on implementation of the pact plan. See getDescription().

Throws:

ProgramInvocationException - This invocation is thrown if the Program can't be properly loaded. Causes may be a missing / wrong class or manifest files.

PackagedProgram

public PackagedProgram(File jarFile,
                       List<URL> classpaths,
                       String entryPointClassName,
                       String... args)
                throws ProgramInvocationException

Creates an instance that wraps the plan defined in the jar file using the given arguments. For generating the plan the class defined in the className parameter is used.

Parameters:

jarFile - The jar file which contains the plan.

classpaths - Additional classpath URLs needed by the Program.

entryPointClassName - Name of the class which generates the plan. Overrides the class defined in the jar file manifest

args - Optional. The arguments used to create the pact plan, depend on implementation of the pact plan. See getDescription().

Throws:

ProgramInvocationException - This invocation is thrown if the Program can't be properly loaded. Causes may be a missing / wrong class or manifest files.

Method Detail

setSavepointPath

public void setSavepointPath(String savepointPath)

getSavepointPath

public String getSavepointPath()

getArguments

public String[] getArguments()

getMainClassName

public String getMainClassName()

isUsingInteractiveMode

public boolean isUsingInteractiveMode()

isUsingProgramEntryPoint

public boolean isUsingProgramEntryPoint()

getPlanWithJars

public JobWithJars getPlanWithJars()
                            throws ProgramInvocationException

Returns the plan with all required jars.

Returns:

The plan with attached jar files.

Throws:

ProgramInvocationException

getPreviewPlan

public String getPreviewPlan()
                      throws ProgramInvocationException

Returns the analyzed plan without any optimizations.

Returns:

the analyzed plan without any optimizations.

Throws:

ProgramInvocationException - Thrown if an error occurred in the user-provided pact assembler. This may indicate missing parameters for generation.

getDescription

public String getDescription()
                      throws ProgramInvocationException

Returns the description provided by the Program class. This may contain a description of the plan itself and its arguments.

Returns:

The description of the PactProgram's input parameters.

Throws:

ProgramInvocationException - This invocation is thrown if the Program can't be properly loaded. Causes may be a missing / wrong class or manifest files.

invokeInteractiveModeForExecution

public void invokeInteractiveModeForExecution()
                                       throws ProgramInvocationException

This method assumes that the context environment is prepared, or the execution will be a local execution by default.

Throws:

ProgramInvocationException

getClasspaths

public List<URL> getClasspaths()

Returns the classpaths that are required by the program.

Returns:

List of URLs.

getUserCodeClassLoader

public ClassLoader getUserCodeClassLoader()

Gets the ClassLoader that must be used to load user code classes.

Returns:

The user code ClassLoader.

getAllLibraries

public List<URL> getAllLibraries()

deleteExtractedLibraries

public void deleteExtractedLibraries()

Deletes all temporary files created for contained packaged libraries.