org.apache.flink.runtime.execution.librarycache

Interface LibraryCacheManager

All Known Implementing Classes:

BlobLibraryCacheManager

public interface LibraryCacheManager

Method Summary

Modifier and Type	Method and Description
ClassLoader	getClassLoader(org.apache.flink.api.common.JobID id) Returns the user code class loader associated with id.
boolean	hasClassLoader(org.apache.flink.api.common.JobID jobId) True if the LibraryCacheManager has a user code class loader registered for the given job id.
void	registerJob(org.apache.flink.api.common.JobID id, Collection<PermanentBlobKey> requiredJarFiles, Collection<URL> requiredClasspaths) Registers a job with its required jar files and classpaths.
void	registerTask(org.apache.flink.api.common.JobID id, ExecutionAttemptID execution, Collection<PermanentBlobKey> requiredJarFiles, Collection<URL> requiredClasspaths) Registers a job task execution with its required jar files and classpaths.
void	shutdown() Shutdown method which may release created class loaders.
void	unregisterJob(org.apache.flink.api.common.JobID id) Unregisters a job from the library cache manager.
void	unregisterTask(org.apache.flink.api.common.JobID id, ExecutionAttemptID execution) Unregisters a job task execution from the library cache manager.

Method Detail

getClassLoader

ClassLoader getClassLoader(org.apache.flink.api.common.JobID id)

Returns the user code class loader associated with id.

Parameters:

id - identifying the job

Returns:

ClassLoader which can load the user code

registerJob

void registerJob(org.apache.flink.api.common.JobID id,
                 Collection<PermanentBlobKey> requiredJarFiles,
                 Collection<URL> requiredClasspaths)
          throws IOException

Registers a job with its required jar files and classpaths. The jar files are identified by their blob keys and downloaded for use by a ClassLoader.

Parameters:

id - job ID

requiredJarFiles - collection of blob keys identifying the required jar files

requiredClasspaths - collection of classpaths that are added to the user code class loader

Throws:

IOException - if any error occurs when retrieving the required jar files

See Also:

counterpart of this method

registerTask

void registerTask(org.apache.flink.api.common.JobID id,
                  ExecutionAttemptID execution,
                  Collection<PermanentBlobKey> requiredJarFiles,
                  Collection<URL> requiredClasspaths)
           throws IOException

Registers a job task execution with its required jar files and classpaths. The jar files are identified by their blob keys and downloaded for use by a ClassLoader.

Parameters:

id - job ID

requiredJarFiles - collection of blob keys identifying the required jar files

requiredClasspaths - collection of classpaths that are added to the user code class loader

Throws:

IOException - if any error occurs when retrieving the required jar files

See Also:

counterpart of this method

unregisterTask

void unregisterTask(org.apache.flink.api.common.JobID id,
                    ExecutionAttemptID execution)

Unregisters a job task execution from the library cache manager.

Note: this is the counterpart of registerTask(JobID, ExecutionAttemptID, Collection, Collection) and it will not remove any job added via registerJob(JobID, Collection, Collection)!

Parameters:

id - job ID

See Also:

counterpart of this method

unregisterJob

void unregisterJob(org.apache.flink.api.common.JobID id)

Unregisters a job from the library cache manager.

Note: this is the counterpart of registerJob(JobID, Collection, Collection) and it will not remove any job task execution added via registerTask(JobID, ExecutionAttemptID, Collection, Collection)!

Parameters:

id - job ID

See Also:

counterpart of this method

shutdown

void shutdown()

Shutdown method which may release created class loaders.

hasClassLoader

boolean hasClassLoader(@Nonnull
                       org.apache.flink.api.common.JobID jobId)

True if the LibraryCacheManager has a user code class loader registered for the given job id.

Parameters:

jobId - identifying the job for which to check the class loader

Returns:

true if the user code class loader for the given job has been registered. Otherwise false.