org.apache.gobblin.util.filesystem

Class FileSystemFactory<S extends ScopeType<S>>

java.lang.Object

org.apache.gobblin.util.filesystem.FileSystemFactory<S>

All Implemented Interfaces:

SharedResourceFactory<org.apache.hadoop.fs.FileSystem,FileSystemKey,S>

public class FileSystemFactory<S extends ScopeType<S>>
extends Object
implements SharedResourceFactory<org.apache.hadoop.fs.FileSystem,FileSystemKey,S>

A SharedResourceFactory for creating FileSystems. The factory creates a FileSystem with the correct scheme and applies any FileSystemInstrumentation found in the classpath.

Field Summary

Fields

Modifier and Type	Field and Description
static String	FACTORY_NAME

Constructor Summary

Constructors

Constructor and Description
FileSystemFactory()

Method Summary

Modifier and Type	Method and Description
SharedResourceFactoryResponse<org.apache.hadoop.fs.FileSystem>	createResource(SharedResourcesBroker<S> broker, ScopedConfigView<S,FileSystemKey> config)
static <S extends ScopeType<S>> org.apache.hadoop.fs.FileSystem	get(org.apache.hadoop.conf.Configuration configuration, SharedResourcesBroker<S> broker) Equivalent to FileSystem.get(Configuration), but uses the input SharedResourcesBroker to configure add-ons to the FileSystem (e.g.
static <S extends ScopeType<S>> org.apache.hadoop.fs.FileSystem	get(URI uri, org.apache.hadoop.conf.Configuration configuration, SharedResourcesBroker<S> broker) Equivalent to FileSystem.get(URI, Configuration), but uses the input SharedResourcesBroker to configure add-ons to the FileSystem (e.g.
S	getAutoScope(SharedResourcesBroker<S> broker, ConfigView<S,FileSystemKey> config)
String	getName()

Methods inherited from class java.lang.Object

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

Field Detail

FACTORY_NAME

public static final String FACTORY_NAME

See Also:

Constant Field Values

Constructor Detail

FileSystemFactory

public FileSystemFactory()

Method Detail

get

public static <S extends ScopeType<S>> org.apache.hadoop.fs.FileSystem get(org.apache.hadoop.conf.Configuration configuration,
                                                                           SharedResourcesBroker<S> broker)
                                                                    throws IOException

Equivalent to FileSystem.get(Configuration), but uses the input SharedResourcesBroker to configure add-ons to the FileSystem (e.g. throttling, instrumentation).

Throws:

IOException

get

public static <S extends ScopeType<S>> org.apache.hadoop.fs.FileSystem get(URI uri,
                                                                           org.apache.hadoop.conf.Configuration configuration,
                                                                           SharedResourcesBroker<S> broker)
                                                                    throws IOException

Equivalent to FileSystem.get(URI, Configuration), but uses the input SharedResourcesBroker to configure add-ons to the FileSystem (e.g. throttling, instrumentation).

Throws:

IOException

getName

public String getName()

Specified by:

getName in interface SharedResourceFactory<org.apache.hadoop.fs.FileSystem,FileSystemKey,S extends ScopeType<S>>

createResource

public SharedResourceFactoryResponse<org.apache.hadoop.fs.FileSystem> createResource(SharedResourcesBroker<S> broker,
                                                                                     ScopedConfigView<S,FileSystemKey> config)
                                                                              throws NotConfiguredException

Specified by:

createResource in interface SharedResourceFactory<org.apache.hadoop.fs.FileSystem,FileSystemKey,S extends ScopeType<S>>

Throws:

NotConfiguredException

getAutoScope

public S getAutoScope(SharedResourcesBroker<S> broker,
                      ConfigView<S,FileSystemKey> config)

Specified by:

getAutoScope in interface SharedResourceFactory<org.apache.hadoop.fs.FileSystem,FileSystemKey,S extends ScopeType<S>>