com.ibm.cloud.objectstorage.services.s3.model.AbstractPutObjectRequest Maven / Gradle / Ivy
Show all versions of ibm-cos-java-sdk-s3 Show documentation
/*
* Copyright 2014-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
package com.ibm.cloud.objectstorage.services.s3.model;
import com.ibm.cloud.objectstorage.AmazonWebServiceRequest;
import com.ibm.cloud.objectstorage.event.ProgressListener;
import java.io.File;
import java.io.InputStream;
import java.io.Serializable;
import java.util.Date;
/**
* Abstract base class for a put object or put object like request.
*/
public abstract class AbstractPutObjectRequest extends AmazonWebServiceRequest implements
Cloneable, SSECustomerKeyProvider, SSEAwsKeyManagementParamsProvider, S3DataSource, Serializable {
/**
* The name of an existing bucket, to which this request will upload a new
* object. You must have {@link Permission#Write} permission granted to you
* in order to upload new objects to a bucket.
*
*
* When using this action with an access point, you must direct requests to the access point hostname. The
* access point hostname takes the form
* AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action
* with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the
* bucket name. For more information about access point ARNs, see Using access points
* in the Amazon S3 User Guide.
*
*
* When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The
* S3 on Outposts hostname takes the form
* AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com.
* When you use this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts
* access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts in the
* Amazon S3 User Guide.
*
*/
private String bucketName;
/**
* The key under which to store the new object.
*/
private String key;
/**
* The file containing the data to be uploaded to Amazon S3. You must either
* specify a file or an InputStream containing the data to be uploaded to
* Amazon S3.
*/
private File file;
/**
* The InputStream containing the data to be uploaded to Amazon S3. You must
* either specify a file or an InputStream containing the data to be
* uploaded to Amazon S3.
*/
private transient InputStream inputStream;
/**
* Optional metadata instructing Amazon S3 how to handle the uploaded data
* (e.g. custom user metadata, hooks for specifying content type, etc.). If
* you are uploading from an InputStream, you should always
* specify metadata with the content size set, otherwise the contents of the
* InputStream will have to be buffered in memory before they can be sent to
* Amazon S3, which can have very negative performance impacts.
*/
private ObjectMetadata metadata;
/**
* An optional pre-configured access control policy to use for the new
* object. Ignored in favor of accessControlList, if present.
*/
private CannedAccessControlList cannedAcl;
/**
* An optional access control list to apply to the new object. If specified,
* cannedAcl will be ignored.
*/
private AccessControlList accessControlList;
/**
* The optional Amazon S3 storage class to use when storing the new object.
* If not specified, the default, standard storage class will be used.
*
* For more information on Amazon S3 storage classes and available values,
* see the {@link StorageClass} enumeration.
*/
private String storageClass;
/** The optional redirect location about an object */
private String redirectLocation;
/**
* The optional customer-provided server-side encryption key to use to
* encrypt the uploaded object.
*/
private SSECustomerKey sseCustomerKey;
/**
* The optional Amazon Web Services Key Management system parameters to be used to encrypt
* the the object on the server side.
*/
private SSEAwsKeyManagementParams sseAwsKeyManagementParams;
private ObjectTagging tagging;
private String objectLockMode;
/**
* Date on which it will be legal to delete or modify the object.
* You can only specify this or the Retention-Period header.
* If both are specified a 400 error will be returned.
* If neither is specified the bucket's DefaultRetention period will be used.
* This header should be used to calculate a retention period in seconds and then stored in that manner.
*/
private Date retentionExpirationDate;
private Date objectLockRetainUntilDate;
/**
* A single legal hold to apply to the object.
* A legal hold is a Y character long string.
* The object cannot be overwritten or deleted until all legal holds associated with the object are removed.
*/
private String retentionLegalHoldId;
private String objectLockLegalHoldStatus;
/**
* Retention period to store on the object in seconds.
* If this field and Retention-Expiration-Date are specified a 400 error is returned.
* If neither is specified the bucket's DefaultRetention period will be used.
* 0 is a legal value assuming the bucket's minimum retention period is also 0.
*/
private Long retentionPeriod;
private Boolean bucketKeyEnabled;
//IBM does not support SSE-KMS
//private Boolean bucketKeyEnabled;
/**
* Constructs a new
* {@link AbstractPutObjectRequest} object to upload a file to the
* specified bucket and key. After constructing the request,
* users may optionally specify object metadata or a canned ACL as well.
*
* When using this action with an access point, you must direct requests to the access point hostname. The
* access point hostname takes the form
* AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action
* with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the
* bucket name. For more information about access point ARNs, see Using access points
* in the Amazon S3 User Guide.
*
*
* When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The
* S3 on Outposts hostname takes the form
* AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com.
* When you use this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts
* access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts in the
* Amazon S3 User Guide.
*
*
* @param bucketName
* The name of an existing bucket to which the new object will be uploaded.
*
* When using this action with an access point, you must direct requests to the access point hostname.
* The access point hostname takes the form
* AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this
* action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in
* place of the bucket name. For more information about access point ARNs, see Using access
* points in the Amazon S3 User Guide.
*
*
* When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts
* hostname. The S3 on Outposts hostname takes the form
* AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com.
* When you use this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts
* access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts
* in the Amazon S3 User Guide.
* @param key
* The key under which to store the new object.
* @param file
* The path of the file to upload to Amazon S3.
*/
public AbstractPutObjectRequest(String bucketName, String key, File file) {
this.bucketName = bucketName;
this.key = key;
this.file = file;
}
/**
* Constructs a new {@link AbstractPutObjectRequest} object with redirect location.
* After constructing the request, users may optionally specify object
* metadata or a canned ACL as well.
*
* When using this action with an access point, you must direct requests to the access point hostname. The
* access point hostname takes the form
* AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action
* with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the
* bucket name. For more information about access point ARNs, see Using access points
* in the Amazon S3 User Guide.
*
*
* When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The
* S3 on Outposts hostname takes the form
* AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com.
* When you use this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts
* access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts in the
* Amazon S3 User Guide.
*
*
* @param bucketName
* The name of an existing bucket to which the new object will be
* uploaded.
*
* When using this action with an access point, you must direct requests to the access point hostname.
* The access point hostname takes the form
* AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this
* action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in
* place of the bucket name. For more information about access point ARNs, see Using access
* points in the Amazon S3 User Guide.
*
*
* When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts
* hostname. The S3 on Outposts hostname takes the form
* AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com.
* When you use this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts
* access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts
* in the Amazon S3 User Guide.
* @param key
* The key under which to store the new object.
* @param redirectLocation
* The redirect location of this new object.
*/
public AbstractPutObjectRequest(String bucketName, String key,
String redirectLocation) {
this.bucketName = bucketName;
this.key = key;
this.redirectLocation = redirectLocation;
}
/**
* Constructs a new
* {@link AbstractPutObjectRequest} object to upload a stream of data to
* the specified bucket and key. After constructing the request,
* users may optionally specify object metadata or a canned ACL as well.
*
* Content length for the data stream must be
* specified in the object metadata parameter; Amazon S3 requires it
* be passed in before the data is uploaded. Failure to specify a content
* length will cause the entire contents of the input stream to be buffered
* locally in memory so that the content length can be calculated, which can
* result in negative performance problems.
*
*
* When using this action with an access point, you must direct requests to the access point hostname. The
* access point hostname takes the form
* AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action
* with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the
* bucket name. For more information about access point ARNs, see Using access points
* in the Amazon S3 User Guide.
*
*
* When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The
* S3 on Outposts hostname takes the form
* AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com.
* When you use this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts
* access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts in the
* Amazon S3 User Guide.
*
*
* @param bucketName
* The name of an existing bucket to which the new object will be
* uploaded.
*
* When using this action with an access point, you must direct requests to the access point hostname.
* The access point hostname takes the form
* AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this
* action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in
* place of the bucket name. For more information about access point ARNs, see Using access
* points in the Amazon S3 User Guide.
*
*
* When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts
* hostname. The S3 on Outposts hostname takes the form
* AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com.
* When you use this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts
* access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts
* in the Amazon S3 User Guide.
* @param key
* The key under which to store the new object.
* @param input
* The stream of data to upload to Amazon S3.
* @param metadata
* The object metadata. At minimum this specifies the
* content length for the stream of data being uploaded.
*/
protected AbstractPutObjectRequest(String bucketName, String key,
InputStream input, ObjectMetadata metadata) {
this.bucketName = bucketName;
this.key = key;
this.inputStream = input;
this.metadata = metadata;
}
/**
*
* The bucket name to which the PUT action was initiated.
*
*
* When using this action with an access point, you must direct requests to the access point hostname. The
* access point hostname takes the form
* AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action
* with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the
* bucket name. For more information about access point ARNs, see Using access points
* in the Amazon S3 User Guide.
*
*
* When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The
* S3 on Outposts hostname takes the form
* AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com.
* When you use this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts
* access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts in the
* Amazon S3 User Guide.
*
*
* @return The bucket name to which the PUT action was initiated.
*
* When using this action with an access point, you must direct requests to the access point hostname.
* The access point hostname takes the form
* AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this
* action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in
* place of the bucket name. For more information about access point ARNs, see Using access
* points in the Amazon S3 User Guide.
*
*
* When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts
* hostname. The S3 on Outposts hostname takes the form
* AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com.
* When you use this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts
* access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts
* in the Amazon S3 User Guide.
*
* @see AbstractPutObjectRequest#setBucketName(String)
* @see AbstractPutObjectRequest#withBucketName(String)
*/
public String getBucketName() {
return bucketName;
}
/**
*
* The bucket name to which the PUT action was initiated.
*
*
* When using this action with an access point, you must direct requests to the access point hostname. The
* access point hostname takes the form
* AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action
* with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the
* bucket name. For more information about access point ARNs, see Using access points
* in the Amazon S3 User Guide.
*
*
* When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The
* S3 on Outposts hostname takes the form
* AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com.
* When you use this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts
* access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts in the
* Amazon S3 User Guide.
*
*
* @param bucketName
* The bucket name to which the PUT action was initiated.
*
* When using this action with an access point, you must direct requests to the access point hostname.
* The access point hostname takes the form
* AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this
* action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in
* place of the bucket name. For more information about access point ARNs, see Using access
* points in the Amazon S3 User Guide.
*
*
* When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts
* hostname. The S3 on Outposts hostname takes the form
* AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com.
* When you use this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts
* access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts
* in the Amazon S3 User Guide.
*
* @see AbstractPutObjectRequest#getBucketName()
* @see AbstractPutObjectRequest#withBucketName(String)
*/
public void setBucketName(String bucketName) {
this.bucketName = bucketName;
}
/**
*
* The bucket name to which the PUT action was initiated.
*
*
* When using this action with an access point, you must direct requests to the access point hostname. The
* access point hostname takes the form
* AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action
* with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the
* bucket name. For more information about access point ARNs, see Using access points
* in the Amazon S3 User Guide.
*
*
* When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The
* S3 on Outposts hostname takes the form
* AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com.
* When you use this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts
* access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts in the
* Amazon S3 User Guide.
*
*
* @param bucketName
* The bucket name to which the PUT action was initiated.
*
* When using this action with an access point, you must direct requests to the access point hostname.
* The access point hostname takes the form
* AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this
* action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in
* place of the bucket name. For more information about access point ARNs, see Using access
* points in the Amazon S3 User Guide.
*
*
* When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts
* hostname. The S3 on Outposts hostname takes the form
* AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com.
* When you use this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts
* access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts
* in the Amazon S3 User Guide.
*
* @return This {@link AbstractPutObjectRequest}, enabling additional method calls to be
* chained together.
*
* @see AbstractPutObjectRequest#getBucketName()
* @see AbstractPutObjectRequest#setBucketName(String)
*/
public T withBucketName(
String bucketName) {
setBucketName(bucketName);
@SuppressWarnings("unchecked") T t = (T)this;
return t;
}
/**
* Gets the key under which to store the new object.
*
* @return The key under which to store the new object.
*
* @see AbstractPutObjectRequest#setKey(String)
* @see AbstractPutObjectRequest#withKey(String)
*/
public String getKey() {
return key;
}
/**
* Sets the key under which to store the new object.
*
* @param key
* The key under which to store the new object.
*
* @see AbstractPutObjectRequest#getKey()
* @see AbstractPutObjectRequest#withKey(String)
*/
public void setKey(String key) {
this.key = key;
}
/**
* Sets the key under which to store the new object. Returns this object,
* enabling additional method calls to be chained together.
*
* @param key
* The key under which to store the new object.
*
* @return This {@link AbstractPutObjectRequest}, enabling additional method calls to be
* chained together.
*
* @see AbstractPutObjectRequest#getKey()
* @see AbstractPutObjectRequest#setKey(String)
*/
public T withKey(String key) {
setKey(key);
@SuppressWarnings("unchecked") T t = (T)this;
return t;
}
/**
* Gets the optional Amazon S3 storage class to use when storing the new
* object. If not specified, the default standard storage class is
* used when storing the object.
*
* For more information on available Amazon S3 storage classes, see the
* {@link StorageClass} enumeration.
*
*
* @return The Amazon S3 storage class to use when storing the newly copied
* object.
*
* @see AbstractPutObjectRequest#setStorageClass(String)
* @see AbstractPutObjectRequest#setStorageClass(StorageClass)
* @see AbstractPutObjectRequest#withStorageClass(StorageClass)
* @see AbstractPutObjectRequest#withStorageClass(String)
*/
public String getStorageClass() {
return storageClass;
}
/**
* Sets the optional Amazon S3 storage class to use when storing the new
* object. If not specified, the default standard storage class will be
* used when storing the new object.
*
* For more information on Amazon S3 storage classes and available values,
* see the {@link StorageClass} enumeration.
*
*
* @param storageClass
* The storage class to use when storing the new object.
*
* @see #getStorageClass()
* @see #setStorageClass(String)
* @see #withStorageClass(StorageClass)
* @see #withStorageClass(String)
*/
public void setStorageClass(String storageClass) {
this.storageClass = storageClass;
}
/**
* Sets the optional Amazon S3 storage class to use when storing the new
* object. Returns this {@link AbstractPutObjectRequest}, enabling additional method
* calls to be chained together. If not specified, the default standard
* storage class will be used when storing the object.
*
* For more information on Amazon S3 storage classes and available values,
* see the {@link StorageClass} enumeration.
*
*
* @param storageClass
* The storage class to use when storing the new object.
*
* @return This {@link AbstractPutObjectRequest}, enabling additional method calls to be
* chained together.
*
* @see AbstractPutObjectRequest#getStorageClass()
* @see AbstractPutObjectRequest#setStorageClass(StorageClass)
* @see AbstractPutObjectRequest#setStorageClass(String)
* @see AbstractPutObjectRequest#withStorageClass(StorageClass)
*/
public T withStorageClass(
String storageClass) {
setStorageClass(storageClass);
@SuppressWarnings("unchecked") T t = (T)this;
return t;
}
/**
* Sets the optional Amazon S3 storage class to use when storing the new
* object. If not specified, the default standard storage class will be
* used when storing the object.
*
* For more information on Amazon S3 storage classes and available values,
* see the {@link StorageClass} enumeration.
*
*
* @param storageClass
* The storage class to use when storing the new object.
*
* @see #getStorageClass()
* @see #setStorageClass(String)
*/
public void setStorageClass(StorageClass storageClass) {
this.storageClass = storageClass.toString();
}
/**
* Sets the optional Amazon S3 storage class to use when storing the new
* object. Returns this {@link AbstractPutObjectRequest}, enabling additional method
* calls to be chained together. If not specified, the default standard
* storage class will be used when storing the object.
*
* For more information on Amazon S3 storage classes and available values,
* see the {@link StorageClass} enumeration.
*
*
* @param storageClass
* The storage class to use when storing the new object.
*
* @return This {@link AbstractPutObjectRequest}, enabling additional method calls to be
* chained together.
*
* @see AbstractPutObjectRequest#getStorageClass()
* @see AbstractPutObjectRequest#setStorageClass(StorageClass)
* @see AbstractPutObjectRequest#setStorageClass(String)
* @see AbstractPutObjectRequest#withStorageClass(String)
*/
public T withStorageClass(
StorageClass storageClass) {
setStorageClass(storageClass);
@SuppressWarnings("unchecked") T t = (T)this;
return t;
}
/**
* Gets the path and name of the file
* containing the data to be uploaded to Amazon S3.
* Either specify a file or an input stream containing the data to be
* uploaded to Amazon S3; both cannot be specified.
*
* @return The path and name of the file
* containing the data to be uploaded to Amazon S3.
*
* @see AbstractPutObjectRequest#setFile(File)
* @see AbstractPutObjectRequest#withFile(File)
* @see AbstractPutObjectRequest#setInputStream(InputStream)
* @see AbstractPutObjectRequest#withInputStream(InputStream)
*/
@Override
public File getFile() {
return file;
}
/**
* Sets the path and name of the file
* containing the data to be uploaded to Amazon S3.
* Either specify a file or an input stream containing the data to be
* uploaded to Amazon S3; both cannot be specified.
*
* @param file
* The path and name of the
* file containing the data to be uploaded to Amazon S3.
*
* @see AbstractPutObjectRequest#getFile()
* @see AbstractPutObjectRequest#withFile(File)
* @see AbstractPutObjectRequest#getInputStream()
* @see AbstractPutObjectRequest#withInputStream(InputStream)
*/
@Override
public void setFile(File file) {
this.file = file;
}
/**
* Sets the file containing the data to be uploaded to Amazon S3.
* Returns this {@link AbstractPutObjectRequest}, enabling additional method
* calls to be chained together.
*
* Either specify a file or an input stream containing the data to
* be uploaded to Amazon S3; both cannot be specified.
*
* @param file
* The file containing the data to be uploaded to Amazon S3.
*
* @return This {@link AbstractPutObjectRequest}, enabling additional method
* calls to be chained together.
*
* @see AbstractPutObjectRequest#getFile()
* @see AbstractPutObjectRequest#setFile(File)
* @see AbstractPutObjectRequest#getInputStream()
* @see AbstractPutObjectRequest#setInputStream(InputStream)
*/
public T withFile(File file) {
setFile(file);
@SuppressWarnings("unchecked") T t = (T)this;
return t;
}
/**
* Gets the optional metadata instructing Amazon S3 how to handle the
* uploaded data (e.g. custom user metadata, hooks for specifying content
* type, etc.).
*
* If uploading from an input stream,
* always specify metadata with the content size set. Otherwise the
* contents of the input stream have to be buffered in memory before
* being sent to Amazon S3. This can cause very negative performance
* impacts.
*
*
* @return The optional metadata instructing Amazon S3 how to handle the
* uploaded data (e.g. custom user metadata, hooks for specifying
* content type, etc.).
*
* @see AbstractPutObjectRequest#setMetadata(ObjectMetadata)
* @see AbstractPutObjectRequest#withMetadata(ObjectMetadata)
*/
public ObjectMetadata getMetadata() {
return metadata;
}
/**
* Sets the optional metadata instructing Amazon S3 how to handle the
* uploaded data (e.g. custom user metadata, hooks for specifying content
* type, etc.).
*
* If uploading from an input stream,
* always specify metadata with the content size set. Otherwise the
* contents of the input stream have to be buffered in memory before
* being sent to Amazon S3. This can cause very negative performance
* impacts.
*
*
* @param metadata
* The optional metadata instructing Amazon S3 how to handle the
* uploaded data (e.g. custom user metadata, hooks for specifying
* content type, etc.).
*
* @see AbstractPutObjectRequest#getMetadata()
* @see AbstractPutObjectRequest#withMetadata(ObjectMetadata)
*/
public void setMetadata(ObjectMetadata metadata) {
this.metadata = metadata;
}
/**
* Sets the optional metadata instructing Amazon S3 how to handle the
* uploaded data (e.g. custom user metadata, hooks for specifying content
* type, etc.). Returns this {@link AbstractPutObjectRequest}, enabling additional method
* calls to be chained together.
*
* If uploading from an input stream,
* always specify metadata with the content size set. Otherwise the
* contents of the input stream have to be buffered in memory before
* being sent to Amazon S3. This can cause very negative performance
* impacts.
*
*
* @param metadata
* The optional metadata instructing Amazon S3 how to handle the
* uploaded data (e.g. custom user metadata, hooks for specifying
* content type, etc.).
*
* @return This {@link AbstractPutObjectRequest}, enabling additional method
* calls to be chained together.
*
* @see AbstractPutObjectRequest#getMetadata()
* @see AbstractPutObjectRequest#setMetadata(ObjectMetadata)
*/
public T withMetadata(
ObjectMetadata metadata) {
setMetadata(metadata);
@SuppressWarnings("unchecked") T t = (T)this;
return t;
}
/**
* Gets the optional pre-configured access control policy to use for the
* new object.
*
* @return The optional pre-configured access control policy to use for the
* new object.
*
* @see AbstractPutObjectRequest#setCannedAcl(CannedAccessControlList)
* @see AbstractPutObjectRequest#withCannedAcl(CannedAccessControlList)
*/
public CannedAccessControlList getCannedAcl() {
return cannedAcl;
}
/**
* Sets the optional pre-configured access control policy to use for the new
* object.
*
* @param cannedAcl
* The optional pre-configured access control policy to use for
* the new object.
*
* @see AbstractPutObjectRequest#getCannedAcl()
* @see AbstractPutObjectRequest#withCannedAcl(CannedAccessControlList)
*/
public void setCannedAcl(CannedAccessControlList cannedAcl) {
this.cannedAcl = cannedAcl;
}
/**
* Sets the optional pre-configured access control policy to use for the new
* object. Returns this {@link AbstractPutObjectRequest}, enabling additional method
* calls to be chained together.
*
* @param cannedAcl
* The optional pre-configured access control policy to use for
* the new object.
*
* @return This {@link AbstractPutObjectRequest}, enabling additional method
* calls to be chained together.
*
* @see AbstractPutObjectRequest#getCannedAcl()
* @see AbstractPutObjectRequest#setCannedAcl(CannedAccessControlList)
*/
public T withCannedAcl(
CannedAccessControlList cannedAcl) {
setCannedAcl(cannedAcl);
@SuppressWarnings("unchecked") T t = (T) this;
return t;
}
/**
* Returns the optional access control list for the new object. If
* specified, cannedAcl will be ignored.
*/
public AccessControlList getAccessControlList() {
return accessControlList;
}
/**
* Sets the optional access control list for the new object. If specified,
* cannedAcl will be ignored.
*
* @param accessControlList
* The access control list for the new object.
*/
public void setAccessControlList(AccessControlList accessControlList) {
this.accessControlList = accessControlList;
}
/**
* Sets the optional access control list for the new object. If specified,
* cannedAcl will be ignored. Returns this {@link AbstractPutObjectRequest},
* enabling additional method calls to be chained together.
*
* @param accessControlList
* The access control list for the new object.
*/
public T withAccessControlList(
AccessControlList accessControlList) {
setAccessControlList(accessControlList);
@SuppressWarnings("unchecked") T t = (T)this;
return t;
}
/**
* Gets the input stream containing the data to be uploaded to Amazon S3.
* The user of this request
* must either specify a file or an input stream containing the data to be
* uploaded to Amazon S3; both cannot be specified.
*
* @return The input stream containing the data to be uploaded to Amazon S3.
* Either specify a file or an input stream containing the
* data to be uploaded to Amazon S3, not both.
*
* @see AbstractPutObjectRequest#setInputStream(InputStream)
* @see AbstractPutObjectRequest#withInputStream(InputStream)
* @see AbstractPutObjectRequest#setFile(File)
* @see AbstractPutObjectRequest#withFile(File)
*/
@Override
public InputStream getInputStream() {
return inputStream;
}
/**
* Sets the input stream containing the data to be uploaded to Amazon S3.
* Either specify a file or an input stream containing the data to be
* uploaded to Amazon S3; both cannot be specified.
*
* @param inputStream
* The input stream containing the data to be uploaded to Amazon
* S3. Either specify a file or an input stream containing the
* data to be uploaded to Amazon S3, not both.
*
* @see AbstractPutObjectRequest#getInputStream()
* @see AbstractPutObjectRequest#withInputStream(InputStream)
* @see AbstractPutObjectRequest#getFile()
* @see AbstractPutObjectRequest#withFile(File)
*/
@Override
public void setInputStream(InputStream inputStream) {
this.inputStream = inputStream;
}
/**
* Sets the input stream containing the data to be uploaded to Amazon S3.
* Returns this {@link AbstractPutObjectRequest}, enabling additional method
* calls to be chained together.
*
* Either specify a file or an input stream containing the data to be
* uploaded to Amazon S3; both cannot be specified.
*
*
* @param inputStream
* The InputStream containing the data to be uploaded to Amazon
* S3.
*
* @return This PutObjectRequest, so that additional method calls can be
* chained together.
*
* @see AbstractPutObjectRequest#getInputStream()
* @see AbstractPutObjectRequest#setInputStream(InputStream)
* @see AbstractPutObjectRequest#getFile()
* @see AbstractPutObjectRequest#setFile(File)
*/
public T withInputStream(
InputStream inputStream) {
setInputStream(inputStream);
@SuppressWarnings("unchecked") T t = (T)this;
return t;
}
/**
* Sets the optional redirect location for the new object.
*
* @param redirectLocation
* The redirect location for the new object.
*/
public void setRedirectLocation(String redirectLocation) {
this.redirectLocation = redirectLocation;
}
/**
* Gets the optional redirect location for the new object.
*/
public String getRedirectLocation() {
return this.redirectLocation;
}
/**
* Sets the optional redirect location for the new object.Returns this
* {@link AbstractPutObjectRequest}, enabling additional method calls to be chained
* together.
* @param redirectLocation
* The redirect location for the new object.
*/
public T withRedirectLocation(
String redirectLocation) {
this.redirectLocation = redirectLocation;
@SuppressWarnings("unchecked") T t = (T)this;
return t;
}
@Override
public SSECustomerKey getSSECustomerKey() {
return sseCustomerKey;
}
/**
* Sets the optional customer-provided server-side encryption key to use to
* encrypt the uploaded object.
*
* @param sseKey
* The optional customer-provided server-side encryption key to
* use to encrypt the uploaded object.
*/
public void setSSECustomerKey(SSECustomerKey sseKey) {
if (sseKey != null && this.sseAwsKeyManagementParams != null) {
throw new IllegalArgumentException(
"Either SSECustomerKey or SSEAwsKeyManagementParams must not be set at the same time.");
}
this.sseCustomerKey = sseKey;
}
/**
* Sets the optional customer-provided server-side encryption key to use to
* encrypt the uploaded object, and returns the updated request object so
* that additional method calls can be chained together.
*
* @param sseKey
* The optional customer-provided server-side encryption key to
* use to encrypt the uploaded object.
*
* @return This updated request object so that additional method calls can
* be chained together.
*/
public T withSSECustomerKey(
SSECustomerKey sseKey) {
setSSECustomerKey(sseKey);
@SuppressWarnings("unchecked") T t = (T)this;
return t;
}
public ObjectTagging getTagging() {
return tagging;
}
public void setTagging(ObjectTagging tagging) {
this.tagging = tagging;
}
public T withTagging(ObjectTagging tagSet) {
setTagging(tagSet);
T t = (T)this;
return t;
}
/**
* The Object Lock mode that you want to apply to this object.
*/
public String getObjectLockMode() {
return objectLockMode;
}
/**
* The Object Lock mode that you want to apply to this object.
*/
public T withObjectLockMode(String objectLockMode) {
this.objectLockMode = objectLockMode;
return (T) this;
}
/**
* The Object Lock mode that you want to apply to this object.
*/
public T withObjectLockMode(ObjectLockMode objectLockMode) {
return withObjectLockMode(objectLockMode.toString());
}
/**
* The Object Lock mode that you want to apply to this object.
*/
public void setObjectLockMode(String objectLockMode) {
withObjectLockMode(objectLockMode);
}
/**
* The Object Lock mode that you want to apply to this object.
*/
public void setObjectLockMode(ObjectLockMode objectLockMode) {
setObjectLockMode(objectLockMode.toString());
}
/**
* The date and time when you want this object's Object Lock to expire.
*/
public Date getObjectLockRetainUntilDate() {
return objectLockRetainUntilDate;
}
/**
* The date and time when you want this object's Object Lock to expire.
*/
public T withObjectLockRetainUntilDate(Date objectLockRetainUntilDate) {
this.objectLockRetainUntilDate = objectLockRetainUntilDate;
return (T) this;
}
/**
* The date and time when you want this object's Object Lock to expire.
*/
public void setObjectLockRetainUntilDate(Date objectLockRetainUntilDate) {
withObjectLockRetainUntilDate(objectLockRetainUntilDate);
}
/**
* The Legal Hold status that you want to apply to the specified object.
*/
public String getObjectLockLegalHoldStatus() {
return objectLockLegalHoldStatus;
}
/**
* The Legal Hold status that you want to apply to the specified object.
*/
public T withObjectLockLegalHoldStatus(String objectLockLegalHoldStatus) {
this.objectLockLegalHoldStatus = objectLockLegalHoldStatus;
return (T) this;
}
/**
* The Legal Hold status that you want to apply to the specified object.
*/
public T withObjectLockLegalHoldStatus(ObjectLockLegalHoldStatus objectLockLegalHoldStatus) {
return withObjectLockLegalHoldStatus(objectLockLegalHoldStatus.toString());
}
/**
* The Legal Hold status that you want to apply to the specified object.
*/
public void setObjectLockLegalHoldStatus(String objectLockLegalHoldStatus) {
withObjectLockLegalHoldStatus(objectLockLegalHoldStatus);
}
/**
* The Legal Hold status that you want to apply to the specified object.
*/
public void setObjectLockLegalHoldStatus(ObjectLockLegalHoldStatus objectLockLegalHoldStatus) {
setObjectLockLegalHoldStatus(objectLockLegalHoldStatus.toString());
}
/**
* Sets the optional progress listener for receiving updates for object
* upload status.
*
* @param progressListener
* The legacy progress listener that is used exclusively for Amazon S3 client.
*
* @deprecated use {@link #setGeneralProgressListener(ProgressListener)} instead.
*/
@Deprecated
public void setProgressListener(com.ibm.cloud.objectstorage.services.s3.model.ProgressListener progressListener) {
setGeneralProgressListener(new LegacyS3ProgressListener(progressListener));
}
/**
* Returns the optional progress listener for receiving updates about object
* upload status.
*
* @return the optional progress listener for receiving updates about object
* upload status.
*
* @deprecated use {@link #getGeneralProgressListener()} instead.
*/
@Deprecated
public com.ibm.cloud.objectstorage.services.s3.model.ProgressListener getProgressListener() {
ProgressListener generalProgressListener = getGeneralProgressListener();
if (generalProgressListener instanceof LegacyS3ProgressListener) {
return ((LegacyS3ProgressListener)generalProgressListener).unwrap();
} else {
return null;
}
}
/**
* Sets the optional progress listener for receiving updates about object
* upload status, and returns this updated object so that additional method
* calls can be chained together.
*
* @param progressListener
* The legacy progress listener that is used exclusively for Amazon S3 client.
*
* @return This updated PutObjectRequest object.
*
* @deprecated use {@link #withGeneralProgressListener(ProgressListener)} instead.
*/
@Deprecated
public T withProgressListener(
com.ibm.cloud.objectstorage.services.s3.model.ProgressListener progressListener) {
setProgressListener(progressListener);
@SuppressWarnings("unchecked") T t = (T)this;
return t;
}
/**
* Returns the Amazon Web Services Key Management System parameters used to encrypt the
* object on server side.
*/
@Override
public SSEAwsKeyManagementParams getSSEAwsKeyManagementParams() {
return sseAwsKeyManagementParams;
}
/**
* Sets the Amazon Web Services Key Management System parameters used to encrypt the object
* on server side.
*/
public void setSSEAwsKeyManagementParams(SSEAwsKeyManagementParams params) {
if (params != null && this.sseCustomerKey != null) {
throw new IllegalArgumentException(
"Either SSECustomerKey or SSEAwsKeyManagementParams must not be set at the same time.");
}
this.sseAwsKeyManagementParams = params;
}
/**
* Sets the Amazon Web Services Key Management System parameters used to encrypt the object
* on server side.
*
* @return returns the update PutObjectRequest
*/
public T withSSEAwsKeyManagementParams(
SSEAwsKeyManagementParams sseAwsKeyManagementParams) {
setSSEAwsKeyManagementParams(sseAwsKeyManagementParams);
@SuppressWarnings("unchecked") T t = (T)this;
return t;
}
/**
* Returns whether or not bucket key encryption is used
*/
//IBM does not support SSE-KMS
// public Boolean getBucketKeyEnabled() {
// return bucketKeyEnabled;
// }
/**
* Specifies whether the client should use an S3 Bucket Key for object encryption with server-side encryption using Amazon Web Services KMS
* (SSE-KMS). Setting this header to true causes the client to use an S3 Bucket Key for object encryption with
* SSE-KMS.
*
* Specifying this header with a PUT operation doesn't affect bucket-level settings for S3 Bucket Key.
*/
//IBM does not support SSE-KMS
// public void setBucketKeyEnabled(Boolean bucketKeyEnabled) {
// this.bucketKeyEnabled = bucketKeyEnabled;
// }
/**
* Specifies whether the client should use an S3 Bucket Key for object encryption with server-side encryption using Amazon Web Services KMS
* (SSE-KMS). Setting this header to true causes the client to use an S3 Bucket Key for object encryption with
* SSE-KMS.
*
*
Specifying this header with a PUT operation doesn't affect bucket-level settings for S3 Bucket Key.
* @return returns the update PutObjectRequest
*/
//IBM does not support SSE-KMS
// public T withBucketKeyEnabled(Boolean bucketKeyEnabled) {
// setBucketKeyEnabled(bucketKeyEnabled);
// @SuppressWarnings("unchecked") T t = (T)this;
// return t;
// }
@Override
public AbstractPutObjectRequest clone() {
return (AbstractPutObjectRequest) super.clone();
}
protected final T copyPutObjectBaseTo(
T target) {
copyBaseTo(target);
final ObjectMetadata metadata = getMetadata();
return target.withAccessControlList(getAccessControlList())
.withCannedAcl(getCannedAcl())
.withInputStream(getInputStream())
.withMetadata(metadata == null ? null : metadata.clone())
.withRedirectLocation(getRedirectLocation())
.withStorageClass(getStorageClass())
.withSSEAwsKeyManagementParams(getSSEAwsKeyManagementParams())
.withSSECustomerKey(getSSECustomerKey())
;
}
public Date getRetentionExpirationDate() {
return retentionExpirationDate;
}
public void setRetentionExpirationDate(Date retentionExpirationDate) {
this.retentionExpirationDate = retentionExpirationDate;
}
public String getRetentionLegalHoldId() {
return retentionLegalHoldId;
}
public void setRetentionLegalHoldId(String retentionLegalHoldId) {
this.retentionLegalHoldId = retentionLegalHoldId;
}
public Long getRetentionPeriod() {
return retentionPeriod;
}
public void setRetentionPeriod(long retentionPeriod) {
this.retentionPeriod = retentionPeriod;
}
}