org.apache.commons.vfs2.provider.hdfs

Class HdfsFileSystemConfigBuilder

java.lang.Object

org.apache.commons.vfs2.FileSystemConfigBuilder

org.apache.commons.vfs2.provider.hdfs.HdfsFileSystemConfigBuilder

public final class HdfsFileSystemConfigBuilder
extends FileSystemConfigBuilder

Configuration settings for the HdfsFileSystem.

Since:

2.1

Method Summary

Modifier and Type	Method and Description
protected Class<? extends FileSystem>	getConfigClass() Gets the target of this configuration.
org.apache.hadoop.conf.Configuration	getConfigConfiguration(FileSystemOptions opts) Get alternate configuration object.
InputStream	getConfigInputStream(FileSystemOptions opts) Get alternate configuration input stream.
String[]	getConfigNames(FileSystemOptions opts) Get names of alternate configuration resources.
org.apache.hadoop.fs.Path[]	getConfigPaths(FileSystemOptions opts) Get paths of alternate configuration file system files.
URL[]	getConfigURLs(FileSystemOptions opts) Get URLs of alternate configurations.
static HdfsFileSystemConfigBuilder	getInstance()
void	setConfigConfiguration(FileSystemOptions opts, org.apache.hadoop.conf.Configuration configuration) Sets the configuration object to be loaded after the defaults.
void	setConfigInputStream(FileSystemOptions opts, InputStream inputStream) Sets the input stream of configuration file to be loaded after the defaults.
void	setConfigName(FileSystemOptions opts, String name) Sets the name of configuration resource to be loaded after the defaults.
void	setConfigPath(FileSystemOptions opts, org.apache.hadoop.fs.Path path) Sets the full path of configuration file to be loaded after the defaults.
void	setConfigURL(FileSystemOptions opts, URL url) Sets the URL of configuration file to be loaded after the defaults.

Methods inherited from class org.apache.commons.vfs2.FileSystemConfigBuilder

getBoolean, getBoolean, getBoolean, getByte, getByte, getByte, getCharacter, getCharacter, getCharacter, getDouble, getDouble, getDouble, getDuration, getDuration, getDurationInteger, getDurationInteger, getEnum, getEnum, getFloat, getFloat, getFloat, getInteger, getInteger, getInteger, getLong, getLong, getLong, getParam, getRootURI, getShort, getShort, getShort, getString, getString, hasObject, hasParam, setParam, setParam, setRootURI, toBooleanObject

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static HdfsFileSystemConfigBuilder getInstance()

Returns:

HdfsFileSystemConfigBuilder instance

getConfigClass

protected Class<? extends FileSystem> getConfigClass()

Description copied from class: FileSystemConfigBuilder

Gets the target of this configuration.

Specified by:

getConfigClass in class FileSystemConfigBuilder

Returns:

HDFSFileSystem

getConfigConfiguration

public org.apache.hadoop.conf.Configuration getConfigConfiguration(FileSystemOptions opts)

Get alternate configuration object.

Parameters:

opts - The FileSystemOptions.

Returns:

alternate configuration object or null.

See Also:

setConfigConfiguration(FileSystemOptions, Configuration)

getConfigInputStream

public InputStream getConfigInputStream(FileSystemOptions opts)

Get alternate configuration input stream.

Parameters:

opts - The FileSystemOptions.

Returns:

alternate configuration input stream or null.

See Also:

setConfigInputStream(FileSystemOptions, InputStream)

getConfigNames

public String[] getConfigNames(FileSystemOptions opts)

Get names of alternate configuration resources.

Parameters:

opts - The FileSystemOptions.

Returns:

resource name list of alternate configurations or null.

See Also:

setConfigName(FileSystemOptions, String)

getConfigPaths

public org.apache.hadoop.fs.Path[] getConfigPaths(FileSystemOptions opts)

Get paths of alternate configuration file system files.

Parameters:

opts - The FileSystemOptions.

Returns:

list of full paths of alternate configuration files or null.

See Also:

setConfigPath(FileSystemOptions, Path)

getConfigURLs

public URL[] getConfigURLs(FileSystemOptions opts)

Get URLs of alternate configurations.

Parameters:

opts - The FileSystemOptions.

Returns:

list of alternate configuration URLs or null.

See Also:

setConfigURL(FileSystemOptions, URL)

setConfigConfiguration

public void setConfigConfiguration(FileSystemOptions opts,
                                   org.apache.hadoop.conf.Configuration configuration)

Sets the configuration object to be loaded after the defaults.

Specifies an already initialized configuration object to override any specific HDFS settings. The property will be passed on to org.apache.hadoop.conf.Configuration#addResource(Configuration) after the URL was set as the default name with: Configuration#set(FileSystem.FS_DEFAULT_NAME_KEY, url).

One use for this is to set a different value for the dfs.client.use.datanode.hostname property in order to access HDFS files stored in an AWS installation (from outside their firewall). There are other possible uses too.

Parameters:

opts - The FileSystemOptions to modify.

configuration - additional configuration object or null to unset any configuration object previously set.

setConfigInputStream

public void setConfigInputStream(FileSystemOptions opts,
                                 InputStream inputStream)

Sets the input stream of configuration file to be loaded after the defaults.

Specifies an input stream connected to a config file to override any specific HDFS settings. The property will be passed on to org.apache.hadoop.conf.Configuration#addResource(InputStream) after the URL was set as the default name with: Configuration#set(FileSystem.FS_DEFAULT_NAME_KEY, url).

One use for this is to set a different value for the dfs.client.use.datanode.hostname property in order to access HDFS files stored in an AWS installation (from outside their firewall). There are other possible uses too.

Parameters:

opts - The FileSystemOptions to modify.

inputStream - input stream of additional configuration file or null to unset the configuration input stream previously set up.

setConfigName

public void setConfigName(FileSystemOptions opts,
                          String name)

Sets the name of configuration resource to be loaded after the defaults.

Specifies the name of a config resource to override any specific HDFS settings. The property will be passed on to org.apache.hadoop.conf.Configuration#addResource(String) after the URL was set as the default name with: Configuration#set(FileSystem.FS_DEFAULT_NAME_KEY, url).

One use for this is to set a different value for the dfs.client.use.datanode.hostname property in order to access HDFS files stored in an AWS installation (from outside their firewall). There are other possible uses too.

This method may be called multiple times and all the specified resources will be loaded in the order they were specified.

Note also, that if a list of names is provided, separated by commas (","), that this will work the same as calling this method a number of times with just one name each.

Parameters:

opts - The FileSystemOptions to modify.

name - resource name of additional configuration or null to unset all the values set so far.

See Also:

getConfigNames(org.apache.commons.vfs2.FileSystemOptions)

setConfigPath

public void setConfigPath(FileSystemOptions opts,
                          org.apache.hadoop.fs.Path path)

Sets the full path of configuration file to be loaded after the defaults.

Specifies the path of a local file system config file to override any specific HDFS settings. The property will be passed on to org.apache.hadoop.conf.Configuration#addResource(Path) after the URL was set as the default name with: Configuration#set(FileSystem.FS_DEFAULT_NAME_KEY, url).

One use for this is to set a different value for the dfs.client.use.datanode.hostname property in order to access HDFS files stored in an AWS installation (from outside their firewall). There are other possible uses too.

This method may be called multiple times and all the specified resources will be loaded in the order they were specified.

Parameters:

opts - The FileSystemOptions to modify.

path - full path of additional configuration file (local file system) or null to unset all the path values set so far.

setConfigURL

public void setConfigURL(FileSystemOptions opts,
                         URL url)

Sets the URL of configuration file to be loaded after the defaults.

Specifies the URL of a config file to override any specific HDFS settings. The property will be passed on to org.apache.hadoop.conf.Configuration#addResource(URL) after the URL was set as the default name with: Configuration#set(FileSystem.FS_DEFAULT_NAME_KEY, url).

One use for this is to set a different value for the dfs.client.use.datanode.hostname property in order to access HDFS files stored in an AWS installation (from outside their firewall). There are other possible uses too.

This method may be called multiple times and all the specified resources will be loaded in the order they were specified.

Parameters:

opts - The FileSystemOptions to modify.

url - URL of additional configuration file or null to unset all the URL values set so far.