All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.amazonaws.services.s3.model.PutObjectRequest Maven / Gradle / Ivy

The newest version!
/*
 * Copyright 2010-2015 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.amazonaws.services.s3.model;

import java.io.File;
import java.io.InputStream;

import com.amazonaws.AmazonWebServiceRequest;
import com.amazonaws.event.ProgressListener;

/**
 * 

* Uploads a new object to the specified Amazon S3 bucket. * The PutObjectRequest optionally uploads object metadata * and applies a canned access * control policy to the new object. *

*

* Amazon S3 never stores partial objects; * if during this call an exception wasn't thrown, * the entire object was stored. *

*

* Depending on whether a file or input stream is being uploaded, this * request has slightly different behavior. *

*

* When uploading a file: *

*
    *
  • * The client automatically computes a checksum of the file. * Amazon S3 uses checksums to validate the data in each file. *
  • *
  • * Using the file extension, Amazon S3 attempts to determine * the correct content type and content disposition to use * for the object. *
  • *
*

* When uploading directly from an input stream, content length must be specified before data can be uploaded * to Amazon S3. If not provided, the library will have * to buffer the contents of the input stream in order to calculate it. * Amazon S3 explicitly requires that the content length be sent in * the request headers before any of the data is sent. *

* Amazon S3 is a distributed system. If * Amazon S3 receives multiple write requests for the same object nearly * simultaneously, all of the objects might be stored. However, only one object * will obtain the key. *

*

* Note: Amazon S3 does not provide object locking; if this is needed, make * sure to build it into the application layer. *

*

* If the caller specifies a location constraint when creating a bucket, * all objects added to the bucket are stored in the same region as the bucket. * For example, if specifying a Europe (EU) region constraint for a bucket, * all of that bucket's objects are stored in the EU region. *

*

* The specified bucket must already exist and the caller must have * {@link Permission#Write} permission to the bucket to upload an object. *

* * @see PutObjectRequest#PutObjectRequest(String, String, File) * @see PutObjectRequest#PutObjectRequest(String, String, InputStream, ObjectMetadata) */ public class PutObjectRequest extends AmazonWebServiceRequest implements Cloneable { /** * 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. */ 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 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 progress listener for receiving updates about object download * status. */ private ProgressListener generalProgressListener; /** 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; /** * Constructs a new * {@link PutObjectRequest} 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. * * @param bucketName * The name of an existing bucket to which the new object will be * uploaded. * @param key * The key under which to store the new object. * @param file * The path of the file to upload to Amazon S3. * * @see PutObjectRequest#PutObjectRequest(String, String, InputStream, ObjectMetadata) * @See PutObjectRequest(String bucketName, String key, String redirectLocation) */ public PutObjectRequest(String bucketName, String key, File file) { this.bucketName = bucketName; this.key = key; this.file = file; } /** * Constructs a new {@link PutObjectRequest} object with redirect location. * After constructing the request, users may optionally specify object * metadata or a canned ACL as well. * * @param bucketName * The name of an existing bucket to which the new object will be * uploaded. * @param key * The key under which to store the new object. * @param redirectLocation * The redirect location of this new object. * * @see PutObjectRequest#PutObjectRequest(String, String, InputStream, ObjectMetadata) * @see PutObjectRequest#PutObjectRequest(String, String, File) */ public PutObjectRequest(String bucketName, String key, String redirectLocation) { this.bucketName = bucketName; this.key = key; this.redirectLocation = redirectLocation; } /** * Constructs a new * {@link PutObjectRequest} 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. *

* * @param bucketName * The name of an existing bucket to which the new object will be * uploaded. * @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. * * @see PutObjectRequest#PutObjectRequest(String, String, File) * @see PutObjectRequest(String bucketName, String key, String redirectLocation) */ public PutObjectRequest(String bucketName, String key, InputStream input, ObjectMetadata metadata) { this.bucketName = bucketName; this.key = key; this.inputStream = input; this.metadata = metadata; } /** * Gets the name of the existing bucket where this request will * upload a new object to. * In order to upload the object, * users must have {@link Permission#Write} permission granted. * * @return The name of an existing bucket where this request will * upload a new object to. * * @see PutObjectRequest#setBucketName(String) * @see PutObjectRequest#withBucketName(String) */ public String getBucketName() { return bucketName; } /** * Sets the name of an existing bucket where this request will * upload a new object to. In order to upload the object, * users must have {@link Permission#Write} permission granted. * * @param bucketName * The name of an existing bucket where this request will * upload a new object to. * In order to upload the object, * users must have {@link Permission#Write} permission granted. * * @see PutObjectRequest#getBucketName() * @see PutObjectRequest#withBucketName(String) */ public void setBucketName(String bucketName) { this.bucketName = bucketName; } /** * Sets the name of the bucket where this request will upload a new * object to. Returns this object, enabling additional method calls to be * chained together. *

* In order to upload the object, * users must have {@link Permission#Write} permission granted. * * @param bucketName * The name of an existing bucket where this request will * upload a new object to. * In order to upload the object, * users must have {@link Permission#Write} permission granted. * * @return This {@link PutObjectRequest}, enabling additional method calls to be * chained together. * * @see PutObjectRequest#getBucketName() * @see PutObjectRequest#setBucketName(String) */ public PutObjectRequest withBucketName(String bucketName) { setBucketName(bucketName); return this; } /** * Gets the key under which to store the new object. * * @return The key under which to store the new object. * * @see PutObjectRequest#setKey(String) * @see PutObjectRequest#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 PutObjectRequest#getKey() * @see PutObjectRequest#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 PutObjectRequest}, enabling additional method calls to be * chained together. * * @see PutObjectRequest#getKey() * @see PutObjectRequest#setKey(String) */ public PutObjectRequest withKey(String key) { setKey(key); return this; } /** * 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 PutObjectRequest#setStorageClass(String) * @see PutObjectRequest#setStorageClass(StorageClass) * @see PutObjectRequest#withStorageClass(StorageClass) * @see PutObjectRequest#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. * * @return The Amazon S3 storage class to use when storing the newly copied * object. * * @see PutObjectRequest#getStorageClass() * @see PutObjectRequest#setStorageClass(StorageClass * @see PutObjectRequest#withStorageClass(StorageClass) * @see PutObjectRequest#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 PutObjectRequest}, 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 PutObjectRequest}, enabling additional method calls to be * chained together. * * @see PutObjectRequest#getStorageClass() * @see PutObjectRequest#setStorageClass(StorageClass) * @see PutObjectRequest#setStorageClass(String) * @see PutObjectRequest#withStorageClass(StorageClass) */ public PutObjectRequest withStorageClass(String storageClass) { setStorageClass(storageClass); return this; } /** * 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. * * @return The Amazon S3 storage class to use when storing the newly copied * object. * * @see PutObjectRequest#getStorageClass() * @see PutObjectRequest#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 PutObjectRequest}, 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 PutObjectRequest}, enabling additional method calls to be * chained together. * * @see PutObjectRequest#getStorageClass() * @see PutObjectRequest#setStorageClass(StorageClass) * @see PutObjectRequest#setStorageClass(String) * @see PutObjectRequest#withStorageClass(String) */ public PutObjectRequest withStorageClass(StorageClass storageClass) { setStorageClass(storageClass); return this; } /** * 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 PutObjectRequest#setFile(File) * @see PutObjectRequest#withFile(File) * @see PutObjectRequest#setInputStream(InputStream) * @see PutObjectRequest#withInputStream(InputStream) */ 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 PutObjectRequest#getFile() * @see PutObjectRequest#withFile(File) * @see PutObjectRequest#getInputStream() * @see PutObjectRequest#withInputStream(InputStream) */ public void setFile(File file) { this.file = file; } /** * Sets the file containing the data to be uploaded to Amazon S3. * Returns this {@link PutObjectRequest}, 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 PutObjectRequest}, enabling additional method * calls to be chained together. * * @see PutObjectRequest#getFile() * @see PutObjectRequest#setFile(File) * @see PutObjectRequest#getInputStream() * @see PutObjectRequest#setInputStream(InputStream) */ public PutObjectRequest withFile(File file) { setFile(file); return this; } /** * 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 PutObjectRequest#setMetadata(ObjectMetadata) * @see PutObjectRequest#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 PutObjectRequest#getMetadata() * @see PutObjectRequest#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 PutObjectRequest}, 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 PutObjectRequest}, enabling additional method * calls to be chained together. * * @see PutObjectRequest#getMetadata() * @see PutObjectRequest#setMetadata(ObjectMetadata) */ public PutObjectRequest withMetadata(ObjectMetadata metadata) { setMetadata(metadata); return this; } /** * 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 PutObjectRequest#setCannedAcl(CannedAccessControlList) * @see PutObjectRequest#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 PutObjectRequest#getCannedAcl() * @see PutObjectRequest#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 PutObjectRequest}, 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 PutObjectRequest}, enabling additional method * calls to be chained together. * * @see PutObjectRequest#getCannedAcl() * @see PutObjectRequest#setCannedAcl(CannedAccessControlList) */ public PutObjectRequest withCannedAcl(CannedAccessControlList cannedAcl) { setCannedAcl(cannedAcl); return this; } /** * 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 PutObjectRequest}, * enabling additional method calls to be chained together. * * @param accessControlList * The access control list for the new object. */ public PutObjectRequest withAccessControlList(AccessControlList accessControlList) { setAccessControlList(accessControlList); return this; } /** * 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 PutObjectRequest#setInputStream(InputStream) * @see PutObjectRequest#withInputStream(InputStream) * @see PutObjectRequest#setFile(File) * @see PutObjectRequest#withFile(File) */ 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 PutObjectRequest#getInputStream() * @see PutObjectRequest#withInputStream(InputStream) * @see PutObjectRequest#getFile() * @see PutObjectRequest#withFile(File) */ public void setInputStream(InputStream inputStream) { this.inputStream = inputStream; } /** * Sets the input stream containing the data to be uploaded to Amazon S3. * Returns this {@link PutObjectRequest}, 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 PutObjectRequest#getInputStream() * @see PutObjectRequest#setInputStream(InputStream) * @see PutObjectRequest#getFile() * @see PutObjectRequest#setFile(File) */ public PutObjectRequest withInputStream(InputStream inputStream) { setInputStream(inputStream); return this; } /** * 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 PutObjectRequest}, enabling additional method calls to be chained * together. * @param redirectLocation * The redirect location for the new object. */ public PutObjectRequest withRedirectLocation(String redirectLocation) { this.redirectLocation = redirectLocation; return this; } /** * Returns the optional customer-provided server-side encryption key to use * to encrypt the uploaded object. * * @return The optional customer-provided server-side encryption key to use * to encrypt the uploaded object. */ 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) { 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 PutObjectRequest withSSECustomerKey(SSECustomerKey sseKey) { setSSECustomerKey(sseKey); return this; } /** * 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.amazonaws.services.s3.model.ProgressListener progressListener) { this.generalProgressListener = 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.amazonaws.services.s3.model.ProgressListener getProgressListener() { 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 PutObjectRequest withProgressListener(com.amazonaws.services.s3.model.ProgressListener progressListener) { setProgressListener(progressListener); return this; } /** * Sets the optional progress listener for receiving updates about object * upload status. * * @param generalProgressListener * The new progress listener. */ public void setGeneralProgressListener(ProgressListener generalProgressListener) { this.generalProgressListener = generalProgressListener; } /** * Returns the optional progress listener for receiving updates about object * upload status. * * @return the optional progress listener for receiving updates about object * upload status. */ public ProgressListener getGeneralProgressListener() { return generalProgressListener; } /** * 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 generalProgressListener * The new progress listener. * * @return This updated PutObjectRequest object. */ public PutObjectRequest withGeneralProgressListener(ProgressListener generalProgressListener) { setGeneralProgressListener(generalProgressListener); return this; } /** * Returns a clone of this object so that the metadata can be further * modified without affecting the original. */ public PutObjectRequest clone() { return new PutObjectRequest(bucketName, key, redirectLocation). withAccessControlList(accessControlList) .withCannedAcl(cannedAcl) .withFile(file) .withGeneralProgressListener(generalProgressListener) .withInputStream(inputStream) .withMetadata(metadata == null ? null : metadata.clone()) .withStorageClass(storageClass) .withRequestMetricCollector(getRequestMetricCollector()) ; } }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy