alluxio.proxy.s3

Class S3RestServiceHandler

java.lang.Object

alluxio.proxy.s3.S3RestServiceHandler

@NotThreadSafe
 @Path(value="s3")
 @Produces(value="application/xml")
 @Consumes(value={"text/xml","application/xml"})
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 bucket)
javax.ws.rs.core.Response	createObjectOrUploadPart(String contentMD5, String bucket, String object, Integer partNumber, Long uploadId, InputStream is)
javax.ws.rs.core.Response	deleteBucket(String bucket)
javax.ws.rs.core.Response	deleteObjectOrAbortMultipartUpload(String bucket, String object, Long uploadId)
javax.ws.rs.core.Response	getBucket(String bucket, String continuationToken, String maxKeys, String prefix)
javax.ws.rs.core.Response	getObjectMetadata(String bucket, String object)
javax.ws.rs.core.Response	getObjectOrListParts(String bucket, String object, Long uploadId)
javax.ws.rs.core.Response	initiateOrCompleteMultipartUpload(String bucket, String object, String uploads, Long uploadId)

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

createBucket

@PUT
 @Path(value="{bucket}/")
public javax.ws.rs.core.Response createBucket(@PathParam(value="bucket")
                                                                             String bucket)

Parameters:

bucket - the bucket name

Returns:

the response object

deleteBucket

@DELETE
 @Path(value="{bucket}/")
public javax.ws.rs.core.Response deleteBucket(@PathParam(value="bucket")
                                                                                String bucket)

Parameters:

bucket - the bucket name

Returns:

the response object

getBucket

@GET
 @Path(value="{bucket}/")
public javax.ws.rs.core.Response getBucket(@PathParam(value="bucket")
                                                                          String bucket,
                                                                          @QueryParam(value="continuation-token")
                                                                          String continuationToken,
                                                                          @QueryParam(value="max-keys")
                                                                          String maxKeys,
                                                                          @QueryParam(value="prefix")
                                                                          String prefix)

Parameters:

bucket - the bucket name

continuationToken - the optional continuation token param

maxKeys - the optional max keys param

prefix - the optional prefix param

Returns:

the response object

createObjectOrUploadPart

@PUT
 @Path(value="{bucket}/{object:.+}")
 @Consumes(value="*/*")
public javax.ws.rs.core.Response createObjectOrUploadPart(@HeaderParam(value="Content-MD5")
                                                                                                                            String contentMD5,
                                                                                                                            @PathParam(value="bucket")
                                                                                                                            String bucket,
                                                                                                                            @PathParam(value="object")
                                                                                                                            String object,
                                                                                                                            @QueryParam(value="partNumber")
                                                                                                                            Integer partNumber,
                                                                                                                            @QueryParam(value="uploadId")
                                                                                                                            Long uploadId,
                                                                                                                            InputStream is)

Parameters:

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

@POST
 @Path(value="{bucket}/{object:.+}")
public javax.ws.rs.core.Response initiateOrCompleteMultipartUpload(@PathParam(value="bucket")
                                                                                                              String bucket,
                                                                                                              @PathParam(value="object")
                                                                                                              String object,
                                                                                                              @QueryParam(value="uploads")
                                                                                                              String uploads,
                                                                                                              @QueryParam(value="uploadId")
                                                                                                              Long uploadId)

Parameters:

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

@HEAD
 @Path(value="{bucket}/{object:.+}")
public javax.ws.rs.core.Response getObjectMetadata(@PathParam(value="bucket")
                                                                                              String bucket,
                                                                                              @PathParam(value="object")
                                                                                              String object)

Parameters:

bucket - the bucket name

object - the object name

Returns:

the response object

getObjectOrListParts

@GET
 @Path(value="{bucket}/{object:.+}")
 @Produces(value={"application/xml","application/octet-stream"})
public javax.ws.rs.core.Response getObjectOrListParts(@PathParam(value="bucket")
                                                                                                                                                                 String bucket,
                                                                                                                                                                 @PathParam(value="object")
                                                                                                                                                                 String object,
                                                                                                                                                                 @QueryParam(value="uploadId")
                                                                                                                                                                 Long uploadId)

Parameters:

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

@DELETE
 @Path(value="{bucket}/{object:.+}")
public javax.ws.rs.core.Response deleteObjectOrAbortMultipartUpload(@PathParam(value="bucket")
                                                                                                                 String bucket,
                                                                                                                 @PathParam(value="object")
                                                                                                                 String object,
                                                                                                                 @QueryParam(value="uploadId")
                                                                                                                 Long uploadId)

Parameters:

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