com.ibm.cloud.objectstorage.services.s3.transfer.internal

Class TransferManagerUtils

java.lang.Object

com.ibm.cloud.objectstorage.services.s3.transfer.internal.TransferManagerUtils

public class TransferManagerUtils
extends Object

Internal utilities for multipart uploads with TransferManager.

Constructor Summary

Constructors

Constructor and Description
TransferManagerUtils()

Method Summary

Modifier and Type	Method and Description
static long	calculateOptimalPartSize(PutObjectRequest putObjectRequest, TransferManagerConfiguration configuration) Returns the optimal part size, in bytes, for each individual part upload in a multipart upload.
static long	calculateOptimalPartSizeForCopy(CopyObjectRequest copyObjectRequest, TransferManagerConfiguration configuration, long contentLengthOfSource) Calculates the optimal part size of each part request if the copy operation is carried out as multi-part copy.
static ThreadPoolExecutor	createDefaultExecutorService() Returns a new thread pool configured with the default settings.
static PauseStatus	determinePauseStatus(Transfer.TransferState transferState, boolean forceCancel) Determines the pause status based on the current state of transfer.
static long	getContentLength(PutObjectRequest putObjectRequest) Returns the size of the data in this request, otherwise -1 if the content length is unknown.
static Long	getContentLengthFromContentRange(ObjectMetadata metadata) Returns the content length of the object if response contains the Content-Range header and is well formed.
static File	getRequestFile(PutObjectRequest putObjectRequest) Convenience method for getting the file specified in a request.
static boolean	isDownloadParallelizable(AmazonS3 s3, GetObjectRequest getObjectRequest, Integer partCount) Returns true if the specified download request can use parallel part downloads for increased performance.
static boolean	isUploadParallelizable(PutObjectRequest putObjectRequest, boolean isUsingEncryption) Returns true if the specified upload request can use parallel part uploads for increased performance.
static boolean	shouldUseMultipartUpload(PutObjectRequest putObjectRequest, TransferManagerConfiguration configuration) Returns true if the the specified request should be processed as a multipart upload (instead of a single part upload).

Methods inherited from class java.lang.Object

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

Constructor Detail

TransferManagerUtils

public TransferManagerUtils()

Method Detail

createDefaultExecutorService

public static ThreadPoolExecutor createDefaultExecutorService()

Returns a new thread pool configured with the default settings.

Returns:

A new thread pool configured with the default settings.

isUploadParallelizable

public static boolean isUploadParallelizable(PutObjectRequest putObjectRequest,
                                             boolean isUsingEncryption)

Returns true if the specified upload request can use parallel part uploads for increased performance.

Parameters:

putObjectRequest - The request to check.

isUsingEncryption - True if the upload is an encrypted upload, otherwise false.

Returns:

True if this request can use parallel part uploads for faster uploads.

getContentLength

public static long getContentLength(PutObjectRequest putObjectRequest)

Returns the size of the data in this request, otherwise -1 if the content length is unknown.

Parameters:

putObjectRequest - The request to check.

Returns:

The size of the data in this request, otherwise -1 if the size of the data is unknown.

calculateOptimalPartSize

public static long calculateOptimalPartSize(PutObjectRequest putObjectRequest,
                                            TransferManagerConfiguration configuration)

Returns the optimal part size, in bytes, for each individual part upload in a multipart upload.

Parameters:

putObjectRequest - The request containing all the details of the upload.

configuration - Configuration values to use when calculating size.

Returns:

The optimal part size, in bytes, for each individual part upload in a multipart upload.

shouldUseMultipartUpload

public static boolean shouldUseMultipartUpload(PutObjectRequest putObjectRequest,
                                               TransferManagerConfiguration configuration)

Returns true if the the specified request should be processed as a multipart upload (instead of a single part upload).

Parameters:

putObjectRequest - The request containing all the details of the upload.

configuration - Configuration settings controlling how transfer manager processes requests.

Returns:

True if the the specified request should be processed as a multipart upload.

getRequestFile

public static File getRequestFile(PutObjectRequest putObjectRequest)

Convenience method for getting the file specified in a request.

calculateOptimalPartSizeForCopy

public static long calculateOptimalPartSizeForCopy(CopyObjectRequest copyObjectRequest,
                                                   TransferManagerConfiguration configuration,
                                                   long contentLengthOfSource)

Calculates the optimal part size of each part request if the copy operation is carried out as multi-part copy.

Parameters:

copyObjectRequest - the original request.

configuration - configuration containing the default part size.

contentLengthOfSource - content length of the Amazon S3 object.

Returns:

the optimal part size for a copy part request.

determinePauseStatus

public static PauseStatus determinePauseStatus(Transfer.TransferState transferState,
                                               boolean forceCancel)

Determines the pause status based on the current state of transfer.

isDownloadParallelizable

public static boolean isDownloadParallelizable(AmazonS3 s3,
                                               GetObjectRequest getObjectRequest,
                                               Integer partCount)

Returns true if the specified download request can use parallel part downloads for increased performance.

Parameters:

getObjectRequest - The request to check.

s3 - The Amazon s3 client.

Returns:

True if this request can use parallel part downloads.

getContentLengthFromContentRange

public static Long getContentLengthFromContentRange(ObjectMetadata metadata)

Returns the content length of the object if response contains the Content-Range header and is well formed. If the Content-Range header is missing or header is malformed or content length is missing in the header value, then a null value is returned. Note: If there is exception parsing the value, the exception is logged and a null value is returned. For example, Retuns 1234, if Content-Range value is bytes 42-1233/1234 Retuns null, if Content-Range value is missing Retuns null, if Content-Range value is not well formed bytes 42-1233/*