org.apache.ignite.hadoop.fs

Class BasicHadoopFileSystemFactory

java.lang.Object

org.apache.ignite.hadoop.fs.BasicHadoopFileSystemFactory

All Implemented Interfaces:

Externalizable, Serializable, HadoopFileSystemFactory

Direct Known Subclasses:

CachingHadoopFileSystemFactory, KerberosHadoopFileSystemFactory

public class BasicHadoopFileSystemFactory
extends Object
implements HadoopFileSystemFactory, Externalizable

Simple Hadoop file system factory which delegates to FileSystem.get() on each call.

If "fs.[prefix].impl.disable.cache" is set to true, file system instances will be cached by Hadoop.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
BasicHadoopFileSystemFactory() Constructor.

Method Summary

Modifier and Type	Method and Description
Object	get(String name) Gets file system for the given user name.
@Nullable String[]	getConfigPaths() Gets paths to additional file system configuration files (e.g. core-site.xml).
@Nullable String	getUri() Gets file system URI.
@Nullable UserNameMapper	getUserNameMapper() Get optional user name mapper.
void	readExternal(ObjectInput in)
void	setConfigPaths(String... cfgPaths) Set paths to additional file system configuration files (e.g. core-site.xml).
void	setUri(@Nullable String uri) Sets file system URI.
void	setUserNameMapper(@Nullable UserNameMapper usrNameMapper) Set optional user name mapper.
void	writeExternal(ObjectOutput out)

Methods inherited from class java.lang.Object

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

Constructor Detail

BasicHadoopFileSystemFactory

public BasicHadoopFileSystemFactory()

Constructor.

Method Detail

get

public final Object get(String name)
                 throws IOException

Gets file system for the given user name.

Specified by:

get in interface HadoopFileSystemFactory

Parameters:

name - User name

Returns:

File system.

Throws:

IOException - In case of error.

getUri

@Nullable
public @Nullable String getUri()

Gets file system URI.

This URI will be used as a first argument when calling FileSystem.get(URI, Configuration, String).

If not set, default URI will be picked from file system configuration using FileSystem.getDefaultUri(Configuration) method.

Returns:

File system URI.

setUri

public void setUri(@Nullable
                   @Nullable String uri)

Sets file system URI. See getUri() for more information.

Parameters:

uri - File system URI.

getConfigPaths

@Nullable
public @Nullable String[] getConfigPaths()

Gets paths to additional file system configuration files (e.g. core-site.xml).

Path could be either absolute or relative to IGNITE_HOME environment variable.

All provided paths will be loaded in the order they provided and then applied to Configuration. It means that path order might be important in some cases.

Returns:

Paths to file system configuration files.

setConfigPaths

public void setConfigPaths(@Nullable
                           String... cfgPaths)

Set paths to additional file system configuration files (e.g. core-site.xml). See getConfigPaths() for more information.

Parameters:

cfgPaths - Paths to file system configuration files.

getUserNameMapper

@Nullable
public @Nullable UserNameMapper getUserNameMapper()

Get optional user name mapper.

When IGFS is invoked from Hadoop, user name is passed along the way to ensure that request will be performed with proper user context. User name is passed in a simple form and doesn't contain any extended information, such as host, domain or Kerberos realm. You may use name mapper to translate plain user name to full user name required by security engine of the underlying file system.

For example you may want to use KerberosUserNameMapper to user name from "johndoe" to "johndoe@YOUR.REALM.COM".

Returns:

User name mapper.

setUserNameMapper

public void setUserNameMapper(@Nullable
                              @Nullable UserNameMapper usrNameMapper)

Set optional user name mapper. See getUserNameMapper() for more information.

Parameters:

usrNameMapper - User name mapper.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException