org.apache.twill.filesystem

Class FileContextLocationFactory

java.lang.Object

org.apache.twill.filesystem.FileContextLocationFactory

All Implemented Interfaces:

LocationFactory

public class FileContextLocationFactory
extends Object
implements LocationFactory

A LocationFactory implementation that uses FileContext to create Location.

Constructor Summary

Constructors

Constructor and Description
FileContextLocationFactory(org.apache.hadoop.conf.Configuration configuration) Same as FileContextLocationFactory(configuration, "/").
FileContextLocationFactory(org.apache.hadoop.conf.Configuration configuration, org.apache.hadoop.fs.FileContext fc, String pathBase) Deprecated. Use FileContextLocationFactory(Configuration) or FileContextLocationFactory(Configuration, String) instead. The FileContext provided to this method will only be used if the current user calling any methods of this class matches with the UserGroupInformation of the FileContext instance.
FileContextLocationFactory(org.apache.hadoop.conf.Configuration configuration, String pathBase) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
Location	create(String path) Creates an instance of Location of the given path.
Location	create(URI uri) Creates an instance of Location based on URI uri.
org.apache.hadoop.conf.Configuration	getConfiguration() Returns the Configuration used by this LocationFactory.
org.apache.hadoop.fs.FileContext	getFileContext() Returns the FileContext for the current user based on UserGroupInformation.getCurrentUser().
Location	getHomeLocation() Returns the home location.

Methods inherited from class java.lang.Object

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

Constructor Detail

FileContextLocationFactory

public FileContextLocationFactory(org.apache.hadoop.conf.Configuration configuration)

Same as FileContextLocationFactory(configuration, "/").

FileContextLocationFactory

public FileContextLocationFactory(org.apache.hadoop.conf.Configuration configuration,
                                  String pathBase)

Creates a new instance.

Parameters:

configuration - the hadoop configuration

pathBase - base path for all non-absolute location created through this LocationFactory.

FileContextLocationFactory

@Deprecated
public FileContextLocationFactory(org.apache.hadoop.conf.Configuration configuration,
                                              org.apache.hadoop.fs.FileContext fc,
                                              String pathBase)

Deprecated. Use FileContextLocationFactory(Configuration) or FileContextLocationFactory(Configuration, String) instead. The FileContext provided to this method will only be used if the current user calling any methods of this class matches with the UserGroupInformation of the FileContext instance.

Creates a new instance with the given FileContext created from the given Configuration.

Parameters:

configuration - the hadoop configuration

fc - FileContext instance created from the given configuration

pathBase - base path for all non-absolute location created through this (@link LocationFactory}.

Method Detail

create

public Location create(String path)

Description copied from interface: LocationFactory

Creates an instance of Location of the given path.

Specified by:

create in interface LocationFactory

Parameters:

path - The path representing the location.

Returns:

An instance of Location.

create

public Location create(URI uri)

Description copied from interface: LocationFactory

Creates an instance of Location based on URI uri.

Specified by:

create in interface LocationFactory

Parameters:

uri - to the resource on the filesystem.

Returns:

An instance of Location

getHomeLocation

public Location getHomeLocation()

Description copied from interface: LocationFactory

Returns the home location.

Specified by:

getHomeLocation in interface LocationFactory

getFileContext

public org.apache.hadoop.fs.FileContext getFileContext()

Returns the FileContext for the current user based on UserGroupInformation.getCurrentUser().

Throws:

IllegalStateException - if failed to determine the current user or fail to create the FileContext.

RuntimeException - if failed to get the FileContext object for the current user due to exception

getConfiguration

public org.apache.hadoop.conf.Configuration getConfiguration()

Returns the Configuration used by this LocationFactory.