alluxio.underfs.oss

Class OSSUnderFileSystem

java.lang.Object

alluxio.underfs.BaseUnderFileSystem

alluxio.underfs.ObjectUnderFileSystem

alluxio.underfs.oss.OSSUnderFileSystem

All Implemented Interfaces:

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

@ThreadSafe
public class OSSUnderFileSystem
extends ObjectUnderFileSystem

Aliyun OSS UnderFileSystem implementation.

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

Modifier	Constructor and Description
protected	OSSUnderFileSystem(AlluxioURI uri, com.aliyun.oss.OSS ossClient, java.lang.String bucketName, UnderFileSystemConfiguration conf) Constructor for OSSUnderFileSystem.

Method Summary

Modifier and Type	Method and Description
void	cleanup()
void	close()
protected boolean	copyObject(java.lang.String src, java.lang.String dst)
boolean	createEmptyObject(java.lang.String key)
static OSSUnderFileSystem	createInstance(AlluxioURI uri, UnderFileSystemConfiguration conf) Constructs a new instance of OSSUnderFileSystem.
protected java.io.OutputStream	createObject(java.lang.String key)
protected boolean	deleteObject(java.lang.String key)
protected java.util.List<java.lang.String>	deleteObjects(java.util.List<java.lang.String> keys)
protected java.lang.String	getFolderSuffix()
protected com.aliyun.oss.model.ObjectListing	getObjectListingChunk(com.aliyun.oss.model.ListObjectsRequest request)
protected ObjectUnderFileSystem.ObjectListingChunk	getObjectListingChunk(java.lang.String key, boolean recursive)
protected ObjectUnderFileSystem.ObjectStatus	getObjectStatus(java.lang.String key)
java.util.Map<java.lang.String,java.lang.String>	getObjectTags(java.lang.String path)
protected ObjectUnderFileSystem.ObjectPermissions	getPermissions()
protected java.lang.String	getRootKey()
java.lang.String	getUnderFSType()
static com.aliyun.oss.ClientBuilderConfiguration	initializeOSSClientConfig(AlluxioConfiguration alluxioConf) Creates an OSS ClientConfiguration using an Alluxio Configuration.
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	setObjectTagging(java.lang.String path, java.lang.String name, java.lang.String value)
void	setOwner(java.lang.String path, java.lang.String user, java.lang.String group)

Methods inherited from class alluxio.underfs.ObjectUnderFileSystem

connectFromMaster, connectFromWorker, convertToFolderName, create, createNonexistingFile, createNonexistingFile, deleteDirectory, deleteExistingDirectory, deleteExistingDirectory, deleteExistingFile, deleteFile, getAttributes, 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, setAttribute, stripPrefixIfPresent, supportsFlush

Methods inherited from class alluxio.underfs.BaseUnderFileSystem

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

OSSUnderFileSystem

protected OSSUnderFileSystem(AlluxioURI uri,
                             @Nullable
                             com.aliyun.oss.OSS ossClient,
                             java.lang.String bucketName,
                             UnderFileSystemConfiguration conf)

Constructor for OSSUnderFileSystem.

Parameters:

uri - the AlluxioURI for this UFS

ossClient - Aliyun OSS client

bucketName - bucket name of user's configured Alluxio bucket

conf - configuration for this UFS

Method Detail

createInstance

public static OSSUnderFileSystem createInstance(AlluxioURI uri,
                                                UnderFileSystemConfiguration conf)
                                         throws java.lang.Exception

Constructs a new instance of OSSUnderFileSystem.

Parameters:

uri - the AlluxioURI for this UFS

conf - the configuration for this UFS

Returns:

the created OSSUnderFileSystem instance

Throws:

java.lang.Exception

cleanup

public void cleanup()
             throws java.io.IOException

Specified by:

cleanup in interface UnderFileSystem

Overrides:

cleanup in class ObjectUnderFileSystem

Throws:

java.io.IOException

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)

setObjectTagging

public void setObjectTagging(java.lang.String path,
                             java.lang.String name,
                             java.lang.String value)
                      throws java.io.IOException

Specified by:

setObjectTagging in class ObjectUnderFileSystem

Throws:

java.io.IOException

getObjectTags

public java.util.Map<java.lang.String,java.lang.String> getObjectTags(java.lang.String path)
                                                               throws java.io.IOException

Specified by:

getObjectTags in class ObjectUnderFileSystem

Throws:

java.io.IOException

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 src,
                             java.lang.String dst)

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 key)

Specified by:

deleteObject in class ObjectUnderFileSystem

deleteObjects

protected java.util.List<java.lang.String> deleteObjects(java.util.List<java.lang.String> keys)
                                                  throws java.io.IOException

Overrides:

deleteObjects 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

getObjectListingChunk

protected com.aliyun.oss.model.ObjectListing getObjectListingChunk(com.aliyun.oss.model.ListObjectsRequest request)

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

initializeOSSClientConfig

public static com.aliyun.oss.ClientBuilderConfiguration initializeOSSClientConfig(AlluxioConfiguration alluxioConf)

Creates an OSS ClientConfiguration using an Alluxio Configuration.

Parameters:

alluxioConf - the OSS Configuration

Returns:

the OSS ClientBuilderConfiguration

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

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Overrides:

close in class ObjectUnderFileSystem

Throws:

java.io.IOException