alluxio.s3

Class NettyRestUtils

java.lang.Object

alluxio.s3.NettyRestUtils

public class NettyRestUtils
extends Object

Utilities for handling S3 REST calls.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	NettyRestUtils.RestCallable<T> An interface representing a callable.

Field Summary

Fields

Modifier and Type	Field and Description
static Authenticator	AUTHENTICATOR
static io.netty.handler.codec.http.HttpVersion	HTTP_VERSION

Constructor Summary

Constructors

Constructor and Description
NettyRestUtils()

Method Summary

Modifier and Type	Method and Description
static <T> io.netty.handler.codec.http.HttpResponse	call(String resource, NettyRestUtils.RestCallable<T> callable) Calls the given NettyRestUtils.RestCallable and handles any exceptions thrown.
static Map<String,String>	convertToSingleValueMap(io.netty.handler.codec.http.HttpHeaders httpHeaders) Convert HttpHeaders to a single value map.
static javax.ws.rs.core.MediaType	deserializeContentType(Map<String,byte[]> xAttr) Given xAttr, parses and returns the Content-Type header metadata as its corresponding MediaType, or otherwise defaults to MediaType.APPLICATION_OCTET_STREAM_TYPE.
static TaggingData	deserializeTags(Map<String,byte[]> xAttr) Given xAttr, parses and deserializes the Tagging metadata into a TaggingData object.
static Map<String,String>	fromListValueMapToSingleValueMap(Map<String,List<String>> queryParameters) Convert MultivaluedMap to a single value map.
static Map<String,String>	fromMultiValueToSingleValueMap(javax.ws.rs.core.MultivaluedMap<String,String> queryParameters, boolean lowerCase) Convert MultivaluedMap to a single value map.
static String	getEntityTag(FileInfo status) This helper method is used to get the ETag xAttr on an object.
static String	getFullPath(String bucket, String object) Gets the full path combined by bucket name and object name.
static String	getScheme(io.netty.handler.codec.http.HttpRequest fullHttpRequest) Get the scheme of a HttpRequest.
static String	getUser(io.netty.handler.codec.http.HttpRequest request) Get username from header info from FullHttpRequest.
static String	getUserFromAuthorization(String authorization, AlluxioConfiguration conf) Gets the user from the authorization header string for AWS Signature Version 4.
static String	parsePath(String bucketPath) Format bucket path.
static S3Exception	toBucketS3Exception(Exception exception, String resource, S3AuditContext auditContext) Convert an exception to instance of S3Exception.
static S3Exception	toObjectS3Exception(Exception exception, String resource, S3AuditContext auditContext) Convert an exception to instance of S3Exception.

Methods inherited from class java.lang.Object

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

Field Detail

HTTP_VERSION

public static final io.netty.handler.codec.http.HttpVersion HTTP_VERSION

AUTHENTICATOR

public static final Authenticator AUTHENTICATOR

Constructor Detail

NettyRestUtils

public NettyRestUtils()

Method Detail

call

public static <T> io.netty.handler.codec.http.HttpResponse call(String resource,
                                                                NettyRestUtils.RestCallable<T> callable)

Calls the given NettyRestUtils.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

deserializeContentType

public static javax.ws.rs.core.MediaType deserializeContentType(Map<String,byte[]> xAttr)

Given xAttr, parses and returns the Content-Type header metadata as its corresponding MediaType, or otherwise defaults to MediaType.APPLICATION_OCTET_STREAM_TYPE.

Parameters:

xAttr - the Inode's xAttrs

Returns:

the MediaType corresponding to the Content-Type header

getEntityTag

@Nullable
public static String getEntityTag(FileInfo status)

This helper method is used to get the ETag xAttr on an object.

Parameters:

status - The URIStatus of the object

Returns:

the entityTag String, or null if it does not exist

parsePath

public static String parsePath(String bucketPath)

Format bucket path. Normalize the bucket by replacing ":" with "/".

Parameters:

bucketPath - bucket path

Returns:

bucket path after format

toBucketS3Exception

public static S3Exception toBucketS3Exception(Exception exception,
                                              String resource,
                                              S3AuditContext auditContext)

Convert an exception to instance of S3Exception.

Parameters:

exception - Exception thrown when process s3 object rest request

resource - complete bucket path

auditContext - the audit context for exception

Returns:

instance of S3Exception

toObjectS3Exception

public static S3Exception toObjectS3Exception(Exception exception,
                                              String resource,
                                              S3AuditContext auditContext)

Convert an exception to instance of S3Exception.

Parameters:

exception - Exception thrown when process s3 object rest request

resource - object complete path

auditContext - the audit context for exception

Returns:

instance of S3Exception

deserializeTags

public static TaggingData deserializeTags(Map<String,byte[]> xAttr)
                                   throws IOException

Given xAttr, parses and deserializes the Tagging metadata into a TaggingData object. Returns null if no data exists.

Parameters:

xAttr - the Inode's xAttrs

Returns:

the deserialized TaggingData object

Throws:

IOException

getUser

public static String getUser(io.netty.handler.codec.http.HttpRequest request)
                      throws S3Exception

Get username from header info from FullHttpRequest.

Parameters:

request - FullHttpRequest

Returns:

user name

Throws:

S3Exception

getUserFromAuthorization

@Nullable
public static String getUserFromAuthorization(String authorization,
                                                        AlluxioConfiguration conf)
                                                 throws S3Exception

Gets the user from the authorization header string for AWS Signature Version 4.

Parameters:

authorization - the authorization header string

conf - the AlluxioConfiguration Alluxio conf

Returns:

the user

Throws:

S3Exception

fromMultiValueToSingleValueMap

public static Map<String,String> fromMultiValueToSingleValueMap(javax.ws.rs.core.MultivaluedMap<String,String> queryParameters,
                                                                boolean lowerCase)

Convert MultivaluedMap to a single value map.

Parameters:

queryParameters - MultivaluedMap

lowerCase - whether to use lower case

Returns:

a single value map

convertToSingleValueMap

public static Map<String,String> convertToSingleValueMap(io.netty.handler.codec.http.HttpHeaders httpHeaders)

Convert HttpHeaders to a single value map.

Parameters:

httpHeaders - HttpHeaders

Returns:

a single value map

fromListValueMapToSingleValueMap

public static Map<String,String> fromListValueMapToSingleValueMap(Map<String,List<String>> queryParameters)

Convert MultivaluedMap to a single value map.

Parameters:

queryParameters - MultivaluedMap

Returns:

a single value map

getScheme

public static String getScheme(io.netty.handler.codec.http.HttpRequest fullHttpRequest)

Get the scheme of a HttpRequest.

Parameters:

fullHttpRequest - FullHttpRequest

Returns:

the scheme string

getFullPath

public static String getFullPath(String bucket,
                                 String object)

Gets the full path combined by bucket name and object name.

Parameters:

bucket -

object -

Returns:

Full path