alluxio.proxy.s3

Class S3Handler

java.lang.Object

alluxio.proxy.s3.S3Handler

public class S3Handler
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static Pattern	BUCKET_ADJACENT_DOTS_DASHES_PATTERN
static Pattern	BUCKET_INVALID_SUFFIX_PATTERN
static Pattern	BUCKET_INVALIDATION_PREFIX_PATTERN
static boolean	BUCKET_NAMING_RESTRICTION_ENABLED
static com.google.common.cache.Cache<String,Boolean>	BUCKET_PATH_CACHE
static int	BUCKET_PATH_CACHE_SIZE
static Pattern	BUCKET_PATH_PATTERN
static Pattern	BUCKET_VALID_NAME_PATTERN
AsyncUserAccessAuditLogWriter	mAsyncAuditLogWriter
static int	MAX_HEADER_METADATA_SIZE
static boolean	MULTIPART_CLEANER_ENABLED
static Pattern	OBJECT_PATH_PATTERN

Constructor Summary

Constructors

Constructor and Description
S3Handler(String bucket, String object, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) S3Handler Constructor.

Method Summary

Modifier and Type	Method and Description
S3AuditContext	createAuditContext(String command, String user, String bucket, String object) Creates a S3AuditContext instance.
static S3Handler	createHandler(String path, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Create a S3Handler based on the incoming Request.
void	doAuthentication() Do S3 request authentication.
void	extractAMZHeaders() Utility function to help extract x-amz- headers from request.
String	getBucket() Get the bucket name of this request.
String	getHeader(String headerName) get specified HTTP header value of this request.
String	getHeaderOrDefault(String headerName, String defaultHeaderValue) get specified HTTP header with a default if not exist.
String	getHTTPVerb() get HTTP verb of this request.
javax.servlet.ServletInputStream	getInputStream() retrieve inputstream from incoming request.
FileSystem	getMetaFS() Get system user FileSystem object.
String	getObject() Get the object name of this request.
String	getQueryParameter(String queryParam) retrieve given query parameter value.
S3BaseTask	getS3Task() get S3Task of this S3Handler.
javax.servlet.ServletContext	getServletContext() get ServletContext from current http conversation.
javax.servlet.http.HttpServletRequest	getServletRequest() get HttpServletRequest of this request.
javax.servlet.http.HttpServletResponse	getServletResponse() get HttpServletResponse of this request.
com.google.common.base.Stopwatch	getStopwatch() Get Stopwatch object used for recording this request's latency.
String	getUser() Get the user name of this request.
void	init() Initialize the S3Handler object in preparation for handling the request.
String	printCollection(String prefix, Collection<? extends Object> collection) Utility function to dump a collection into a string.
String	printMap(String prefix, Map<? extends Object,? extends Object> map) Utility function to dump a map into a string.
static void	processResponse(javax.servlet.http.HttpServletResponse servletResponse, javax.ws.rs.core.Response response) Process the response returned from S3Task core logic to write to downstream.
void	rejectUnsupportedResources() Reject unsupported request from the given subresources from request.
void	setS3Task(S3BaseTask task) set S3Task for this S3Handler.
void	setStopwatch(com.google.common.base.Stopwatch stopwatch) Set the Stopwatch object used for recording this request's latency.

Methods inherited from class java.lang.Object

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

Field Detail

BUCKET_NAMING_RESTRICTION_ENABLED

public static final boolean BUCKET_NAMING_RESTRICTION_ENABLED

MAX_HEADER_METADATA_SIZE

public static final int MAX_HEADER_METADATA_SIZE

MULTIPART_CLEANER_ENABLED

public static final boolean MULTIPART_CLEANER_ENABLED

BUCKET_ADJACENT_DOTS_DASHES_PATTERN

public static final Pattern BUCKET_ADJACENT_DOTS_DASHES_PATTERN

BUCKET_INVALIDATION_PREFIX_PATTERN

public static final Pattern BUCKET_INVALIDATION_PREFIX_PATTERN

BUCKET_INVALID_SUFFIX_PATTERN

public static final Pattern BUCKET_INVALID_SUFFIX_PATTERN

BUCKET_VALID_NAME_PATTERN

public static final Pattern BUCKET_VALID_NAME_PATTERN

BUCKET_PATH_PATTERN

public static final Pattern BUCKET_PATH_PATTERN

OBJECT_PATH_PATTERN

public static final Pattern OBJECT_PATH_PATTERN

BUCKET_PATH_CACHE_SIZE

public static final int BUCKET_PATH_CACHE_SIZE

See Also:

Constant Field Values

BUCKET_PATH_CACHE

public static final com.google.common.cache.Cache<String,Boolean> BUCKET_PATH_CACHE

mAsyncAuditLogWriter

public AsyncUserAccessAuditLogWriter mAsyncAuditLogWriter

Constructor Detail

S3Handler

public S3Handler(String bucket,
                 String object,
                 javax.servlet.http.HttpServletRequest request,
                 javax.servlet.http.HttpServletResponse response)

S3Handler Constructor.

Parameters:

bucket -

object -

request -

response -

Method Detail

createHandler

public static S3Handler createHandler(String path,
                                      javax.servlet.http.HttpServletRequest request,
                                      javax.servlet.http.HttpServletResponse response)
                               throws Exception

Create a S3Handler based on the incoming Request.

Parameters:

path -

request -

response -

Returns:

A S3Handler

Throws:

Exception

processResponse

public static void processResponse(javax.servlet.http.HttpServletResponse servletResponse,
                                   javax.ws.rs.core.Response response)
                            throws IOException

Process the response returned from S3Task core logic to write to downstream.

Parameters:

servletResponse -

response -

Throws:

IOException

init

public void init()
          throws Exception

Initialize the S3Handler object in preparation for handling the request.

Throws:

Exception

getS3Task

public S3BaseTask getS3Task()

get S3Task of this S3Handler.

Returns:

S3BaseTask

setS3Task

public void setS3Task(S3BaseTask task)

set S3Task for this S3Handler.

Parameters:

task -

getHTTPVerb

public String getHTTPVerb()

get HTTP verb of this request.

Returns:

HTTP Verb

getHeader

public String getHeader(String headerName)

get specified HTTP header value of this request.

Parameters:

headerName -

Returns:

header value

getHeaderOrDefault

public String getHeaderOrDefault(String headerName,
                                 String defaultHeaderValue)

get specified HTTP header with a default if not exist.

Parameters:

headerName -

defaultHeaderValue -

Returns:

header value

getServletResponse

public javax.servlet.http.HttpServletResponse getServletResponse()

get HttpServletResponse of this request.

Returns:

HttpServletResponse

getServletRequest

public javax.servlet.http.HttpServletRequest getServletRequest()

get HttpServletRequest of this request.

Returns:

HttpServletRequest

getServletContext

public javax.servlet.ServletContext getServletContext()

get ServletContext from current http conversation.

Returns:

ServletContext

getQueryParameter

public String getQueryParameter(String queryParam)

retrieve given query parameter value.

Parameters:

queryParam -

Returns:

query parameter value

getInputStream

public javax.servlet.ServletInputStream getInputStream()
                                                throws IOException

retrieve inputstream from incoming request.

Returns:

ServletInputStream

Throws:

IOException

createAuditContext

public S3AuditContext createAuditContext(String command,
                                         String user,
                                         @Nullable
                                         String bucket,
                                         @Nullable
                                         String object)

Creates a S3AuditContext instance.

Parameters:

command - the command to be logged by this S3AuditContext

user - user name

bucket - bucket name

object - object name

Returns:

newly-created S3AuditContext instance

printCollection

public String printCollection(String prefix,
                              Collection<? extends Object> collection)

Utility function to dump a collection into a string.

Parameters:

prefix -

collection -

Returns:

result string

printMap

public String printMap(String prefix,
                       Map<? extends Object,? extends Object> map)

Utility function to dump a map into a string.

Parameters:

prefix -

map -

Returns:

result string

extractAMZHeaders

public void extractAMZHeaders()

Utility function to help extract x-amz- headers from request.

rejectUnsupportedResources

public void rejectUnsupportedResources()
                                throws S3Exception

Reject unsupported request from the given subresources from request.

Throws:

S3Exception

doAuthentication

public void doAuthentication()
                      throws Exception

Do S3 request authentication.

Throws:

Exception

getUser

public String getUser()

Get the user name of this request.

Returns:

user name

getBucket

public String getBucket()

Get the bucket name of this request.

Returns:

bucket name

getObject

public String getObject()

Get the object name of this request.

Returns:

object name

getMetaFS

public FileSystem getMetaFS()

Get system user FileSystem object.

Returns:

FileSystem object

getStopwatch

public com.google.common.base.Stopwatch getStopwatch()

Get Stopwatch object used for recording this request's latency.

Returns:

Stopwatch object

setStopwatch

public void setStopwatch(com.google.common.base.Stopwatch stopwatch)

Set the Stopwatch object used for recording this request's latency.

Parameters:

stopwatch -