com.amazonaws.services.s3.internal

Class ServiceUtils

java.lang.Object

com.amazonaws.services.s3.internal.ServiceUtils

public class ServiceUtils
extends java.lang.Object

General utility methods used throughout the AWS S3 Java client.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ServiceUtils.RetryableS3DownloadTask Interface for the task of downloading object from S3 to a specific file, enabling one-time retry mechanism after integrity check failure on the downloaded file.

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	APPEND_MODE boolean to enable append mode
protected static com.amazonaws.util.DateUtils	DATE_UTILS Deprecated.
static boolean	OVERWRITE_MODE boolean to disable overwrite mode

Constructor Summary

Constructors

Constructor and Description
ServiceUtils()

Method Summary

Modifier and Type	Method and Description
static java.net.URL	convertRequestToUrl(com.amazonaws.Request<?> request) Converts the specified request object into a URL, containing all the specified parameters, the specified request endpoint, etc.
static java.net.URL	convertRequestToUrl(com.amazonaws.Request<?> request, boolean removeLeadingSlashInResourcePath) Converts the specified request object into a URL, containing all the specified parameters, the specified request endpoint, etc.
static void	downloadObjectToFile(S3Object s3Object, java.io.File destinationFile, boolean performIntegrityCheck, boolean appendData) Downloads an S3Object, as returned from AmazonS3Client.getObject(com.amazonaws.services.s3.model.GetObjectRequest) , to the specified file.
static java.lang.String	formatIso8601Date(java.util.Date date) Formats an instance of Date to ISO-8601.
static java.lang.String	formatRfc822Date(java.util.Date date) Formats an instance of Date to RFC-822.
static boolean	isMultipartUploadETag(java.lang.String eTag) Returns true if the specified ETag was from a multipart upload.
static java.lang.String	join(java.util.List<java.lang.String> strings) Returns a new string created by joining each of the strings in the specified list together, with a comma between them.
static java.util.Date	parseIso8601Date(java.lang.String dateString) Parses a date in ISO-8601 format to a Date object.
static java.util.Date	parseRfc822Date(java.lang.String dateString) Parses a date in RFC-822 format to a Date object.
static java.lang.String	removeQuotes(java.lang.String s) Removes any surrounding quotes from the specified string and returns a new string.
static S3Object	retryableDownloadS3ObjectToFile(java.io.File file, ServiceUtils.RetryableS3DownloadTask retryableS3DownloadTask, boolean appendData) Gets an object stored in S3 and downloads it into the specified file.
static boolean	skipMd5CheckPerRequest(com.amazonaws.AmazonWebServiceRequest request) Returns whether the specified request should skip MD5 check on the requested object content.
static boolean	skipMd5CheckPerRequest(com.amazonaws.AmazonWebServiceRequest request, S3ClientOptions clientOptions) Returns whether the specified request should skip MD5 check on the requested object content.
static boolean	skipMd5CheckPerResponse(ObjectMetadata metadata) Based on the given metadata of an S3 response, Returns whether the specified request should skip MD5 check on the requested object content.
static boolean	skipMd5CheckPerResponse(ObjectMetadata metadata, S3ClientOptions clientOptions) Based on the given metadata of an S3 response, Returns whether the specified request should skip MD5 check on the requested object content.
static byte[]	toByteArray(java.lang.String s) Safely converts a string to a byte array, first attempting to explicitly use our preferred encoding (UTF-8), and then falling back to the platform's default encoding if for some reason our preferred encoding isn't supported.

Methods inherited from class java.lang.Object

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

Field Detail

APPEND_MODE

public static final boolean APPEND_MODE

boolean to enable append mode

See Also:

Constant Field Values

OVERWRITE_MODE

public static final boolean OVERWRITE_MODE

boolean to disable overwrite mode

See Also:

Constant Field Values

DATE_UTILS

@Deprecated
protected static final com.amazonaws.util.DateUtils DATE_UTILS

Deprecated.

Constructor Detail

ServiceUtils

public ServiceUtils()

Method Detail

parseIso8601Date

public static java.util.Date parseIso8601Date(java.lang.String dateString)

Parses a date in ISO-8601 format to a Date object.

Parameters:

dateString - the date in ISO-8601 format.

Returns:

instance of Date.

formatIso8601Date

public static java.lang.String formatIso8601Date(java.util.Date date)

Formats an instance of Date to ISO-8601.

Parameters:

date - Date

Returns:

date in ISO-8601 format.

parseRfc822Date

public static java.util.Date parseRfc822Date(java.lang.String dateString)

Parses a date in RFC-822 format to a Date object.

Parameters:

dateString - the date in RFC-822 format.

Returns:

instance of Date.

formatRfc822Date

public static java.lang.String formatRfc822Date(java.util.Date date)

Formats an instance of Date to RFC-822.

Parameters:

date - Date

Returns:

date in RFC-822 format.

isMultipartUploadETag

public static boolean isMultipartUploadETag(java.lang.String eTag)

Returns true if the specified ETag was from a multipart upload.

Parameters:

eTag - The ETag to test.

Returns:

True if the specified ETag was from a multipart upload, otherwise false it if belongs to an object that was uploaded in a single part.

toByteArray

public static byte[] toByteArray(java.lang.String s)

Safely converts a string to a byte array, first attempting to explicitly use our preferred encoding (UTF-8), and then falling back to the platform's default encoding if for some reason our preferred encoding isn't supported.

Parameters:

s - The string to convert to a byte array.

Returns:

The byte array contents of the specified string.

removeQuotes

public static java.lang.String removeQuotes(java.lang.String s)

Removes any surrounding quotes from the specified string and returns a new string.

Parameters:

s - The string to check for surrounding quotes.

Returns:

A new string created from the specified string, minus any surrounding quotes.

convertRequestToUrl

public static java.net.URL convertRequestToUrl(com.amazonaws.Request<?> request)

Converts the specified request object into a URL, containing all the specified parameters, the specified request endpoint, etc.

Parameters:

request - The request to convert into a URL.

Returns:

A new URL representing the specified request.

Throws:

com.amazonaws.AmazonClientException - If the request cannot be converted to a well formed URL.

convertRequestToUrl

public static java.net.URL convertRequestToUrl(com.amazonaws.Request<?> request,
                                               boolean removeLeadingSlashInResourcePath)

Converts the specified request object into a URL, containing all the specified parameters, the specified request endpoint, etc.

Parameters:

request - The request to convert into a URL.

removeLeadingSlashInResourcePath - Whether the leading slash in resource-path should be removed before appending to the endpoint.

Returns:

A new URL representing the specified request.

Throws:

com.amazonaws.AmazonClientException - If the request cannot be converted to a well formed URL.

join

public static java.lang.String join(java.util.List<java.lang.String> strings)

Returns a new string created by joining each of the strings in the specified list together, with a comma between them.

Parameters:

strings - The list of strings to join into a single, comma delimited string list.

Returns:

A new string created by joining each of the strings in the specified list together, with a comma between strings.

downloadObjectToFile

public static void downloadObjectToFile(S3Object s3Object,
                                        java.io.File destinationFile,
                                        boolean performIntegrityCheck,
                                        boolean appendData)

Downloads an S3Object, as returned from AmazonS3Client.getObject(com.amazonaws.services.s3.model.GetObjectRequest) , to the specified file.

Parameters:

s3Object - The S3Object containing a reference to an InputStream containing the object's data.

destinationFile - The file to store the object's data in.

performIntegrityCheck - Boolean valuable to indicate whether to perform integrity check

appendData - appends the data to end of the file.

retryableDownloadS3ObjectToFile

public static S3Object retryableDownloadS3ObjectToFile(java.io.File file,
                                                       ServiceUtils.RetryableS3DownloadTask retryableS3DownloadTask,
                                                       boolean appendData)

Gets an object stored in S3 and downloads it into the specified file. This method includes the one-time retry mechanism after integrity check failure on the downloaded file. It will also return immediately after getting null valued S3Object (when getObject request does not meet the specified constraints).

Parameters:

file - The file to store the object's data in.

retryableS3DownloadTask - the task for download.

appendData - boolean to indicate if append data is enabled.

Returns:

S3Object.

skipMd5CheckPerResponse

public static boolean skipMd5CheckPerResponse(ObjectMetadata metadata)

Based on the given metadata of an S3 response, Returns whether the specified request should skip MD5 check on the requested object content. Specifically, MD5 check should be skipped if either SSE-KMS or SSE-C is involved.

The reason is that when SSE-KMS or SSE-C is involved, the MD5 returned from the server side is the MD5 of the ciphertext, which will by definition mismatch the MD5 on the client side which is computed based on the plaintext.

Parameters:

metadata - the ObjectMetadata of an S3 response.

Returns:

true if the specified response should skip MD5 check on the requested object content.

skipMd5CheckPerResponse

public static boolean skipMd5CheckPerResponse(ObjectMetadata metadata,
                                              S3ClientOptions clientOptions)

Based on the given metadata of an S3 response, Returns whether the specified request should skip MD5 check on the requested object content. Specifically, MD5 check should be skipped if either SSE-KMS or SSE-C is involved.

The reason is that when SSE-KMS or SSE-C is involved, the MD5 returned from the server side is the MD5 of the ciphertext, which will by definition mismatch the MD5 on the client side which is computed based on the plaintext.

Parameters:

metadata - the ObjectMetadata of an S3 response.

clientOptions - the S3 client options to see if check can be skipped

Returns:

true if the specified response should skip MD5 check on the requested object content.

skipMd5CheckPerRequest

public static boolean skipMd5CheckPerRequest(com.amazonaws.AmazonWebServiceRequest request)

Returns whether the specified request should skip MD5 check on the requested object content.

Parameters:

request - the AmazonWebServiceRequest.

Returns:

true if the specified request should skip MD5 check on the requested object content.

skipMd5CheckPerRequest

public static boolean skipMd5CheckPerRequest(com.amazonaws.AmazonWebServiceRequest request,
                                             S3ClientOptions clientOptions)

Returns whether the specified request should skip MD5 check on the requested object content.

Parameters:

request - the AmazonWebServiceRequest.

clientOptions - the S3 client options to see if check can be skipped

Returns:

true if the specified request should skip MD5 check on the requested object content.