Package org.apache.flink.runtime.jobmanager

Class DefaultExecutionPlanStore<R extends ResourceVersion<R>>

java.lang.Object

org.apache.flink.runtime.jobmanager.DefaultExecutionPlanStore<R>

All Implemented Interfaces:

GloballyCleanableResource, LocallyCleanableResource, ExecutionPlanStore, ExecutionPlanStore.ExecutionPlanListener, ExecutionPlanWriter

public class DefaultExecutionPlanStore<R extends ResourceVersion<R>>
extends Object
implements ExecutionPlanStore, ExecutionPlanStore.ExecutionPlanListener

Default implementation for ExecutionPlanStore. Combined with different StateHandleStore, we could persist the execution plans to various distributed storage. Also combined with different ExecutionPlanStoreWatcher, we could get all the changes on the execution plan store and do the response.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.flink.runtime.jobmanager.ExecutionPlanStore

ExecutionPlanStore.ExecutionPlanListener

Constructor Summary

Constructors

Constructor	Description
DefaultExecutionPlanStore(StateHandleStore<ExecutionPlan,R> stateHandleStore, ExecutionPlanStoreWatcher executionPlanStoreWatcher, ExecutionPlanStoreUtil executionPlanStoreUtil)

Method Summary

Modifier and Type	Method	Description
Collection<org.apache.flink.api.common.JobID>	getJobIds()	Get all job ids of submitted job graphs to the submitted execution plan store.
CompletableFuture<Void>	globalCleanupAsync(org.apache.flink.api.common.JobID jobId, Executor executor)	globalCleanupAsync is expected to be called from the main thread.
CompletableFuture<Void>	localCleanupAsync(org.apache.flink.api.common.JobID jobId, Executor executor)	Releases the locks on the specified ExecutionPlan.
void	onAddedExecutionPlan(org.apache.flink.api.common.JobID jobId)	Callback for ExecutionPlan instances added by a different ExecutionPlanStore instance.
void	onRemovedExecutionPlan(org.apache.flink.api.common.JobID jobId)	Callback for ExecutionPlan instances removed by a different ExecutionPlanStore instance.
void	putExecutionPlan(ExecutionPlan executionPlan)	Adds the ExecutionPlan instance.
void	putJobResourceRequirements(org.apache.flink.api.common.JobID jobId, JobResourceRequirements jobResourceRequirements)	Persist job resource requirements for the given job.
ExecutionPlan	recoverExecutionPlan(org.apache.flink.api.common.JobID jobId)	Returns the ExecutionPlan with the given JobID or null if no job was registered.
void	start(ExecutionPlanStore.ExecutionPlanListener executionPlanListener)	Starts the ExecutionPlanStore service.
void	stop()	Stops the ExecutionPlanStore service.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultExecutionPlanStore

public DefaultExecutionPlanStore(StateHandleStore<ExecutionPlan,R> stateHandleStore,
                                 ExecutionPlanStoreWatcher executionPlanStoreWatcher,
                                 ExecutionPlanStoreUtil executionPlanStoreUtil)

Method Detail

start

public void start(ExecutionPlanStore.ExecutionPlanListener executionPlanListener)
           throws Exception

Description copied from interface: ExecutionPlanStore

Starts the ExecutionPlanStore service.

Specified by:

start in interface ExecutionPlanStore

Throws:

Exception

stop

public void stop()
          throws Exception

Description copied from interface: ExecutionPlanStore

Stops the ExecutionPlanStore service.

Specified by:

stop in interface ExecutionPlanStore

Throws:

Exception

recoverExecutionPlan

@Nullable
public ExecutionPlan recoverExecutionPlan(org.apache.flink.api.common.JobID jobId)
                                   throws Exception

Description copied from interface: ExecutionPlanStore

Returns the ExecutionPlan with the given JobID or null if no job was registered.

Specified by:

recoverExecutionPlan in interface ExecutionPlanStore

Throws:

Exception

putExecutionPlan

public void putExecutionPlan(ExecutionPlan executionPlan)
                      throws Exception

Description copied from interface: ExecutionPlanWriter

Adds the ExecutionPlan instance.

If a execution plan with the same JobID exists, it is replaced.

Specified by:

putExecutionPlan in interface ExecutionPlanWriter

Throws:

Exception

putJobResourceRequirements

public void putJobResourceRequirements(org.apache.flink.api.common.JobID jobId,
                                       JobResourceRequirements jobResourceRequirements)
                                throws Exception

Description copied from interface: ExecutionPlanWriter

Persist job resource requirements for the given job.

Specified by:

putJobResourceRequirements in interface ExecutionPlanWriter

Parameters:

jobId - job the given requirements belong to

jobResourceRequirements - requirements to persist

Throws:

Exception - in case we're not able to persist the requirements for some reason

globalCleanupAsync

public CompletableFuture<Void> globalCleanupAsync(org.apache.flink.api.common.JobID jobId,
                                                  Executor executor)

Description copied from interface: GloballyCleanableResource

globalCleanupAsync is expected to be called from the main thread. Heavy IO tasks should be outsourced into the passed cleanupExecutor. Thread-safety must be ensured.

Specified by:

globalCleanupAsync in interface ExecutionPlanWriter

Specified by:

globalCleanupAsync in interface GloballyCleanableResource

Parameters:

jobId - The JobID of the job for which the local data should be cleaned up.

executor - The fallback executor for IO-heavy operations.

Returns:

The cleanup result future.

localCleanupAsync

public CompletableFuture<Void> localCleanupAsync(org.apache.flink.api.common.JobID jobId,
                                                 Executor executor)

Releases the locks on the specified ExecutionPlan.

Releasing the locks allows that another instance can delete the job from the ExecutionPlanStore.

Specified by:

localCleanupAsync in interface ExecutionPlanWriter

Specified by:

localCleanupAsync in interface LocallyCleanableResource

Parameters:

jobId - specifying the job to release the locks for

executor - the executor being used for the asynchronous execution of the local cleanup.

Returns:

The cleanup result future.

getJobIds

public Collection<org.apache.flink.api.common.JobID> getJobIds()
                                                        throws Exception

Description copied from interface: ExecutionPlanStore

Get all job ids of submitted job graphs to the submitted execution plan store.

Specified by:

getJobIds in interface ExecutionPlanStore

Returns:

Collection of submitted job ids

Throws:

Exception - if the operation fails

onAddedExecutionPlan

public void onAddedExecutionPlan(org.apache.flink.api.common.JobID jobId)

Description copied from interface: ExecutionPlanStore.ExecutionPlanListener

Callback for ExecutionPlan instances added by a different ExecutionPlanStore instance.

Important: It is possible to get false positives and be notified about a job graph, which was added by this instance.

Specified by:

onAddedExecutionPlan in interface ExecutionPlanStore.ExecutionPlanListener

Parameters:

jobId - The JobID of the added job graph

onRemovedExecutionPlan

public void onRemovedExecutionPlan(org.apache.flink.api.common.JobID jobId)

Description copied from interface: ExecutionPlanStore.ExecutionPlanListener

Callback for ExecutionPlan instances removed by a different ExecutionPlanStore instance.

Specified by:

onRemovedExecutionPlan in interface ExecutionPlanStore.ExecutionPlanListener

Parameters:

jobId - The JobID of the removed job graph