com.amazonaws.services.s3.internal

Class ServiceUtils

java.lang.Object

com.amazonaws.services.s3.internal.ServiceUtils

public class ServiceUtils
extends 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
protected static DateUtils	dateUtils Deprecated.
static boolean	OVERWRITE_MODE

Constructor Summary

Constructors

Constructor and Description
ServiceUtils()

Method Summary

Methods

Modifier and Type	Method and Description
static URL	convertRequestToUrl(Request<?> request) Converts the specified request object into a URL, containing all the specified parameters, the specified request endpoint, etc.
static URL	convertRequestToUrl(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, 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 String	formatIso8601Date(Date date)
static String	formatRfc822Date(Date date)
static boolean	isMultipartUploadETag(String eTag) Returns true if the specified ETag was from a multipart upload.
static String	join(List<String> strings) Returns a new string created by joining each of the strings in the specified list together, with a comma between them.
static Date	parseIso8601Date(String dateString)
static Date	parseRfc822Date(String dateString)
static String	removeQuotes(String s) Removes any surrounding quotes from the specified string and returns a new string.
static S3Object	retryableDownloadS3ObjectToFile(File file, ServiceUtils.RetryableS3DownloadTask retryableS3DownloadTask, boolean appendData) Gets an object stored in S3 and downloads it into the specified file.
static byte[]	toByteArray(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

See Also:

Constant Field Values

OVERWRITE_MODE

public static final boolean OVERWRITE_MODE

See Also:

Constant Field Values

dateUtils

@Deprecated
protected static final DateUtils dateUtils

Deprecated.

Constructor Detail

ServiceUtils

public ServiceUtils()

Method Detail

parseIso8601Date

public static Date parseIso8601Date(String dateString)

formatIso8601Date

public static String formatIso8601Date(Date date)

parseRfc822Date

public static Date parseRfc822Date(String dateString)

formatRfc822Date

public static String formatRfc822Date(Date date)

isMultipartUploadETag

public static boolean isMultipartUploadETag(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(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 String removeQuotes(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 URL convertRequestToUrl(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:

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

convertRequestToUrl

public static URL convertRequestToUrl(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:

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

join

public static String join(List<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,
                        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(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 implementation of SafeS3DownloadTask interface which allows user to get access to all the visible variables at the calling site of this method.