alluxio.proxy.s3

Class S3RestUtils

java.lang.Object

alluxio.proxy.s3.S3RestUtils

public final class S3RestUtils
extends java.lang.Object

Utilities for handling S3 REST calls.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	S3RestUtils.RestCallable<T> An interface representing a callable.
static class	S3RestUtils.URIStatusNameComparator Comparator based on uri name， treat uri name as a Long number.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	BUCKET_SEPARATOR Bucket must be a directory directly under a mount point.

Method Summary

Modifier and Type	Method and Description
static <T> javax.ws.rs.core.Response	call(java.lang.String resource, S3RestUtils.RestCallable<T> callable) Calls the given S3RestUtils.RestCallable and handles any exceptions thrown.
static void	checkPathIsAlluxioDirectory(FileSystem fs, java.lang.String bucketPath) Check if a path in alluxio is a directory.
static void	checkUploadId(FileSystem fs, AlluxioURI multipartTemporaryDir, long uploadId) Check if uploadId equals directory id.
static java.lang.String	getMultipartTemporaryDirForObject(java.lang.String bucketPath, java.lang.String objectKey)
static WritePType	getS3WriteType()
static java.lang.String	parsePath(java.lang.String bucketPath) Format bucket path.
static java.lang.String	quoteETag(java.lang.String etag)
static S3Exception	toBucketS3Exception(java.lang.Exception exception, java.lang.String resource) Convert an exception to instance of S3Exception.
static S3Exception	toObjectS3Exception(java.lang.Exception exception, java.lang.String resource) Convert an exception to instance of S3Exception.
static java.lang.String	toS3Date(long epoch)

Methods inherited from class java.lang.Object

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

Field Detail

BUCKET_SEPARATOR

public static final java.lang.String BUCKET_SEPARATOR

Bucket must be a directory directly under a mount point. If it is under a non-root mount point, the bucket separator must be used as the separator in the bucket name, for example, mount:point:bucket represents Alluxio directory /mount/point/bucket.

See Also:

Constant Field Values

Method Detail

call

public static <T> javax.ws.rs.core.Response call(java.lang.String resource,
                                                 S3RestUtils.RestCallable<T> callable)

Calls the given S3RestUtils.RestCallable and handles any exceptions thrown.

Type Parameters:

T - the return type of the callable

Parameters:

resource - the resource (bucket or object) to be operated on

callable - the callable to call

Returns:

the response object

getMultipartTemporaryDirForObject

public static java.lang.String getMultipartTemporaryDirForObject(java.lang.String bucketPath,
                                                                 java.lang.String objectKey)

Parameters:

bucketPath - the bucket path like "/bucket", "/mount/point/bucket"

objectKey - the object key like "img/2017/9/1/s3.jpg"

Returns:

the temporary directory used to hold parts of the object during multipart uploads

toS3Date

public static java.lang.String toS3Date(long epoch)

Parameters:

epoch - the milliseconds from the epoch

Returns:

the string representation of the epoch in the S3 date format

quoteETag

public static java.lang.String quoteETag(java.lang.String etag)

Parameters:

etag - the entity tag to be used in the ETag field in the HTTP header

Returns:

the etag surrounded by quotes, if etag is already surrounded by quotes, return itself

parsePath

public static java.lang.String parsePath(java.lang.String bucketPath)
                                  throws S3Exception

Format bucket path.

Parameters:

bucketPath - bucket path

Returns:

bucket path after format

Throws:

S3Exception

toBucketS3Exception

public static S3Exception toBucketS3Exception(java.lang.Exception exception,
                                              java.lang.String resource)

Convert an exception to instance of S3Exception.

Parameters:

exception - Exception thrown when process s3 object rest request

resource - complete bucket path

Returns:

instance of S3Exception

toObjectS3Exception

public static S3Exception toObjectS3Exception(java.lang.Exception exception,
                                              java.lang.String resource)

Convert an exception to instance of S3Exception.

Parameters:

exception - Exception thrown when process s3 object rest request

resource - object complete path

Returns:

instance of S3Exception

checkPathIsAlluxioDirectory

public static void checkPathIsAlluxioDirectory(FileSystem fs,
                                               java.lang.String bucketPath)
                                        throws S3Exception

Check if a path in alluxio is a directory.

Parameters:

fs - instance of FileSystem

bucketPath - bucket complete path

Throws:

S3Exception

checkUploadId

public static void checkUploadId(FileSystem fs,
                                 AlluxioURI multipartTemporaryDir,
                                 long uploadId)
                          throws S3Exception

Check if uploadId equals directory id.

Parameters:

fs - instance of FileSystem

multipartTemporaryDir - multipart upload tmp directory

uploadId - multipart upload Id

Throws:

S3Exception

getS3WriteType

public static WritePType getS3WriteType()

Returns:

s3 WritePType