alluxio.underfs.swift

Class SwiftUnderFileSystem

java.lang.Object

alluxio.underfs.BaseUnderFileSystem

alluxio.underfs.ObjectUnderFileSystem

alluxio.underfs.swift.SwiftUnderFileSystem

All Implemented Interfaces:

AsyncUfsClient, UnderFileSystem, java.io.Closeable, java.lang.AutoCloseable

@ThreadSafe
public class SwiftUnderFileSystem
extends ObjectUnderFileSystem

OpenStack Swift UnderFileSystem implementation based on the JOSS library. The mkdir operation creates a zero-byte object. A suffix ObjectUnderFileSystem.PATH_SEPARATOR in the object name denotes a folder. JOSS directory listing API requires that the suffix be a single character.

Nested Class Summary

Nested classes/interfaces inherited from class alluxio.underfs.ObjectUnderFileSystem

ObjectUnderFileSystem.DeleteBuffer, ObjectUnderFileSystem.ObjectListingChunk, ObjectUnderFileSystem.ObjectPermissions, ObjectUnderFileSystem.ObjectStatus, ObjectUnderFileSystem.ObjectStoreOperation<T>, ObjectUnderFileSystem.OperationBuffer<T>, ObjectUnderFileSystem.RenameBuffer, ObjectUnderFileSystem.UfsStatusIterator

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

UnderFileSystem.Factory, UnderFileSystem.SpaceType

Field Summary

Fields inherited from class alluxio.underfs.ObjectUnderFileSystem

mExecutorService, mRootKeySupplier, PATH_SEPARATOR, PATH_SEPARATOR_CHAR

Fields inherited from class alluxio.underfs.BaseUnderFileSystem

EMPTY_ACL, mUfsConf, mUri

Constructor Summary

Constructors

Constructor and Description
SwiftUnderFileSystem(AlluxioURI uri, UnderFileSystemConfiguration conf) Constructs a new Swift UnderFileSystem.

Method Summary

Modifier and Type	Method and Description
protected boolean	copyObject(java.lang.String source, java.lang.String destination)
boolean	createEmptyObject(java.lang.String key)
protected java.io.OutputStream	createObject(java.lang.String key)
protected boolean	deleteObject(java.lang.String path)
protected java.lang.String	getFolderSuffix()
protected ObjectUnderFileSystem.ObjectListingChunk	getObjectListingChunk(java.lang.String key, boolean recursive)
protected ObjectUnderFileSystem.ObjectStatus	getObjectStatus(java.lang.String key)
protected ObjectUnderFileSystem.ObjectPermissions	getPermissions()
protected java.lang.String	getRootKey()
java.lang.String	getUnderFSType()
protected java.io.InputStream	openObject(java.lang.String key, OpenOptions options, RetryPolicy retryPolicy)
PositionReader	openPositionRead(java.lang.String path, long fileLength)
void	setMode(java.lang.String path, short mode)
void	setOwner(java.lang.String path, java.lang.String user, java.lang.String group)

Methods inherited from class alluxio.underfs.ObjectUnderFileSystem

cleanup, close, connectFromMaster, connectFromWorker, convertToFolderName, create, createNonexistingFile, createNonexistingFile, deleteDirectory, deleteExistingDirectory, deleteExistingDirectory, deleteExistingFile, deleteFile, deleteObjects, getBlockSizeByte, getChildName, getDirectoryStatus, getExistingDirectoryStatus, getExistingFileStatus, getExistingStatus, getFileLocations, getFileLocations, getFileStatus, getListingChunkLength, getListingChunkLengthMax, getObjectListingChunk, getObjectListingChunkForPath, getObjectListingChunkForPath, getParentPath, getSpace, getStatus, isDirectory, isExistingDirectory, isFile, isObjectStorage, isRoot, listInternal, listStatus, listStatus, listStatusIterable, mkdirs, mkdirsInternal, open, openExistingFile, openExistingFile, parentExists, renameDirectory, renameFile, renameRenamableDirectory, renameRenamableFile, retryOnException, stripPrefixIfPresent, supportsFlush

Methods inherited from class alluxio.underfs.BaseUnderFileSystem

create, deleteDirectory, exists, getAclPair, getActiveSyncInfo, getConfiguration, getFingerprint, getOperationMode, getParsedFingerprint, getParsedFingerprint, getPhysicalStores, isSeekable, mkdirs, open, performListingAsync, resolveUri, setAclEntries, startActiveSyncPolling, startSync, stopActiveSyncPolling, stopSync, supportsActiveSync, 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

getFileStatus, getStatus, getTemporaryToken, isTemporaryConnectionToken, listStatuses, refreshTemporaryToken, setTemporaryTokenRefreshContext

Constructor Detail

SwiftUnderFileSystem

public SwiftUnderFileSystem(AlluxioURI uri,
                            UnderFileSystemConfiguration conf)
                     throws FileDoesNotExistException

Constructs a new Swift UnderFileSystem.

Parameters:

uri - the AlluxioURI for this UFS

conf - the configuration for this UFS

Throws:

FileDoesNotExistException - when specified container does not exist

Method Detail

getUnderFSType

public java.lang.String getUnderFSType()

openPositionRead

public PositionReader openPositionRead(java.lang.String path,
                                       long fileLength)

setOwner

public void setOwner(java.lang.String path,
                     java.lang.String user,
                     java.lang.String group)

setMode

public void setMode(java.lang.String path,
                    short mode)
             throws java.io.IOException

Throws:

java.io.IOException

copyObject

protected boolean copyObject(java.lang.String source,
                             java.lang.String destination)

Specified by:

copyObject in class ObjectUnderFileSystem

createEmptyObject

public boolean createEmptyObject(java.lang.String key)

Specified by:

createEmptyObject in class ObjectUnderFileSystem

createObject

protected java.io.OutputStream createObject(java.lang.String key)
                                     throws java.io.IOException

Specified by:

createObject in class ObjectUnderFileSystem

Throws:

java.io.IOException

deleteObject

protected boolean deleteObject(java.lang.String path)
                        throws java.io.IOException

Specified by:

deleteObject in class ObjectUnderFileSystem

Throws:

java.io.IOException

getFolderSuffix

protected java.lang.String getFolderSuffix()

Specified by:

getFolderSuffix in class ObjectUnderFileSystem

getObjectListingChunk

protected ObjectUnderFileSystem.ObjectListingChunk getObjectListingChunk(java.lang.String key,
                                                                         boolean recursive)
                                                                  throws java.io.IOException

Specified by:

getObjectListingChunk in class ObjectUnderFileSystem

Throws:

java.io.IOException

getObjectStatus

protected ObjectUnderFileSystem.ObjectStatus getObjectStatus(java.lang.String key)

Specified by:

getObjectStatus in class ObjectUnderFileSystem

getPermissions

protected ObjectUnderFileSystem.ObjectPermissions getPermissions()

Specified by:

getPermissions in class ObjectUnderFileSystem

getRootKey

protected java.lang.String getRootKey()

Specified by:

getRootKey in class ObjectUnderFileSystem

openObject

protected java.io.InputStream openObject(java.lang.String key,
                                         OpenOptions options,
                                         RetryPolicy retryPolicy)
                                  throws java.io.IOException

Specified by:

openObject in class ObjectUnderFileSystem

Throws:

java.io.IOException