alluxio.underfs.wasb

Class WasbUnderFileSystem

java.lang.Object

alluxio.underfs.BaseUnderFileSystem

alluxio.underfs.ConsistentUnderFileSystem

alluxio.underfs.hdfs.HdfsUnderFileSystem

alluxio.underfs.wasb.WasbUnderFileSystem

All Implemented Interfaces:

AsyncUfsClient, AtomicFileOutputStreamCallback, UnderFileSystem, Closeable, AutoCloseable

@ThreadSafe
public class WasbUnderFileSystem
extends HdfsUnderFileSystem

An UnderFileSystem uses the Microsoft Azure Blob Storage.

Nested Class Summary

Nested classes/interfaces inherited from interface alluxio.underfs.UnderFileSystem

UnderFileSystem.Factory, UnderFileSystem.SpaceType

Field Summary

Fields inherited from class alluxio.underfs.hdfs.HdfsUnderFileSystem

CHECKSUM_COMBINE_MODE, HADOOP_AUTH_METHOD, HDFS_ACL_PROVIDER_CLASS, HDFS_EC_CODEC_REGISTRY_CLASS, HDFS_EC_MIN_VERSION, HDFS_USER, JAVAX_WS_RS_CORE_MEDIA_TYPE, KRB_KEYTAB_LOGIN_AUTO_RENEW, KRB5_CONF_FILE, MAX_TRY, mHdfsAclProvider

Fields inherited from class alluxio.underfs.BaseUnderFileSystem

EMPTY_ACL, mUfsConf, mUri

Constructor Summary

Constructors

Constructor and Description
WasbUnderFileSystem(AlluxioURI ufsUri, UnderFileSystemConfiguration conf, org.apache.hadoop.conf.Configuration wasbConf) Constructs a new Wasb UnderFileSystem.

Method Summary

Modifier and Type	Method and Description
static org.apache.hadoop.conf.Configuration	createConfiguration(UnderFileSystemConfiguration conf, Boolean isSecure) Prepares the configuration for this Wasb as an HDFS configuration.
static WasbUnderFileSystem	createInstance(AlluxioURI uri, UnderFileSystemConfiguration conf) Factory method to construct a new Wasb UnderFileSystem.
long	getBlockSizeByte(String path) Gets the block size of a file in under file system, in bytes.
List<String>	getFileLocations(String path) Gets the list of locations of the indicated path.
List<String>	getFileLocations(String path, FileLocationOptions options) Gets the list of locations of the indicated path given options.
UfsStatus	getStatus(String path, GetStatusOptions options) Gets the file or directory status.
String	getUnderFSType() Returns the name of the under filesystem implementation.

Methods inherited from class alluxio.underfs.hdfs.HdfsUnderFileSystem

cleanup, close, connectFromMaster, connectFromWorker, create, createConfiguration, createDirect, deleteDirectory, deleteFile, exists, getAclPair, getDirectoryStatus, getFileStatus, getFs, getSpace, isDirectory, isFile, isSeekable, listStatus, mkdirs, open, openPositionRead, renameDirectory, renameFile, setAclEntries, setMode, setOwner, supportsFlush

Methods inherited from class alluxio.underfs.ConsistentUnderFileSystem

createNonexistingFile, createNonexistingFile, deleteExistingDirectory, deleteExistingDirectory, deleteExistingFile, getExistingDirectoryStatus, getExistingFileStatus, getExistingStatus, isExistingDirectory, openExistingFile, openExistingFile, renameRenamableDirectory, renameRenamableFile

Methods inherited from class alluxio.underfs.BaseUnderFileSystem

create, deleteDirectory, getConfiguration, getFingerprint, getOperationMode, getParsedFingerprint, getParsedFingerprint, getPhysicalStores, isObjectStorage, listStatus, listStatusIterable, mkdirs, open, performListingAsync, resolveUri, validatePath

Methods inherited from class java.lang.Object

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

Methods inherited from interface alluxio.underfs.UnderFileSystem

create, createNonexistingFile, createNonexistingFile, deleteDirectory, deleteExistingDirectory, deleteExistingDirectory, deleteExistingFile, getConfiguration, getExistingDirectoryStatus, getExistingFileStatus, getExistingStatus, getFileStatus, getFingerprint, getOperationMode, getParsedFingerprint, getParsedFingerprint, getPhysicalStores, getStatus, getTemporaryToken, isExistingDirectory, isObjectStorage, isTemporaryConnectionToken, listStatus, listStatuses, listStatusIterable, mkdirs, open, openExistingFile, openExistingFile, refreshTemporaryToken, renameRenamableDirectory, renameRenamableFile, resolveUri, setTemporaryTokenRefreshContext

Methods inherited from interface alluxio.underfs.AsyncUfsClient

performListingAsync

Constructor Detail

WasbUnderFileSystem

public WasbUnderFileSystem(AlluxioURI ufsUri,
                           UnderFileSystemConfiguration conf,
                           org.apache.hadoop.conf.Configuration wasbConf)

Constructs a new Wasb UnderFileSystem.

Parameters:

ufsUri - the AlluxioURI for this UFS

conf - the configuration for this UFS

wasbConf - the configuration for this Wasb UFS

Method Detail

createConfiguration

public static org.apache.hadoop.conf.Configuration createConfiguration(UnderFileSystemConfiguration conf,
                                                                       Boolean isSecure)

Prepares the configuration for this Wasb as an HDFS configuration.

Parameters:

conf - the configuration for this UFS

isSecure - whether blob storage is using https

Returns:

the created configuration

createInstance

public static WasbUnderFileSystem createInstance(AlluxioURI uri,
                                                 UnderFileSystemConfiguration conf)

Factory method to construct a new Wasb UnderFileSystem.

Parameters:

uri - the AlluxioURI for this UFS

conf - the configuration for this UFS

Returns:

a new Wasb UnderFileSystem instance

getUnderFSType

public String getUnderFSType()

Description copied from interface: UnderFileSystem

Returns the name of the under filesystem implementation. The name should be lowercase and not include any spaces, e.g. "hdfs", "s3".

Specified by:

getUnderFSType in interface UnderFileSystem

Overrides:

getUnderFSType in class HdfsUnderFileSystem

Returns:

name of the under filesystem implementation

getBlockSizeByte

public long getBlockSizeByte(String path)
                      throws IOException

Description copied from interface: UnderFileSystem

Gets the block size of a file in under file system, in bytes.

Specified by:

getBlockSizeByte in interface UnderFileSystem

Overrides:

getBlockSizeByte in class HdfsUnderFileSystem

Parameters:

path - the file name

Returns:

the block size in bytes

Throws:

IOException

getStatus

public UfsStatus getStatus(String path,
                           GetStatusOptions options)
                    throws IOException

Description copied from interface: UnderFileSystem

Gets the file or directory status. The caller does not need to know if the path is a file or directory. This method will determine the path type, and will return the appropriate status.

Specified by:

getStatus in interface UnderFileSystem

Overrides:

getStatus in class HdfsUnderFileSystem

Parameters:

path - the path to get the status

options - method options

Returns:

the file or directory status

Throws:

FileNotFoundException - when the path does not exist

IOException

getFileLocations

public List<String> getFileLocations(String path)
                              throws IOException

Description copied from interface: UnderFileSystem

Gets the list of locations of the indicated path.

Specified by:

getFileLocations in interface UnderFileSystem

Overrides:

getFileLocations in class HdfsUnderFileSystem

Parameters:

path - the file name

Returns:

The list of locations

Throws:

IOException

getFileLocations

public List<String> getFileLocations(String path,
                                     FileLocationOptions options)
                              throws IOException

Description copied from interface: UnderFileSystem

Gets the list of locations of the indicated path given options.

Specified by:

getFileLocations in interface UnderFileSystem

Overrides:

getFileLocations in class HdfsUnderFileSystem

Parameters:

path - the file name

options - method options

Returns:

The list of locations

Throws:

IOException