Package org.nuxeo.ecm.core.storage.sql

Class S3Utils

java.lang.Object

org.nuxeo.ecm.core.storage.sql.S3Utils

public class S3Utils
extends Object

AWS S3 utilities.

Since:

10.1

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	S3Utils.SliceConsumer	Represents an operation that accepts a slice number and a slice begin and end position.

Field Summary

Fields

Modifier and Type	Field	Description
static long	MULTIPART_COPY_PART_SIZE_DEFAULT	Deprecated. since 2021.11, use S3BlobStoreConfiguration.MULTIPART_COPY_PART_SIZE_DEFAULT instead.
static String	MULTIPART_COPY_PART_SIZE_PROPERTY	Deprecated. since 2021.11, use S3BlobStoreConfiguration.MULTIPART_COPY_PART_SIZE_PROPERTY instead.
static long	NON_MULTIPART_COPY_MAX_SIZE	The maximum size of a file that can be copied without using multipart: 5 GB
static long	PART_SIZE	Deprecated. since 11.1, use MULTIPART_COPY_PART_SIZE_DEFAULT instead

Method Summary

Modifier and Type	Method	Description
static com.amazonaws.services.s3.model.ObjectMetadata	copyFile(com.amazonaws.services.s3.AmazonS3 amazonS3, com.amazonaws.services.s3.model.ObjectMetadata objectMetadata, String sourceBucket, String sourceKey, String targetBucket, String targetKey, boolean deleteSource)	Deprecated. since 11.1, use copyFileNonMultipart(com.amazonaws.services.s3.AmazonS3, com.amazonaws.services.s3.model.ObjectMetadata, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, boolean) instead
static com.amazonaws.services.s3.model.ObjectMetadata	copyFile(com.amazonaws.services.s3.AmazonS3 amazonS3, com.amazonaws.services.s3.model.ObjectMetadata objectMetadata, String sourceBucket, String sourceKey, String targetBucket, String targetKey, String targetSSEAlgorithm, boolean deleteSource)	Deprecated. since 11.2, use TransferManager.copy(java.lang.String, java.lang.String, java.lang.String, java.lang.String) instead
static com.amazonaws.services.s3.model.ObjectMetadata	copyFileMultipart(com.amazonaws.services.s3.AmazonS3 amazonS3, com.amazonaws.services.s3.model.ObjectMetadata objectMetadata, String sourceBucket, String sourceKey, String targetBucket, String targetKey, boolean deleteSource)	Deprecated. since 11.1, use copyFileMultipart(AmazonS3, ObjectMetadata, String, String, String, String, String, boolean) instead
static com.amazonaws.services.s3.model.ObjectMetadata	copyFileMultipart(com.amazonaws.services.s3.AmazonS3 amazonS3, com.amazonaws.services.s3.model.ObjectMetadata objectMetadata, String sourceBucket, String sourceKey, String targetBucket, String targetKey, String targetSSEAlgorithm, boolean deleteSource)	Deprecated. since 11.2, use TransferManager.copy(java.lang.String, java.lang.String, java.lang.String, java.lang.String) instead
static com.amazonaws.services.s3.model.ObjectMetadata	copyFileNonMultipart(com.amazonaws.services.s3.AmazonS3 amazonS3, com.amazonaws.services.s3.model.ObjectMetadata objectMetadata, String sourceBucket, String sourceKey, String targetBucket, String targetKey, String targetSSEAlgorithm, boolean deleteSource)	Deprecated. since 11.2, use TransferManager.copy(java.lang.String, java.lang.String, java.lang.String, java.lang.String) instead
static com.amazonaws.auth.AWSCredentialsProvider	getAWSCredentialsProvider(String accessKeyId, String secretKey, String sessionToken)	Gets the credentials providers for the given AWS key and secret.
static void	processSlices(long slice, long length, S3Utils.SliceConsumer consumer)	Calls the consumer on all slices.
protected static List<com.amazonaws.services.s3.model.PartETag>	responsesToETags(List<com.amazonaws.services.s3.model.CopyPartResult> responses)

Methods inherited from class java.lang.Object

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

Field Detail

NON_MULTIPART_COPY_MAX_SIZE

public static final long NON_MULTIPART_COPY_MAX_SIZE

The maximum size of a file that can be copied without using multipart: 5 GB

See Also:

Constant Field Values

MULTIPART_COPY_PART_SIZE_DEFAULT

@Deprecated(since="2021.11")
public static final long MULTIPART_COPY_PART_SIZE_DEFAULT

Deprecated.

since 2021.11, use S3BlobStoreConfiguration.MULTIPART_COPY_PART_SIZE_DEFAULT instead.

The default multipart copy part size. This default is used only if the configuration service is not available or if the configuration property "nuxeo.s3.multipart.copy.part.size" is not defined.

Since:

11.1

See Also:

Constant Field Values

PART_SIZE

@Deprecated
public static final long PART_SIZE

Deprecated.

since 11.1, use MULTIPART_COPY_PART_SIZE_DEFAULT instead

See Also:

Constant Field Values

MULTIPART_COPY_PART_SIZE_PROPERTY

@Deprecated(since="2021.11")
public static final String MULTIPART_COPY_PART_SIZE_PROPERTY

Deprecated.

since 2021.11, use S3BlobStoreConfiguration.MULTIPART_COPY_PART_SIZE_PROPERTY instead.

The configuration property to define the multipart copy part size.

Since:

11.1

See Also:

Constant Field Values

Method Detail

processSlices

public static void processSlices(long slice,
                                 long length,
                                 S3Utils.SliceConsumer consumer)

Calls the consumer on all slices.

Parameters:

slice - the slice size

length - the total length

consumer - the slice consumer

copyFile

@Deprecated
public static com.amazonaws.services.s3.model.ObjectMetadata copyFile(com.amazonaws.services.s3.AmazonS3 amazonS3,
                                                                      com.amazonaws.services.s3.model.ObjectMetadata objectMetadata,
                                                                      String sourceBucket,
                                                                      String sourceKey,
                                                                      String targetBucket,
                                                                      String targetKey,
                                                                      String targetSSEAlgorithm,
                                                                      boolean deleteSource)

Deprecated.

since 11.2, use TransferManager.copy(java.lang.String, java.lang.String, java.lang.String, java.lang.String) instead

Copies a file, using multipart upload if needed.

Parameters:

amazonS3 - the S3 client

objectMetadata - the metadata of the object being copied

sourceBucket - the source bucket

sourceKey - the source key

targetBucket - the target bucket

targetKey - the target key

targetSSEAlgorithm - the target SSE Algorithm to use, or null

deleteSource - whether to delete the source object if the copy is successful

Since:

11.1

copyFileMultipart

@Deprecated
public static com.amazonaws.services.s3.model.ObjectMetadata copyFileMultipart(com.amazonaws.services.s3.AmazonS3 amazonS3,
                                                                               com.amazonaws.services.s3.model.ObjectMetadata objectMetadata,
                                                                               String sourceBucket,
                                                                               String sourceKey,
                                                                               String targetBucket,
                                                                               String targetKey,
                                                                               boolean deleteSource)

Deprecated.

since 11.1, use copyFileMultipart(AmazonS3, ObjectMetadata, String, String, String, String, String, boolean) instead

Copies a file using multipart upload.

Parameters:

amazonS3 - the S3 client

objectMetadata - the metadata of the object being copied

sourceBucket - the source bucket

sourceKey - the source key

targetBucket - the target bucket

targetKey - the target key

deleteSource - whether to delete the source object if the copy is successful

copyFileMultipart

@Deprecated
public static com.amazonaws.services.s3.model.ObjectMetadata copyFileMultipart(com.amazonaws.services.s3.AmazonS3 amazonS3,
                                                                               com.amazonaws.services.s3.model.ObjectMetadata objectMetadata,
                                                                               String sourceBucket,
                                                                               String sourceKey,
                                                                               String targetBucket,
                                                                               String targetKey,
                                                                               String targetSSEAlgorithm,
                                                                               boolean deleteSource)

Deprecated.

since 11.2, use TransferManager.copy(java.lang.String, java.lang.String, java.lang.String, java.lang.String) instead

Copies a file using multipart upload.

Parameters:

amazonS3 - the S3 client

objectMetadata - the metadata of the object being copied

sourceBucket - the source bucket

sourceKey - the source key

targetBucket - the target bucket

targetKey - the target key

targetSSEAlgorithm - the target SSE Algorithm to use, or null

deleteSource - whether to delete the source object if the copy is successful

Since:

11.1

responsesToETags

protected static List<com.amazonaws.services.s3.model.PartETag> responsesToETags(List<com.amazonaws.services.s3.model.CopyPartResult> responses)

copyFile

@Deprecated
public static com.amazonaws.services.s3.model.ObjectMetadata copyFile(com.amazonaws.services.s3.AmazonS3 amazonS3,
                                                                      com.amazonaws.services.s3.model.ObjectMetadata objectMetadata,
                                                                      String sourceBucket,
                                                                      String sourceKey,
                                                                      String targetBucket,
                                                                      String targetKey,
                                                                      boolean deleteSource)

Deprecated.

since 11.1, use copyFileNonMultipart(com.amazonaws.services.s3.AmazonS3, com.amazonaws.services.s3.model.ObjectMetadata, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, boolean) instead

Copies a file without using multipart upload.

Parameters:

amazonS3 - the S3 client

objectMetadata - the metadata of the object being copied

sourceBucket - the source bucket

sourceKey - the source key

targetBucket - the target bucket

targetKey - the target key

deleteSource - whether to delete the source object if the copy is successful

copyFileNonMultipart

@Deprecated
public static com.amazonaws.services.s3.model.ObjectMetadata copyFileNonMultipart(com.amazonaws.services.s3.AmazonS3 amazonS3,
                                                                                  com.amazonaws.services.s3.model.ObjectMetadata objectMetadata,
                                                                                  String sourceBucket,
                                                                                  String sourceKey,
                                                                                  String targetBucket,
                                                                                  String targetKey,
                                                                                  String targetSSEAlgorithm,
                                                                                  boolean deleteSource)

Deprecated.

since 11.2, use TransferManager.copy(java.lang.String, java.lang.String, java.lang.String, java.lang.String) instead

Copies a file without using multipart upload.

Parameters:

amazonS3 - the S3 client

objectMetadata - the metadata of the object being copied

sourceBucket - the source bucket

sourceKey - the source key

targetBucket - the target bucket

targetKey - the target key

targetSSEAlgorithm - the target SSE Algorithm to use, or null

deleteSource - whether to delete the source object if the copy is successful

Since:

11.1

getAWSCredentialsProvider

public static com.amazonaws.auth.AWSCredentialsProvider getAWSCredentialsProvider(String accessKeyId,
                                                                                  String secretKey,
                                                                                  String sessionToken)

Gets the credentials providers for the given AWS key and secret.

Parameters:

accessKeyId - the AWS access key id

secretKey - the secret key

sessionToken - the session token (optional)

Since:

10.10