org.apache.flink.runtime.dispatcher

Class OnMainThreadJobManagerRunnerRegistry

java.lang.Object

org.apache.flink.runtime.dispatcher.OnMainThreadJobManagerRunnerRegistry

All Implemented Interfaces:

LocallyCleanableResource, JobManagerRunnerRegistry, WrappingProxy<JobManagerRunnerRegistry>

public class OnMainThreadJobManagerRunnerRegistry
extends Object
implements JobManagerRunnerRegistry, WrappingProxy<JobManagerRunnerRegistry>

OnMainThreadJobManagerRunnerRegistry implements JobManagerRunnerRegistry guarding the passed JobManagerRunnerRegistry instance in a way that it only allows modifying methods to be executed on the component's main thread.

See Also:

ComponentMainThreadExecutor

Constructor Summary

Constructors

Constructor and Description
OnMainThreadJobManagerRunnerRegistry(JobManagerRunnerRegistry delegate, ComponentMainThreadExecutor mainThreadExecutor)

Method Summary

Modifier and Type	Method and Description
JobManagerRunner	get(JobID jobId) Returns the JobManagerRunner for the given JobID.
Collection<JobManagerRunner>	getJobManagerRunners() Returns the registered JobManagerRunner instances.
Set<JobID>	getRunningJobIds() Returns JobID instances of registered JobManagerRunner instances.
JobManagerRunnerRegistry	getWrappedDelegate() Returns the delegated JobManagerRunnerRegistry.
boolean	isRegistered(JobID jobId) Checks whether a JobManagerRunner is registered under the given JobID.
CompletableFuture<Void>	localCleanupAsync(JobID jobId, Executor executor) localCleanupAsync is expected to be called from the main thread.
void	register(JobManagerRunner jobManagerRunner) Registers the given JobManagerRunner instance.
int	size() Returns the number of JobManagerRunner instances currently being registered.
JobManagerRunner	unregister(JobID jobId) Unregistered the JobManagerRunner with the given JobID.

Methods inherited from class java.lang.Object

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

Constructor Detail

OnMainThreadJobManagerRunnerRegistry

public OnMainThreadJobManagerRunnerRegistry(JobManagerRunnerRegistry delegate,
                                            ComponentMainThreadExecutor mainThreadExecutor)

Method Detail

isRegistered

public boolean isRegistered(JobID jobId)

Description copied from interface: JobManagerRunnerRegistry

Checks whether a JobManagerRunner is registered under the given JobID.

Specified by:

isRegistered in interface JobManagerRunnerRegistry

Parameters:

jobId - The JobID to check.

Returns:

true, if a JobManagerRunner is registered; false otherwise.

register

public void register(JobManagerRunner jobManagerRunner)

Description copied from interface: JobManagerRunnerRegistry

Registers the given JobManagerRunner instance.

Specified by:

register in interface JobManagerRunnerRegistry

get

public JobManagerRunner get(JobID jobId)

Description copied from interface: JobManagerRunnerRegistry

Returns the JobManagerRunner for the given JobID.

Specified by:

get in interface JobManagerRunnerRegistry

See Also:

JobManagerRunnerRegistry.isRegistered(JobID)

size

public int size()

Description copied from interface: JobManagerRunnerRegistry

Returns the number of JobManagerRunner instances currently being registered.

Specified by:

size in interface JobManagerRunnerRegistry

getRunningJobIds

public Set<JobID> getRunningJobIds()

Description copied from interface: JobManagerRunnerRegistry

Returns JobID instances of registered JobManagerRunner instances.

Specified by:

getRunningJobIds in interface JobManagerRunnerRegistry

getJobManagerRunners

public Collection<JobManagerRunner> getJobManagerRunners()

Description copied from interface: JobManagerRunnerRegistry

Returns the registered JobManagerRunner instances.

Specified by:

getJobManagerRunners in interface JobManagerRunnerRegistry

localCleanupAsync

public CompletableFuture<Void> localCleanupAsync(JobID jobId,
                                                 Executor executor)

Description copied from interface: LocallyCleanableResource

localCleanupAsync 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:

localCleanupAsync in interface LocallyCleanableResource

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.

unregister

public JobManagerRunner unregister(JobID jobId)

Description copied from interface: JobManagerRunnerRegistry

Unregistered the JobManagerRunner with the given JobID. null is returned if there's no JobManagerRunner registered for the given JobID.

Specified by:

unregister in interface JobManagerRunnerRegistry

getWrappedDelegate

public JobManagerRunnerRegistry getWrappedDelegate()

Returns the delegated JobManagerRunnerRegistry. This method can be used to workaround the main thread safeguard.

Specified by:

getWrappedDelegate in interface WrappingProxy<JobManagerRunnerRegistry>