alluxio.proxy.s3

Class MultipartUploadCleaner

java.lang.Object

alluxio.proxy.s3.MultipartUploadCleaner

public class MultipartUploadCleaner
extends java.lang.Object

A lazy method (not scan the whole fileSystem to find tmp directory) to support automatic abortion s3 multipartUpload after a timeout.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MultipartUploadCleaner.AbortTask Abort Multipart upload task.

Method Summary

Modifier and Type	Method and Description
static boolean	apply(FileSystem metaFs, FileSystem userFs, java.lang.String bucket, java.lang.String object, java.lang.String uploadId) Schedule a task to clean multipart upload.
static void	cancelAbort(FileSystem metaFs, FileSystem userFs, java.lang.String bucket, java.lang.String object, java.lang.String uploadId) Cancel schedule task.
static MultipartUploadCleaner	getInstance()
long	getRetryDelay() Get retry delay.
static void	shutdown() Shutdown cleaner.
long	tryAbortMultipartUpload(FileSystem metaFs, FileSystem userFs, java.lang.String bucket, java.lang.String object, java.lang.String uploadId) Try to abort a multipart upload if it was timeout.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getInstance

public static MultipartUploadCleaner getInstance()

Returns:

instance of MultipartUploadCleaner

shutdown

public static void shutdown()

Shutdown cleaner.

apply

public static boolean apply(FileSystem metaFs,
                            FileSystem userFs,
                            java.lang.String bucket,
                            java.lang.String object,
                            java.lang.String uploadId)
                     throws java.io.IOException,
                            AlluxioException

Schedule a task to clean multipart upload.

Parameters:

metaFs - instance of FileSystem - used for metadata operations

userFs - instance of FileSystem - under the scope of a user agent

bucket - bucket name

object - object name

uploadId - multipart upload tmp directory fileId

Returns:

true if add a abort task

Throws:

java.io.IOException

AlluxioException

cancelAbort

public static void cancelAbort(FileSystem metaFs,
                               FileSystem userFs,
                               java.lang.String bucket,
                               java.lang.String object,
                               java.lang.String uploadId)

Cancel schedule task.

Parameters:

metaFs - instance of FileSystem - used for metadata operations

userFs - instance of FileSystem - under the scope of a user agent

bucket - bucket name

object - object name

uploadId - multipart upload tmp directory fileId

getRetryDelay

public long getRetryDelay()

Get retry delay.

Returns:

delay time

tryAbortMultipartUpload

public long tryAbortMultipartUpload(FileSystem metaFs,
                                    FileSystem userFs,
                                    java.lang.String bucket,
                                    java.lang.String object,
                                    java.lang.String uploadId)
                             throws java.io.IOException,
                                    AlluxioException

Try to abort a multipart upload if it was timeout.

Parameters:

metaFs - instance of FileSystem - used for metadata operations

userFs - instance of FileSystem - under the scope of a user agent

bucket - the bucket name

object - the object name

uploadId - multipart upload tmp directory fileId

Returns:

delay time, non-positive values indicate to not retry this method

Throws:

java.io.IOException

AlluxioException