alluxio.underfs.oss

Class OSSUnderFileSystem

java.lang.Object

alluxio.underfs.BaseUnderFileSystem

alluxio.underfs.ObjectUnderFileSystem

alluxio.underfs.oss.OSSUnderFileSystem

All Implemented Interfaces:

UnderFileSystem, Closeable, 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

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

UnderFileSystem.Factory, UnderFileSystem.SpaceType

Field Summary

Fields inherited from class alluxio.underfs.ObjectUnderFileSystem

mExecutorService, PATH_SEPARATOR, PATH_SEPARATOR_CHAR

Fields inherited from class alluxio.underfs.BaseUnderFileSystem

mAlluxioConf, mUfsConf, mUri

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	OSSUnderFileSystem(AlluxioURI uri, com.aliyun.oss.OSSClient ossClient, String bucketName, UnderFileSystemConfiguration conf, AlluxioConfiguration alluxioConf) Constructor for OSSUnderFileSystem.

Method Summary

Modifier and Type	Method and Description
protected boolean	copyObject(String src, String dst)
protected boolean	createEmptyObject(String key)
static OSSUnderFileSystem	createInstance(AlluxioURI uri, UnderFileSystemConfiguration conf, AlluxioConfiguration alluxioConf) Constructs a new instance of OSSUnderFileSystem.
protected OutputStream	createObject(String key)
protected boolean	deleteObject(String key)
protected String	getFolderSuffix()
protected ObjectUnderFileSystem.ObjectListingChunk	getObjectListingChunk(String key, boolean recursive)
protected ObjectUnderFileSystem.ObjectStatus	getObjectStatus(String key)
protected ObjectUnderFileSystem.ObjectPermissions	getPermissions()
protected String	getRootKey()
String	getUnderFSType()
protected InputStream	openObject(String key, OpenOptions options)
void	setMode(String path, short mode)
void	setOwner(String path, String user, String group)

Methods inherited from class alluxio.underfs.ObjectUnderFileSystem

cleanup, close, connectFromMaster, connectFromWorker, convertToFolderName, create, deleteDirectory, deleteFile, deleteObjects, getBlockSizeByte, getChildName, getDirectoryStatus, getFileLocations, getFileLocations, getFileStatus, getListingChunkLength, getListingChunkLengthMax, getObjectListingChunkForPath, getParentPath, getSpace, getStatus, isDirectory, isFile, isObjectStorage, isRoot, listInternal, listStatus, listStatus, mkdirs, mkdirsInternal, open, parentExists, renameDirectory, renameFile, stripPrefixIfPresent, supportsFlush

Methods inherited from class alluxio.underfs.BaseUnderFileSystem

create, deleteDirectory, exists, getAclPair, getActiveSyncInfo, getFingerprint, getOperationMode, getPhysicalStores, isSeekable, mkdirs, open, 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

Constructor Detail

OSSUnderFileSystem

protected OSSUnderFileSystem(AlluxioURI uri,
                             com.aliyun.oss.OSSClient ossClient,
                             String bucketName,
                             UnderFileSystemConfiguration conf,
                             AlluxioConfiguration alluxioConf)

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,
                                                AlluxioConfiguration alluxioConf)
                                         throws Exception

Constructs a new instance of OSSUnderFileSystem.

Parameters:

uri - the AlluxioURI for this UFS

conf - the configuration for this UFS

alluxioConf - Alluxio configuration

Returns:

the created OSSUnderFileSystem instance

Throws:

Exception

getUnderFSType

public String getUnderFSType()

setOwner

public void setOwner(String path,
                     String user,
                     String group)

setMode

public void setMode(String path,
                    short mode)
             throws IOException

Throws:

IOException

copyObject

protected boolean copyObject(String src,
                             String dst)

Specified by:

copyObject in class ObjectUnderFileSystem

createEmptyObject

protected boolean createEmptyObject(String key)

Specified by:

createEmptyObject in class ObjectUnderFileSystem

createObject

protected OutputStream createObject(String key)
                             throws IOException

Specified by:

createObject in class ObjectUnderFileSystem

Throws:

IOException

deleteObject

protected boolean deleteObject(String key)

Specified by:

deleteObject in class ObjectUnderFileSystem

getFolderSuffix

protected String getFolderSuffix()

Specified by:

getFolderSuffix in class ObjectUnderFileSystem

getObjectListingChunk

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

Specified by:

getObjectListingChunk in class ObjectUnderFileSystem

Throws:

IOException

getObjectStatus

protected ObjectUnderFileSystem.ObjectStatus getObjectStatus(String key)

Specified by:

getObjectStatus in class ObjectUnderFileSystem

getPermissions

protected ObjectUnderFileSystem.ObjectPermissions getPermissions()

Specified by:

getPermissions in class ObjectUnderFileSystem

getRootKey

protected String getRootKey()

Specified by:

getRootKey in class ObjectUnderFileSystem

openObject

protected InputStream openObject(String key,
                                 OpenOptions options)
                          throws IOException

Specified by:

openObject in class ObjectUnderFileSystem

Throws:

IOException