alluxio.underfs.obs

Class OBSUnderFileSystem

java.lang.Object

alluxio.underfs.BaseUnderFileSystem

alluxio.underfs.ObjectUnderFileSystem

alluxio.underfs.obs.OBSUnderFileSystem

All Implemented Interfaces:

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

@ThreadSafe
public class OBSUnderFileSystem
extends ObjectUnderFileSystem

Huawei OBS 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	OBSUnderFileSystem(AlluxioURI uri, com.obs.services.ObsClient obsClient, java.lang.String bucketName, java.lang.String bucketType, UnderFileSystemConfiguration conf) Constructor for OBSUnderFileSystem.

Method Summary

Modifier and Type	Method and Description
void	cleanup()
protected boolean	copyObject(java.lang.String src, java.lang.String dst)
boolean	createEmptyObject(java.lang.String key)
static OBSUnderFileSystem	createInstance(AlluxioURI uri, UnderFileSystemConfiguration conf) Constructs a new instance of OBSUnderFileSystem.
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.obs.services.model.ObjectListing	getObjectListingChunk(com.obs.services.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()
UfsStatus	getStatus(java.lang.String path)
java.lang.String	getUnderFSType()
boolean	isDirectory(java.lang.String path)
protected java.io.InputStream	openObject(java.lang.String key, OpenOptions options, RetryPolicy retryPolicy)
PositionReader	openPositionRead(java.lang.String path, long fileLength)
boolean	renameDirectory(java.lang.String src, java.lang.String dst)
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

close, 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, isExistingDirectory, isFile, isObjectStorage, isRoot, listInternal, listStatus, listStatus, listStatusIterable, mkdirs, mkdirsInternal, open, openExistingFile, openExistingFile, parentExists, 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, getTemporaryToken, isTemporaryConnectionToken, listStatuses, refreshTemporaryToken, setTemporaryTokenRefreshContext

Constructor Detail

OBSUnderFileSystem

protected OBSUnderFileSystem(AlluxioURI uri,
                             com.obs.services.ObsClient obsClient,
                             java.lang.String bucketName,
                             java.lang.String bucketType,
                             UnderFileSystemConfiguration conf)

Constructor for OBSUnderFileSystem.

Parameters:

uri - the AlluxioURI for this UFS

obsClient - Huawei OBS client

bucketName - bucket name of user's configured Alluxio bucket

conf - configuration for this UFS

Method Detail

createInstance

public static OBSUnderFileSystem createInstance(AlluxioURI uri,
                                                UnderFileSystemConfiguration conf)

Constructs a new instance of OBSUnderFileSystem.

Parameters:

uri - the AlluxioURI for this UFS

conf - the configuration for this UFS

Returns:

the created OBSUnderFileSystem instance

cleanup

public void cleanup()

Specified by:

cleanup in interface UnderFileSystem

Overrides:

cleanup in class ObjectUnderFileSystem

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.obs.services.model.ObjectListing getObjectListingChunk(com.obs.services.model.ListObjectsRequest request)

getObjectStatus

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

Specified by:

getObjectStatus in class ObjectUnderFileSystem

getStatus

public UfsStatus getStatus(java.lang.String path)
                    throws java.io.IOException

Throws:

java.io.IOException

isDirectory

public boolean isDirectory(java.lang.String path)
                    throws java.io.IOException

Specified by:

isDirectory in interface UnderFileSystem

Overrides:

isDirectory in class ObjectUnderFileSystem

Throws:

java.io.IOException

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

renameDirectory

public boolean renameDirectory(java.lang.String src,
                               java.lang.String dst)
                        throws java.io.IOException

Specified by:

renameDirectory in interface UnderFileSystem

Overrides:

renameDirectory in class ObjectUnderFileSystem

Throws:

java.io.IOException