Package org.apache.flink.state.forst.fs

Class ForStFlinkFileSystem

java.lang.Object

org.apache.flink.core.fs.FileSystem

org.apache.flink.state.forst.fs.ForStFlinkFileSystem

@Experimental
public class ForStFlinkFileSystem
extends org.apache.flink.core.fs.FileSystem

A FileSystem delegates some requests to file system loaded by Flink FileSystem mechanism.

All methods in this class maybe used by ForSt, please start a discussion firstly if it has to be modified.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.flink.core.fs.FileSystem

org.apache.flink.core.fs.FileSystem.WriteMode

Constructor Summary

Constructors

Constructor	Description
ForStFlinkFileSystem(org.apache.flink.core.fs.FileSystem delegateFS)

Method Summary

Modifier and Type	Method	Description
ByteBufferWritableFSDataOutputStream	create(org.apache.flink.core.fs.Path path)	Create ByteBufferWritableFSDataOutputStream from specific path which supports to write data to ByteBuffer with FileSystem.WriteMode.OVERWRITE mode.
ByteBufferWritableFSDataOutputStream	create(org.apache.flink.core.fs.Path path, org.apache.flink.core.fs.FileSystem.WriteMode overwriteMode)
boolean	delete(org.apache.flink.core.fs.Path path, boolean recursive)
static org.apache.flink.core.fs.FileSystem	get(URI uri)	Returns a reference to the FileSystem instance for accessing the file system identified by the given URI.
org.apache.flink.core.fs.BlockLocation[]	getFileBlockLocations(org.apache.flink.core.fs.FileStatus file, long start, long len)
org.apache.flink.core.fs.FileStatus	getFileStatus(org.apache.flink.core.fs.Path path)
org.apache.flink.core.fs.Path	getHomeDirectory()
org.apache.flink.core.fs.FileSystemKind	getKind()
URI	getUri()
org.apache.flink.core.fs.Path	getWorkingDirectory()
boolean	isDistributedFS()
org.apache.flink.core.fs.FileStatus[]	listStatus(org.apache.flink.core.fs.Path path)
boolean	mkdirs(org.apache.flink.core.fs.Path path)
ByteBufferReadableFSDataInputStream	open(org.apache.flink.core.fs.Path path)
ByteBufferReadableFSDataInputStream	open(org.apache.flink.core.fs.Path path, int bufferSize)
boolean	rename(org.apache.flink.core.fs.Path src, org.apache.flink.core.fs.Path dst)

Methods inherited from class org.apache.flink.core.fs.FileSystem

create, create, createRecoverableWriter, exists, getDefaultBlockSize, getDefaultFsUri, getLocalFileSystem, getUnguardedFileSystem, initialize, initialize, initOutPathDistFS, initOutPathLocalFS

Methods inherited from class java.lang.Object

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

Constructor Detail

ForStFlinkFileSystem

public ForStFlinkFileSystem(org.apache.flink.core.fs.FileSystem delegateFS)

Method Detail

get

public static org.apache.flink.core.fs.FileSystem get(URI uri)
                                               throws IOException

Returns a reference to the FileSystem instance for accessing the file system identified by the given URI.

Parameters:

uri - the URI identifying the file system.

Returns:

a reference to the FileSystem instance for accessing the file system identified by the given URI.

Throws:

IOException - thrown if a reference to the file system instance could not be obtained.

create

public ByteBufferWritableFSDataOutputStream create(org.apache.flink.core.fs.Path path)
                                            throws IOException

Create ByteBufferWritableFSDataOutputStream from specific path which supports to write data to ByteBuffer with FileSystem.WriteMode.OVERWRITE mode.

Parameters:

path - The file path to write to.

Returns:

The stream to the new file at the target path.

Throws:

IOException - Thrown, if the stream could not be opened because of an I/O, or because a file already exists at that path and the write mode indicates to not overwrite the file.

create

public ByteBufferWritableFSDataOutputStream create(org.apache.flink.core.fs.Path path,
                                                   org.apache.flink.core.fs.FileSystem.WriteMode overwriteMode)
                                            throws IOException

Specified by:

create in class org.apache.flink.core.fs.FileSystem

Throws:

IOException

open

public ByteBufferReadableFSDataInputStream open(org.apache.flink.core.fs.Path path,
                                                int bufferSize)
                                         throws IOException

Specified by:

open in class org.apache.flink.core.fs.FileSystem

Throws:

IOException

open

public ByteBufferReadableFSDataInputStream open(org.apache.flink.core.fs.Path path)
                                         throws IOException

Specified by:

open in class org.apache.flink.core.fs.FileSystem

Throws:

IOException

rename

public boolean rename(org.apache.flink.core.fs.Path src,
                      org.apache.flink.core.fs.Path dst)
               throws IOException

Specified by:

rename in class org.apache.flink.core.fs.FileSystem

Throws:

IOException

getWorkingDirectory

public org.apache.flink.core.fs.Path getWorkingDirectory()

Specified by:

getWorkingDirectory in class org.apache.flink.core.fs.FileSystem

getHomeDirectory

public org.apache.flink.core.fs.Path getHomeDirectory()

Specified by:

getHomeDirectory in class org.apache.flink.core.fs.FileSystem

getUri

public URI getUri()

Specified by:

getUri in class org.apache.flink.core.fs.FileSystem

getFileStatus

public org.apache.flink.core.fs.FileStatus getFileStatus(org.apache.flink.core.fs.Path path)
                                                  throws IOException

Specified by:

getFileStatus in class org.apache.flink.core.fs.FileSystem

Throws:

IOException

getFileBlockLocations

public org.apache.flink.core.fs.BlockLocation[] getFileBlockLocations(org.apache.flink.core.fs.FileStatus file,
                                                                      long start,
                                                                      long len)
                                                               throws IOException

Specified by:

getFileBlockLocations in class org.apache.flink.core.fs.FileSystem

Throws:

IOException

listStatus

public org.apache.flink.core.fs.FileStatus[] listStatus(org.apache.flink.core.fs.Path path)
                                                 throws IOException

Specified by:

listStatus in class org.apache.flink.core.fs.FileSystem

Throws:

IOException

delete

public boolean delete(org.apache.flink.core.fs.Path path,
                      boolean recursive)
               throws IOException

Specified by:

delete in class org.apache.flink.core.fs.FileSystem

Throws:

IOException

mkdirs

public boolean mkdirs(org.apache.flink.core.fs.Path path)
               throws IOException

Specified by:

mkdirs in class org.apache.flink.core.fs.FileSystem

Throws:

IOException

isDistributedFS

public boolean isDistributedFS()

Specified by:

isDistributedFS in class org.apache.flink.core.fs.FileSystem

getKind

public org.apache.flink.core.fs.FileSystemKind getKind()

Specified by:

getKind in class org.apache.flink.core.fs.FileSystem