alluxio.underfs.tos

Class TOSUnderFileSystem

java.lang.Object

alluxio.underfs.BaseUnderFileSystem

alluxio.underfs.ObjectUnderFileSystem

alluxio.underfs.tos.TOSUnderFileSystem

All Implemented Interfaces:

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

@ThreadSafe
public class TOSUnderFileSystem
extends ObjectUnderFileSystem

TOS（Tinder Object Storage）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	TOSUnderFileSystem(AlluxioURI uri, com.volcengine.tos.TOSV2 tosClient, java.lang.String bucketName, UnderFileSystemConfiguration conf) Constructor for TOSUnderFileSystem.

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 TOSUnderFileSystem	createInstance(AlluxioURI uri, UnderFileSystemConfiguration conf) Constructs a new instance of TOSUnderFileSystem.
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 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()
static com.volcengine.tos.transport.TransportConfig	initializeTOSClientConfig(AlluxioConfiguration alluxioConf) Creates an TOS ClientConfiguration using an Alluxio Configuration.
protected java.io.InputStream	openObject(java.lang.String key, OpenOptions options, RetryPolicy retryPolicy)
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

connectFromMaster, connectFromWorker, convertToFolderName, create, createNonexistingFile, createNonexistingFile, deleteDirectory, deleteExistingDirectory, deleteExistingDirectory, deleteExistingFile, deleteFile, 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, getRateLimiter, 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

Constructor Detail

TOSUnderFileSystem

protected TOSUnderFileSystem(AlluxioURI uri,
                             @Nullable
                             com.volcengine.tos.TOSV2 tosClient,
                             java.lang.String bucketName,
                             UnderFileSystemConfiguration conf)

Constructor for TOSUnderFileSystem.

Parameters:

uri - the AlluxioURI for this UFS

tosClient - TOS client

bucketName - bucket name of user's configured Alluxio bucket

conf - configuration for this UFS

Method Detail

createInstance

public static TOSUnderFileSystem createInstance(AlluxioURI uri,
                                                UnderFileSystemConfiguration conf)

Constructs a new instance of TOSUnderFileSystem.

Parameters:

uri - the AlluxioURI for this UFS

conf - the configuration for this UFS

Returns:

the created TOSUnderFileSystem instance

getUnderFSType

public java.lang.String getUnderFSType()

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

cleanup

public void cleanup()

Specified by:

cleanup in interface UnderFileSystem

Overrides:

cleanup in class ObjectUnderFileSystem

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)

Overrides:

deleteObjects in class ObjectUnderFileSystem

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

initializeTOSClientConfig

public static com.volcengine.tos.transport.TransportConfig initializeTOSClientConfig(AlluxioConfiguration alluxioConf)

Creates an TOS ClientConfiguration using an Alluxio Configuration.

Parameters:

alluxioConf - the TOS Configuration

Returns:

the TOS TransportConfig

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