alluxio.proxy.s3

Class S3RestServiceHandler

java.lang.Object

alluxio.proxy.s3.S3RestServiceHandler

@NotThreadSafe
public final class S3RestServiceHandler
extends Object

This class is a REST handler for Amazon S3 API.

Field Summary

Fields

Modifier and Type	Field and Description
static String	BUCKET_PARAM
static String	BUCKET_SEPARATOR Bucket must be a directory directly under a mount point.
static String	OBJECT_PARAM
static String	SERVICE_PREFIX

Constructor Summary

Constructors

Constructor and Description
S3RestServiceHandler(javax.servlet.ServletContext context) Constructs a new S3RestServiceHandler.

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	createBucket(String authorization, String bucket)
javax.ws.rs.core.Response	createObjectOrUploadPart(String authorization, String contentMD5, String bucket, String object, Integer partNumber, Long uploadId, InputStream is)
javax.ws.rs.core.Response	deleteBucket(String authorization, String bucket)
javax.ws.rs.core.Response	deleteObjectOrAbortMultipartUpload(String authorization, String bucket, String object, Long uploadId)
javax.ws.rs.core.Response	getBucket(String authorization, String bucket, String markerParam, String prefixParam, String delimiterParam, int maxKeysParam)
javax.ws.rs.core.Response	getObjectMetadata(String authorization, String bucket, String object)
javax.ws.rs.core.Response	getObjectOrListParts(String authorization, String bucket, String object, Long uploadId)
static String	getUserFromAuthorization(String authorization) Gets the user from the authorization header string.
javax.ws.rs.core.Response	initiateOrCompleteMultipartUpload(String authorization, String bucket, String object, String uploads, Long uploadId)
javax.ws.rs.core.Response	listAllMyBuckets(String authorization)

Methods inherited from class java.lang.Object

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

Field Detail

SERVICE_PREFIX

public static final String SERVICE_PREFIX

See Also:

Constant Field Values

BUCKET_SEPARATOR

public static final 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

BUCKET_PARAM

public static final String BUCKET_PARAM

See Also:

Constant Field Values

OBJECT_PARAM

public static final String OBJECT_PARAM

See Also:

Constant Field Values

Constructor Detail

S3RestServiceHandler

public S3RestServiceHandler(@Context
                            javax.servlet.ServletContext context)

Constructs a new S3RestServiceHandler.

Parameters:

context - context for the servlet

Method Detail

getUserFromAuthorization

public static String getUserFromAuthorization(String authorization)

Gets the user from the authorization header string.

Parameters:

authorization - the authorization header string

Returns:

the user

listAllMyBuckets

public javax.ws.rs.core.Response listAllMyBuckets(@HeaderParam(value="Authorization")
                                                  String authorization)

Parameters:

authorization - header parameter authorization

Returns:

the response object

getBucket

public javax.ws.rs.core.Response getBucket(@HeaderParam(value="Authorization")
                                           String authorization,
                                           String bucket,
                                           String markerParam,
                                           String prefixParam,
                                           String delimiterParam,
                                           int maxKeysParam)

Parameters:

authorization - header parameter authorization

bucket - the bucket name

markerParam - the optional marker param

prefixParam - the optional prefix param

delimiterParam - the optional delimiter param

maxKeysParam - the optional max keys param

Returns:

the response object

createBucket

public javax.ws.rs.core.Response createBucket(@HeaderParam(value="Authorization")
                                              String authorization,
                                              String bucket)

Parameters:

authorization - header parameter authorization

bucket - the bucket name

Returns:

the response object

deleteBucket

public javax.ws.rs.core.Response deleteBucket(@HeaderParam(value="Authorization")
                                              String authorization,
                                              String bucket)

Parameters:

authorization - header parameter authorization

bucket - the bucket name

Returns:

the response object

createObjectOrUploadPart

public javax.ws.rs.core.Response createObjectOrUploadPart(@HeaderParam(value="Authorization")
                                                          String authorization,
                                                          @HeaderParam(value="Content-MD5")
                                                          String contentMD5,
                                                          String bucket,
                                                          String object,
                                                          Integer partNumber,
                                                          Long uploadId,
                                                          InputStream is)

Parameters:

authorization - header parameter authorization

contentMD5 - the optional Base64 encoded 128-bit MD5 digest of the object

bucket - the bucket name

object - the object name

partNumber - the identification of the part of the object in multipart upload, otherwise null

uploadId - the upload ID of the multipart upload, otherwise null

is - the request body

Returns:

the response object

initiateOrCompleteMultipartUpload

public javax.ws.rs.core.Response initiateOrCompleteMultipartUpload(@HeaderParam(value="Authorization")
                                                                   String authorization,
                                                                   String bucket,
                                                                   String object,
                                                                   String uploads,
                                                                   Long uploadId)

Parameters:

authorization - header parameter authorization

bucket - the bucket name

object - the object name

uploads - the query parameter specifying that this request is to initiate a multipart upload instead of uploading an object through HTTP multipart forms

uploadId - the ID of the multipart upload to be completed

Returns:

the response object

getObjectMetadata

public javax.ws.rs.core.Response getObjectMetadata(@HeaderParam(value="Authorization")
                                                   String authorization,
                                                   String bucket,
                                                   String object)

Parameters:

authorization - header parameter authorization

bucket - the bucket name

object - the object name

Returns:

the response object

getObjectOrListParts

public javax.ws.rs.core.Response getObjectOrListParts(@HeaderParam(value="Authorization")
                                                      String authorization,
                                                      String bucket,
                                                      String object,
                                                      Long uploadId)

Parameters:

authorization - header parameter authorization

bucket - the bucket name

object - the object name

uploadId - the ID of the multipart upload, if not null, listing parts of the object

Returns:

the response object

deleteObjectOrAbortMultipartUpload

public javax.ws.rs.core.Response deleteObjectOrAbortMultipartUpload(@HeaderParam(value="Authorization")
                                                                    String authorization,
                                                                    String bucket,
                                                                    String object,
                                                                    Long uploadId)

Parameters:

authorization - header parameter authorization

bucket - the bucket name

object - the object name

uploadId - the upload ID which identifies the incomplete multipart upload to be aborted

Returns:

the response object