alluxio.underfs.s3a

Class S3AUnderFileSystem

java.lang.Object

alluxio.underfs.BaseUnderFileSystem

alluxio.underfs.ObjectUnderFileSystem

alluxio.underfs.s3a.S3AUnderFileSystem

All Implemented Interfaces:

UnderFileSystem, Closeable, AutoCloseable

@ThreadSafe
public class S3AUnderFileSystem
extends ObjectUnderFileSystem

S3 UnderFileSystem implementation based on the aws-java-sdk-s3 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	S3AUnderFileSystem(AlluxioURI uri, com.amazonaws.services.s3.AmazonS3 amazonS3Client, String bucketName, ExecutorService executor, com.amazonaws.services.s3.transfer.TransferManager transferManager, UnderFileSystemConfiguration conf, boolean streamingUploadEnabled) Constructor for S3AUnderFileSystem.

Method Summary

Modifier and Type	Method and Description
void	cleanup() Cleans up the under file system.
protected boolean	copyObject(String src, String dst) Copies an object to another key.
static com.amazonaws.services.s3.AmazonS3	createAmazonS3(com.amazonaws.auth.AWSCredentialsProvider credentialsProvider, com.amazonaws.ClientConfiguration clientConf, com.amazonaws.client.builder.AwsClientBuilder.EndpointConfiguration endpointConfiguration, UnderFileSystemConfiguration conf) Create an AmazonS3 client.
static com.amazonaws.auth.AWSCredentialsProvider	createAwsCredentialsProvider(UnderFileSystemConfiguration conf)
boolean	createEmptyObject(String key) Creates a zero-byte object used to encode a directory.
static S3AUnderFileSystem	createInstance(AlluxioURI uri, UnderFileSystemConfiguration conf) Constructs a new instance of S3AUnderFileSystem.
protected OutputStream	createObject(String key) Creates an OutputStream for object uploads.
protected boolean	deleteObject(String key) Internal function to delete a key.
protected List<String>	deleteObjects(List<String> keys) Internal function to delete a list of keys.
protected String	getFolderSuffix() Get suffix used to encode a directory.
protected ObjectUnderFileSystem.ObjectListingChunk	getObjectListingChunk(String key, boolean recursive) Gets a (partial) object listing result for the given key.
protected ObjectUnderFileSystem.ObjectStatus	getObjectStatus(String key) Get metadata information about object.
protected ObjectUnderFileSystem.ObjectPermissions	getPermissions() Permissions for the mounted bucket.
protected String	getRootKey() Get full path of root in object store.
String	getUnderFSType() Returns the name of the under filesystem implementation.
protected InputStream	openObject(String key, OpenOptions options, RetryPolicy retryPolicy) Internal function to open an input stream to an object.
void	setMode(String path, short mode) Changes posix file mode.
void	setOwner(String path, String user, String group) Sets the user and group of the given path.

Methods inherited from class alluxio.underfs.ObjectUnderFileSystem

close, connectFromMaster, connectFromWorker, convertToFolderName, create, createNonexistingFile, createNonexistingFile, deleteDirectory, deleteExistingDirectory, deleteExistingDirectory, deleteExistingFile, deleteFile, getBlockSizeByte, getChildName, getDirectoryStatus, getExistingDirectoryStatus, getExistingFileStatus, getExistingStatus, getFileLocations, getFileLocations, getFileStatus, getListingChunkLength, getListingChunkLengthMax, getObjectListingChunkForPath, getParentPath, getSpace, getStatus, isDirectory, isExistingDirectory, isFile, isObjectStorage, isRoot, listInternal, listStatus, listStatus, mkdirs, mkdirsInternal, open, openExistingFile, openExistingFile, 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

S3AUnderFileSystem

protected S3AUnderFileSystem(AlluxioURI uri,
                             com.amazonaws.services.s3.AmazonS3 amazonS3Client,
                             String bucketName,
                             ExecutorService executor,
                             com.amazonaws.services.s3.transfer.TransferManager transferManager,
                             UnderFileSystemConfiguration conf,
                             boolean streamingUploadEnabled)

Constructor for S3AUnderFileSystem.

Parameters:

uri - the AlluxioURI for this UFS

amazonS3Client - AWS-SDK S3 client

bucketName - bucket name of user's configured Alluxio bucket

executor - the executor for executing upload tasks

transferManager - Transfer Manager for efficient I/O to S3

conf - configuration for this S3A ufs

streamingUploadEnabled - whether streaming upload is enabled

Method Detail

createAwsCredentialsProvider

public static com.amazonaws.auth.AWSCredentialsProvider createAwsCredentialsProvider(UnderFileSystemConfiguration conf)

Parameters:

conf - the configuration for this UFS

Returns:

the created AWSCredentialsProvider instance

createInstance

public static S3AUnderFileSystem createInstance(AlluxioURI uri,
                                                UnderFileSystemConfiguration conf)

Constructs a new instance of S3AUnderFileSystem.

Parameters:

uri - the AlluxioURI for this UFS

conf - the configuration for this UFS

Returns:

the created S3AUnderFileSystem instance

createAmazonS3

public static com.amazonaws.services.s3.AmazonS3 createAmazonS3(com.amazonaws.auth.AWSCredentialsProvider credentialsProvider,
                                                                com.amazonaws.ClientConfiguration clientConf,
                                                                com.amazonaws.client.builder.AwsClientBuilder.EndpointConfiguration endpointConfiguration,
                                                                UnderFileSystemConfiguration conf)

Create an AmazonS3 client.

Parameters:

credentialsProvider - the credential provider

clientConf - the client config

endpointConfiguration - the endpoint config

conf - the Ufs config

Returns:

the AmazonS3 client

getUnderFSType

public String getUnderFSType()

Description copied from interface: UnderFileSystem

Returns the name of the under filesystem implementation. The name should be lowercase and not include any spaces, e.g. "hdfs", "s3".

Returns:

name of the under filesystem implementation

setOwner

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

Description copied from interface: UnderFileSystem

Sets the user and group of the given path. An empty implementation should be provided if unsupported.

Parameters:

path - the path of the file

user - the new owner to set, unchanged if null

group - the new group to set, unchanged if null

setMode

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

Description copied from interface: UnderFileSystem

Changes posix file mode.

Parameters:

path - the path of the file

mode - the mode to set in short format, e.g. 0777

Throws:

IOException

cleanup

public void cleanup()

Description copied from interface: UnderFileSystem

Cleans up the under file system. If any data or files are created and not completed/aborted correctly in normal ways, they should be cleaned in this method.

Specified by:

cleanup in interface UnderFileSystem

Overrides:

cleanup in class ObjectUnderFileSystem

copyObject

protected boolean copyObject(String src,
                             String dst)

Description copied from class: ObjectUnderFileSystem

Copies an object to another key.

Specified by:

copyObject in class ObjectUnderFileSystem

Parameters:

src - the source key to copy

dst - the destination key to copy to

Returns:

true if the operation was successful, false otherwise

createEmptyObject

public boolean createEmptyObject(String key)

Description copied from class: ObjectUnderFileSystem

Creates a zero-byte object used to encode a directory.

Specified by:

createEmptyObject in class ObjectUnderFileSystem

Parameters:

key - the key to create

Returns:

true if the operation was successful

createObject

protected OutputStream createObject(String key)
                             throws IOException

Description copied from class: ObjectUnderFileSystem

Creates an OutputStream for object uploads.

Specified by:

createObject in class ObjectUnderFileSystem

Parameters:

key - ufs key including scheme and bucket

Returns:

new OutputStream

Throws:

IOException

deleteObject

protected boolean deleteObject(String key)
                        throws IOException

Description copied from class: ObjectUnderFileSystem

Internal function to delete a key.

Specified by:

deleteObject in class ObjectUnderFileSystem

Parameters:

key - the key to delete

Returns:

true if successful, false if an exception is thrown

Throws:

IOException

deleteObjects

protected List<String> deleteObjects(List<String> keys)
                              throws IOException

Description copied from class: ObjectUnderFileSystem

Internal function to delete a list of keys.

Overrides:

deleteObjects in class ObjectUnderFileSystem

Parameters:

keys - the list of keys to delete

Returns:

list of successfully deleted keys

Throws:

IOException

getFolderSuffix

protected String getFolderSuffix()

Description copied from class: ObjectUnderFileSystem

Get suffix used to encode a directory.

Specified by:

getFolderSuffix in class ObjectUnderFileSystem

Returns:

folder suffix

getObjectListingChunk

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

Description copied from class: ObjectUnderFileSystem

Gets a (partial) object listing result for the given key.

Specified by:

getObjectListingChunk in class ObjectUnderFileSystem

Parameters:

key - pseudo-directory key excluding header and bucket

recursive - whether to request immediate children only, or all descendants

Returns:

chunked object listing, or null if key is not found

Throws:

IOException

getObjectStatus

@Nullable
protected ObjectUnderFileSystem.ObjectStatus getObjectStatus(String key)
                                                                throws IOException

Description copied from class: ObjectUnderFileSystem

Get metadata information about object. Implementations should process the key as is, which may be a file or a directory key.

Specified by:

getObjectStatus in class ObjectUnderFileSystem

Parameters:

key - ufs key to get metadata for

Returns:

ObjectUnderFileSystem.ObjectStatus if key exists and successful, otherwise null

Throws:

IOException

getPermissions

protected ObjectUnderFileSystem.ObjectPermissions getPermissions()

Description copied from class: ObjectUnderFileSystem

Permissions for the mounted bucket.

Specified by:

getPermissions in class ObjectUnderFileSystem

Returns:

permissions

getRootKey

protected String getRootKey()

Description copied from class: ObjectUnderFileSystem

Get full path of root in object store.

Specified by:

getRootKey in class ObjectUnderFileSystem

Returns:

full path including scheme and bucket

openObject

protected InputStream openObject(String key,
                                 OpenOptions options,
                                 RetryPolicy retryPolicy)

Description copied from class: ObjectUnderFileSystem

Internal function to open an input stream to an object.

Specified by:

openObject in class ObjectUnderFileSystem

Parameters:

key - the key to open

options - the open options

retryPolicy - the retry policy of the opened stream to solve eventual consistency issue

Returns:

an InputStream to read from key