com.sinacloud.scs.services.scs.internal

类 ServiceUtils

java.lang.Object

com.sinacloud.scs.services.scs.internal.ServiceUtils

public class ServiceUtils
extends Object

General utility methods used throughout the AWS S3 Java client.

嵌套类概要

嵌套类

限定符和类型	类和说明
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.

字段概要

字段

限定符和类型	字段和说明
protected static DateUtils	dateUtils

构造器概要

构造器

构造器和说明
ServiceUtils()

方法概要

方法

限定符和类型	方法和说明
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) Downloads an S3Object, as returned from SCSClient#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) 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.

从类继承的方法 java.lang.Object

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

字段详细资料

dateUtils

protected static final DateUtils dateUtils

构造器详细资料

ServiceUtils

public ServiceUtils()

方法详细资料

parseIso8601Date

public static Date parseIso8601Date(String dateString)
                             throws ParseException

抛出:

ParseException

formatIso8601Date

public static String formatIso8601Date(Date date)

parseRfc822Date

public static Date parseRfc822Date(String dateString)
                            throws ParseException

抛出:

ParseException

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.

参数:

eTag - The ETag to test.

返回:

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.

参数:

s - The string to convert to a byte array.

返回:

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.

参数:

s - The string to check for surrounding quotes.

返回:

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.

参数:

request - The request to convert into a URL.

返回:

A new URL representing the specified request.

抛出:

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.

参数:

request - The request to convert into a URL.

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

返回:

A new URL representing the specified request.

抛出:

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.

参数:

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

返回:

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)

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

参数:

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 do the integrity check or not

retryableDownloadS3ObjectToFile

public static S3Object retryableDownloadS3ObjectToFile(File file,
                                       ServiceUtils.RetryableS3DownloadTask retryableS3DownloadTask)

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).

参数:

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

safeS3DownloadTask - The implementation of SafeS3DownloadTask interface which allows user to get access to all the visible variables at the calling site of this method.