org.apache.flink.core.fs

Class ConnectionLimitingFactory

java.lang.Object

org.apache.flink.core.fs.ConnectionLimitingFactory

All Implemented Interfaces:

FileSystemFactory, Plugin

@Internal
public class ConnectionLimitingFactory
extends Object
implements FileSystemFactory

A wrapping factory that adds a LimitedConnectionsFileSystem to a file system.

Method Summary

Modifier and Type	Method and Description
void	configure(Configuration config) Optional method for plugins to pick up settings from the configuration.
FileSystem	create(URI fsUri) Creates a new file system for the given file system URI.
static FileSystemFactory	decorateIfLimited(FileSystemFactory factory, String scheme, Configuration config) Decorates the given factory for a ConnectionLimitingFactory, if the given configuration configured connection limiting for the given file system scheme.
ClassLoader	getClassLoader() Helper method to get the class loader used to load the plugin.
String	getScheme() Gets the scheme of the file system created by this factory.

Methods inherited from class java.lang.Object

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

Method Detail

getClassLoader

public ClassLoader getClassLoader()

Description copied from interface: Plugin

Helper method to get the class loader used to load the plugin. This may be needed for some plugins that use dynamic class loading afterwards the plugin was loaded.

Specified by:

getClassLoader in interface Plugin

Returns:

the class loader used to load the plugin.

getScheme

public String getScheme()

Description copied from interface: FileSystemFactory

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

Specified by:

getScheme in interface FileSystemFactory

configure

public void configure(Configuration config)

Description copied from interface: Plugin

Optional method for plugins to pick up settings from the configuration.

Specified by:

configure in interface Plugin

Parameters:

config - The configuration to apply to the plugin.

create

public FileSystem create(URI fsUri)
                  throws IOException

Description copied from interface: FileSystemFactory

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.

Specified by:

create in interface FileSystemFactory

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.

decorateIfLimited

public static FileSystemFactory decorateIfLimited(FileSystemFactory factory,
                                                  String scheme,
                                                  Configuration config)

Decorates the given factory for a ConnectionLimitingFactory, if the given configuration configured connection limiting for the given file system scheme. Otherwise, it returns the given factory as is.

Parameters:

factory - The factory to potentially decorate.

scheme - The file scheme for which to check the configuration.

config - The configuration

Returns:

The decorated factors, if connection limiting is configured, the original factory otherwise.