eu.stratosphere.client.program

Class Client

java.lang.Object

eu.stratosphere.client.program.Client

public class Client
extends Object

Encapsulates the functionality necessary to submit a program to a remote cluster.

Constructor Summary

Constructors

Constructor and Description
Client(Configuration config) Creates a instance that submits the programs to the job-manager defined in the configuration.
Client(InetSocketAddress jobManagerAddress, Configuration config) Creates a new instance of the class that submits the jobs to a job-manager.

Method Summary

Methods

Modifier and Type	Method and Description
JobGraph	getJobGraph(PackagedProgram prog, OptimizedPlan optPlan)
String	getJobManagerAddress()
int	getJobManagerPort()
OptimizedPlan	getOptimizedPlan(JobWithJars prog, int parallelism) Creates the optimized plan for a given program, using this client's compiler.
OptimizedPlan	getOptimizedPlan(PackagedProgram prog, int parallelism)
OptimizedPlan	getOptimizedPlan(Plan p, int parallelism)
String	getOptimizedPlanAsJson(PackagedProgram prog, int parallelism)
JobExecutionResult	run(JobGraph jobGraph, boolean wait)
JobExecutionResult	run(JobWithJars prog, int parallelism, boolean wait) Runs a program on the nephele system whose job-manager is configured in this client's configuration.
JobExecutionResult	run(OptimizedPlan compiledPlan, List<File> libraries, boolean wait)
JobExecutionResult	run(PackagedProgram prog, int parallelism, boolean wait)
JobExecutionResult	run(PackagedProgram prog, OptimizedPlan optimizedPlan, boolean wait)
void	setPrintStatusDuringExecution(boolean print)

Methods inherited from class java.lang.Object

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

Constructor Detail

Client

public Client(InetSocketAddress jobManagerAddress,
      Configuration config)

Creates a new instance of the class that submits the jobs to a job-manager. at the given address using the default port.

Parameters:

jobManagerAddress - Address and port of the job-manager.

Client

public Client(Configuration config)

Creates a instance that submits the programs to the job-manager defined in the configuration.

Parameters:

config - The config used to obtain the job-manager's address.

Method Detail

setPrintStatusDuringExecution

public void setPrintStatusDuringExecution(boolean print)

getJobManagerAddress

public String getJobManagerAddress()

getJobManagerPort

public int getJobManagerPort()

getOptimizedPlanAsJson

public String getOptimizedPlanAsJson(PackagedProgram prog,
                            int parallelism)
                              throws CompilerException,
                                     ProgramInvocationException

Throws:

CompilerException

ProgramInvocationException

getOptimizedPlan

public OptimizedPlan getOptimizedPlan(PackagedProgram prog,
                             int parallelism)
                               throws CompilerException,
                                      ProgramInvocationException

Throws:

CompilerException

ProgramInvocationException

getOptimizedPlan

public OptimizedPlan getOptimizedPlan(Plan p,
                             int parallelism)
                               throws CompilerException

Throws:

CompilerException

getOptimizedPlan

public OptimizedPlan getOptimizedPlan(JobWithJars prog,
                             int parallelism)
                               throws CompilerException,
                                      ProgramInvocationException

Creates the optimized plan for a given program, using this client's compiler.

Parameters:

prog - The program to be compiled.

Returns:

The compiled and optimized plan, as returned by the compiler.

Throws:

CompilerException - Thrown, if the compiler encounters an illegal situation.

ProgramInvocationException - Thrown, if the program could not be instantiated from its jar file.

getJobGraph

public JobGraph getJobGraph(PackagedProgram prog,
                   OptimizedPlan optPlan)
                     throws ProgramInvocationException

Throws:

ProgramInvocationException

run

public JobExecutionResult run(PackagedProgram prog,
                     int parallelism,
                     boolean wait)
                       throws ProgramInvocationException

Throws:

ProgramInvocationException

run

public JobExecutionResult run(PackagedProgram prog,
                     OptimizedPlan optimizedPlan,
                     boolean wait)
                       throws ProgramInvocationException

Throws:

ProgramInvocationException

run

public JobExecutionResult run(JobWithJars prog,
                     int parallelism,
                     boolean wait)
                       throws CompilerException,
                              ProgramInvocationException

Runs a program on the nephele system whose job-manager is configured in this client's configuration. This method involves all steps, from compiling, job-graph generation to submission.

Parameters:

prog - The program to be executed.

wait - A flag that indicates whether this function call should block until the program execution is done.

Throws:

CompilerException - Thrown, if the compiler encounters an illegal situation.

ProgramInvocationException - Thrown, if the program could not be instantiated from its jar file, or if the submission failed. That might be either due to an I/O problem, i.e. the job-manager is unreachable, or due to the fact that the execution on the nephele system failed.

JobInstantiationException - Thrown, if the plan assembler function causes an exception.

run

public JobExecutionResult run(OptimizedPlan compiledPlan,
                     List<File> libraries,
                     boolean wait)
                       throws ProgramInvocationException

Throws:

ProgramInvocationException

run

public JobExecutionResult run(JobGraph jobGraph,
                     boolean wait)
                       throws ProgramInvocationException

Throws:

ProgramInvocationException