alluxio.underfs.gcs

Class GCSUnderFileSystem

java.lang.Object

alluxio.underfs.BaseUnderFileSystem

alluxio.underfs.ObjectUnderFileSystem

alluxio.underfs.gcs.GCSUnderFileSystem

All Implemented Interfaces:

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

@ThreadSafe
public class GCSUnderFileSystem
extends ObjectUnderFileSystem

Google Cloud Storage UnderFileSystem implementation based on the jets3t library.

Nested Class Summary

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

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

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

mUfsConf, mUri

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GCSUnderFileSystem(AlluxioURI uri, org.jets3t.service.impl.rest.httpclient.GoogleStorageService googleStorageService, java.lang.String bucketName, UnderFileSystemConfiguration conf) Constructor for GCSUnderFileSystem.

Method Summary

Modifier and Type	Method and Description
protected boolean	copyObject(java.lang.String src, java.lang.String dst)
boolean	createEmptyObject(java.lang.String key)
static GCSUnderFileSystem	createInstance(AlluxioURI uri, UnderFileSystemConfiguration conf) Constructs a new instance of GCSUnderFileSystem.
protected java.io.OutputStream	createObject(java.lang.String key)
protected boolean	deleteObject(java.lang.String key)
UfsDirectoryStatus	getExistingDirectoryStatus(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()
java.io.InputStream	openExistingFile(java.lang.String path)
java.io.InputStream	openExistingFile(java.lang.String path, OpenOptions options)
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

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

Methods inherited from class alluxio.underfs.BaseUnderFileSystem

create, deleteDirectory, exists, getAclPair, getActiveSyncInfo, getConfiguration, 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

GCSUnderFileSystem

protected GCSUnderFileSystem(AlluxioURI uri,
                             org.jets3t.service.impl.rest.httpclient.GoogleStorageService googleStorageService,
                             java.lang.String bucketName,
                             UnderFileSystemConfiguration conf)

Constructor for GCSUnderFileSystem.

Parameters:

uri - the AlluxioURI for this UFS

googleStorageService - the Jets3t GCS client

bucketName - bucket name of user's configured Alluxio bucket

conf - configuration for this UFS

Method Detail

createInstance

public static GCSUnderFileSystem createInstance(AlluxioURI uri,
                                                UnderFileSystemConfiguration conf)
                                         throws org.jets3t.service.ServiceException

Constructs a new instance of GCSUnderFileSystem.

Parameters:

uri - the AlluxioURI for this UFS

conf - the configuration for this UFS

Returns:

the created GCSUnderFileSystem instance

Throws:

org.jets3t.service.ServiceException - when a connection to GCS could not be created

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

getExistingDirectoryStatus

public UfsDirectoryStatus getExistingDirectoryStatus(java.lang.String path)
                                              throws java.io.IOException

Specified by:

getExistingDirectoryStatus in interface UnderFileSystem

Overrides:

getExistingDirectoryStatus in class ObjectUnderFileSystem

Throws:

java.io.IOException

openExistingFile

public java.io.InputStream openExistingFile(java.lang.String path)
                                     throws java.io.IOException

Specified by:

openExistingFile in interface UnderFileSystem

Overrides:

openExistingFile in class ObjectUnderFileSystem

Throws:

java.io.IOException

openExistingFile

public java.io.InputStream openExistingFile(java.lang.String path,
                                            OpenOptions options)
                                     throws java.io.IOException

Specified by:

openExistingFile in interface UnderFileSystem

Overrides:

openExistingFile in class ObjectUnderFileSystem

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)
                        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)
                                                      throws java.io.IOException

Specified by:

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

Specified by:

openObject in class ObjectUnderFileSystem