org.apache.flink.runtime.filecache

Class FileCache

java.lang.Object

org.apache.flink.runtime.filecache.FileCache

public class FileCache
extends Object

The FileCache is used to create the local files for the registered cache files when a task is deployed. The files will be removed when the task is unregistered after a 5 second delay. A given file x will be placed in "<system-tmp-dir>/tmp_<jobID>/".

Constructor Summary

Constructors

Constructor and Description
FileCache(String[] tempDirectories)

Method Summary

Modifier and Type	Method and Description
static void	copy(Path sourcePath, Path targetPath, boolean executable)
Future<Path>	createTmpFile(String name, DistributedCache.DistributedCacheEntry entry, JobID jobID) If the file doesn't exists locally, it will copy the file to the temp directory.
void	deleteTmpFile(String name, JobID jobID) Deletes the local file after a 5 second delay.
void	shutdown() Shuts down the file cache by cancelling all.

Methods inherited from class java.lang.Object

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

Constructor Detail

FileCache

public FileCache(String[] tempDirectories)
          throws IOException

Throws:

IOException

Method Detail

shutdown

public void shutdown()

Shuts down the file cache by cancelling all.

createTmpFile

public Future<Path> createTmpFile(String name,
                                  DistributedCache.DistributedCacheEntry entry,
                                  JobID jobID)

If the file doesn't exists locally, it will copy the file to the temp directory.

Parameters:

name - The name under which the file is registered.

entry - The cache entry descriptor (path, executable flag)

jobID - The ID of the job for which the file is copied.

Returns:

The handle to the task that copies the file.

deleteTmpFile

public void deleteTmpFile(String name,
                          JobID jobID)

Deletes the local file after a 5 second delay.

Parameters:

name - The name under which the file is registered.

jobID - The ID of the job for which the file is copied.

copy

public static void copy(Path sourcePath,
                        Path targetPath,
                        boolean executable)
                 throws IOException

Throws:

IOException