org.apache.flink.core.fs

Interface FileSystemFactory

All Superinterfaces:

Plugin

All Known Implementing Classes:

AbstractAzureFSFactory, AbstractS3FileSystemFactory, AnotherDummyFSFactory, AzureBlobStorageFSFactory, AzureDataLakeStoreGen2FSFactory, ConnectionLimitingFactory, DummyFSFactory, GSFileSystemFactory, HadoopFsFactory, LocalFileSystemFactory, OSSFileSystemFactory, PluginFileSystemFactory, S3AFileSystemFactory, S3FileSystemFactory, S3FileSystemFactory, S3PFileSystemFactory, SecureAzureBlobStorageFSFactory, SecureAzureDataLakeStoreGen2FSFactory

@PublicEvolving
public interface FileSystemFactory
extends Plugin

A factory to create file systems.

The factory is typically configured via Plugin.configure(Configuration) before creating file systems via create(URI).

Method Summary

Modifier and Type	Method and Description
FileSystem	create(URI fsUri) Creates a new file system for the given file system URI.
String	getScheme() Gets the scheme of the file system created by this factory.

Methods inherited from interface org.apache.flink.core.plugin.Plugin

configure, getClassLoader

Method Detail

getScheme

String getScheme()

Gets the scheme of the file system created by this factory.

create

FileSystem create(URI fsUri)
           throws IOException

Creates a new file system for the given file system URI. The URI describes the type of file system (via its scheme) and optionally the authority (for example the host) of the file system.

Parameters:

fsUri - The URI that describes the file system.

Returns:

A new instance of the specified file system.

Throws:

IOException - Thrown if the file system could not be instantiated.