org.apache.flink.runtime.execution.librarycache

Interface LibraryCacheManager

All Known Implementing Classes:

BlobLibraryCacheManager, FallbackLibraryCacheManager

public interface LibraryCacheManager

Method Summary

Modifier and Type	Method and Description
ClassLoader	getClassLoader(JobID id) Returns the user code class loader associated with id.
File	getFile(BlobKey blobKey) Returns a file handle to the file identified by the blob key.
void	registerJob(JobID id, Collection<BlobKey> requiredJarFiles, Collection<URL> requiredClasspaths) Registers a job with its required jar files and classpaths.
void	registerTask(JobID id, ExecutionAttemptID execution, Collection<BlobKey> requiredJarFiles, Collection<URL> requiredClasspaths) Registers a job task execution with its required jar files and classpaths.
void	shutdown() Shutdown method
void	unregisterJob(JobID id) Unregisters a job from the library cache manager.
void	unregisterTask(JobID id, ExecutionAttemptID execution) Unregisters a job from the library cache manager.

Method Detail

getClassLoader

ClassLoader getClassLoader(JobID id)

Returns the user code class loader associated with id.

Parameters:

id - identifying the job

Returns:

ClassLoader which can load the user code

getFile

File getFile(BlobKey blobKey)
      throws IOException

Returns a file handle to the file identified by the blob key.

Parameters:

blobKey - identifying the requested file

Returns:

File handle

Throws:

IOException

registerJob

void registerJob(JobID id,
                 Collection<BlobKey> 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.

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

registerTask

void registerTask(JobID id,
                  ExecutionAttemptID execution,
                  Collection<BlobKey> 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.

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

unregisterTask

void unregisterTask(JobID id,
                    ExecutionAttemptID execution)

Unregisters a job from the library cache manager.

Parameters:

id - job ID

unregisterJob

void unregisterJob(JobID id)

Unregisters a job from the library cache manager.

Parameters:

id - job ID

shutdown

void shutdown()
       throws IOException

Shutdown method

Throws:

IOException