/*
* Copyright 2010 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;
import java.io.BufferedOutputStream;
import java.io.ByteArrayInputStream;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.net.URI;
import java.net.URISyntaxException;
import java.net.URL;
import java.security.NoSuchAlgorithmException;
import java.security.SignatureException;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Date;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import com.amazonaws.AmazonClientException;
import com.amazonaws.AmazonServiceException;
import com.amazonaws.AmazonServiceException.ErrorType;
import com.amazonaws.AmazonWebServiceClient;
import com.amazonaws.AmazonWebServiceRequest;
import com.amazonaws.ClientConfiguration;
import com.amazonaws.DefaultRequest;
import com.amazonaws.HttpMethod;
import com.amazonaws.Request;
import com.amazonaws.auth.AWSCredentials;
import com.amazonaws.handlers.HandlerChainFactory;
import com.amazonaws.handlers.RequestHandler;
import com.amazonaws.http.HttpClient;
import com.amazonaws.http.HttpMethodName;
import com.amazonaws.http.HttpRequest;
import com.amazonaws.services.s3.internal.BucketNameUtils;
import com.amazonaws.services.s3.internal.Constants;
import com.amazonaws.services.s3.internal.CopyObjectResponseHandler;
import com.amazonaws.services.s3.internal.InputSubstream;
import com.amazonaws.services.s3.internal.MD5DigestCalculatingInputStream;
import com.amazonaws.services.s3.internal.Mimetypes;
import com.amazonaws.services.s3.internal.ProgressReportingInputStream;
import com.amazonaws.services.s3.internal.RepeatableFileInputStream;
import com.amazonaws.services.s3.internal.RepeatableInputStream;
import com.amazonaws.services.s3.internal.S3ErrorResponseHandler;
import com.amazonaws.services.s3.internal.S3MetadataResponseHandler;
import com.amazonaws.services.s3.internal.S3ObjectResponseHandler;
import com.amazonaws.services.s3.internal.S3QueryStringSigner;
import com.amazonaws.services.s3.internal.S3Signer;
import com.amazonaws.services.s3.internal.S3StringResponseHandler;
import com.amazonaws.services.s3.internal.S3XmlResponseHandler;
import com.amazonaws.services.s3.internal.ServiceUtils;
import com.amazonaws.services.s3.internal.XmlWriter;
import com.amazonaws.services.s3.model.AbortMultipartUploadRequest;
import com.amazonaws.services.s3.model.AccessControlList;
import com.amazonaws.services.s3.model.AmazonS3Exception;
import com.amazonaws.services.s3.model.Bucket;
import com.amazonaws.services.s3.model.BucketLoggingConfiguration;
import com.amazonaws.services.s3.model.BucketNotificationConfiguration;
import com.amazonaws.services.s3.model.BucketPolicy;
import com.amazonaws.services.s3.model.BucketVersioningConfiguration;
import com.amazonaws.services.s3.model.CannedAccessControlList;
import com.amazonaws.services.s3.model.CompleteMultipartUploadRequest;
import com.amazonaws.services.s3.model.CompleteMultipartUploadResult;
import com.amazonaws.services.s3.model.CopyObjectRequest;
import com.amazonaws.services.s3.model.CopyObjectResult;
import com.amazonaws.services.s3.model.CreateBucketRequest;
import com.amazonaws.services.s3.model.DeleteBucketRequest;
import com.amazonaws.services.s3.model.DeleteObjectRequest;
import com.amazonaws.services.s3.model.DeleteVersionRequest;
import com.amazonaws.services.s3.model.GeneratePresignedUrlRequest;
import com.amazonaws.services.s3.model.GetObjectMetadataRequest;
import com.amazonaws.services.s3.model.GetObjectRequest;
import com.amazonaws.services.s3.model.GroupGrantee;
import com.amazonaws.services.s3.model.InitiateMultipartUploadRequest;
import com.amazonaws.services.s3.model.InitiateMultipartUploadResult;
import com.amazonaws.services.s3.model.ListBucketsRequest;
import com.amazonaws.services.s3.model.ListMultipartUploadsRequest;
import com.amazonaws.services.s3.model.ListObjectsRequest;
import com.amazonaws.services.s3.model.ListPartsRequest;
import com.amazonaws.services.s3.model.ListVersionsRequest;
import com.amazonaws.services.s3.model.MultiFactorAuthentication;
import com.amazonaws.services.s3.model.MultipartUploadListing;
import com.amazonaws.services.s3.model.ObjectListing;
import com.amazonaws.services.s3.model.ObjectMetadata;
import com.amazonaws.services.s3.model.Owner;
import com.amazonaws.services.s3.model.PartListing;
import com.amazonaws.services.s3.model.Permission;
import com.amazonaws.services.s3.model.ProgressEvent;
import com.amazonaws.services.s3.model.ProgressListener;
import com.amazonaws.services.s3.model.PutObjectRequest;
import com.amazonaws.services.s3.model.PutObjectResult;
import com.amazonaws.services.s3.model.Region;
import com.amazonaws.services.s3.model.S3Object;
import com.amazonaws.services.s3.model.SetBucketLoggingConfigurationRequest;
import com.amazonaws.services.s3.model.SetBucketVersioningConfigurationRequest;
import com.amazonaws.services.s3.model.StorageClass;
import com.amazonaws.services.s3.model.UploadPartRequest;
import com.amazonaws.services.s3.model.UploadPartResult;
import com.amazonaws.services.s3.model.VersionListing;
import com.amazonaws.services.s3.model.transform.AclXmlFactory;
import com.amazonaws.services.s3.model.transform.BucketConfigurationXmlFactory;
import com.amazonaws.services.s3.model.transform.RequestXmlFactory;
import com.amazonaws.services.s3.model.transform.Unmarshallers;
import com.amazonaws.services.s3.model.transform.XmlResponsesSaxParser.CompleteMultipartUploadHandler;
import com.amazonaws.services.s3.model.transform.XmlResponsesSaxParser.CopyObjectResultHandler;
/**
* <p>
* Provides the client for accessing the Amazon S3 web service.
* </p>
* <p>
* Amazon S3 provides storage for the Internet,
* and is designed to make web-scale computing easier for developers.
* </p>
* <p>
* The Amazon S3 Java SDK provides a simple interface that can be
* used to store and retrieve any amount of data, at any time,
* from anywhere on the web. It gives any developer access to the same
* highly scalable, reliable, secure, fast, inexpensive infrastructure
* that Amazon uses to run its own global network of web sites.
* The service aims to maximize benefits of scale and to pass those
* benefits on to developers.
* </p>
* <p>
* For more information about Amazon S3, please see
* <a href="http://aws.amazon.com/s3">
* http://aws.amazon.com/s3</a>
* </p>
*/
public class AmazonS3Client extends AmazonWebServiceClient implements AmazonS3 {
/** Shared logger for client events */
private static Log log = LogFactory.getLog(AmazonS3Client.class);
/**
* The AWS credentials (access key ID and secret key) to use when
* authenticating with AWS services.
*/
private AWSCredentials awsCredentials;
/**
* Low level client for sending requests to AWS services.
*/
protected final HttpClient client;
/**
* Optional request handlers for additional request processing.
*/
private List<RequestHandler> requestHandlers = new ArrayList<RequestHandler>();
/**
* Responsible for handling error responses from all S3 service calls.
*/
private S3ErrorResponseHandler errorResponseHandler =
new S3ErrorResponseHandler();
/**
* Shared response handler for operations that don't need to unmarshall
* anything.
*/
private S3XmlResponseHandler<Void> voidResponseHandler =
new S3XmlResponseHandler<Void>(null);
/** Utilities for validating bucket names */
private final BucketNameUtils bucketNameUtils = new BucketNameUtils();
/** Shared factory for converting configuration objects to XML */
private static final BucketConfigurationXmlFactory bucketConfigurationXmlFactory = new BucketConfigurationXmlFactory();
/**
* <p>
* Constructs a new Amazon S3 client that will make <b>anonymous</b>
* requests to Amazon S3.
* </p>
* <p>
* Only a subset of the Amazon S3 API will work with anonymous
* (i.e. unsigned) requests, but this can prove useful in some situations.
* For example:
* <ul>
* <li>If an Amazon S3 bucket has {@link Permission#Read} permission for the
* {@link GroupGrantee#AllUsers} group, anonymous clients can call
* {@link #listObjects(String)} to see what objects are stored in a bucket.</li>
* <li>If an object has {@link Permission#Read} permission for the
* {@link GroupGrantee#AllUsers} group, anonymous clients can call
* {@link #getObject(String, String)} and
* {@link #getObjectMetadata(String, String)} to pull object content and
* metadata.</li>
* <li>If a bucket has {@link Permission#Write} permission for the
* {@link GroupGrantee#AllUsers} group, anonymous clients can upload objects
* to the bucket.</li>
* </ul>
* </p>
*
* @see AmazonS3Client#AmazonS3Client(AWSCredentials)
* @see AmazonS3Client#AmazonS3Client(AWSCredentials, ClientConfiguration)
*/
public AmazonS3Client() {
this(null);
}
/**
* <p>
* Constructs a new Amazon S3 client using the specified AWS credentials to
* access Amazon S3.
* </p>
*
* @param awsCredentials
* The AWS credentials to use when making requests to Amazon S3
* with this client.
*
* @see AmazonS3Client#AmazonS3Client()
* @see AmazonS3Client#AmazonS3Client(AWSCredentials, ClientConfiguration)
*/
public AmazonS3Client(AWSCredentials awsCredentials) {
this(awsCredentials, new ClientConfiguration());
}
/**
* <p>
* Constructs a new Amazon S3 client using the specified AWS credentials and
* client configuration to access Amazon S3.
* </p>
*
* @param awsCredentials
* The AWS credentials to use when making requests to Amazon S3
* with this client.
* @param clientConfiguration
* The client configuration options controlling how this client
* connects to Amazon S3 (e.g. proxy settings, retry counts, etc).
*
* @see AmazonS3Client#AmazonS3Client()
* @see AmazonS3Client#AmazonS3Client(AWSCredentials)
*/
public AmazonS3Client(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration) {
super(clientConfiguration);
this.awsCredentials = awsCredentials;
setEndpoint(Constants.S3_HOSTNAME);
client = new HttpClient(clientConfiguration);
requestHandlers = new HandlerChainFactory().newRequestHandlerChain(
"/com/amazonaws/services/s3/request.handlers");
}
/* (non-Javadoc)
* @see com.amazonaws.services.s3.AmazonS3#listNextBatchOfVersions(com.amazonaws.services.s3.model.S3VersionListing)
*/
public VersionListing listNextBatchOfVersions(VersionListing previousVersionListing)
throws AmazonClientException, AmazonServiceException {
assertParameterNotNull(previousVersionListing,
"The previous version listing parameter must be specified when listing the next batch of versions in a bucket");
if (!previousVersionListing.isTruncated()) {
VersionListing emptyListing = new VersionListing();
emptyListing.setBucketName(previousVersionListing.getBucketName());
emptyListing.setDelimiter(previousVersionListing.getDelimiter());
emptyListing.setKeyMarker(previousVersionListing.getNextKeyMarker());
emptyListing.setVersionIdMarker(previousVersionListing.getNextVersionIdMarker());
emptyListing.setMaxKeys(previousVersionListing.getMaxKeys());
emptyListing.setPrefix(previousVersionListing.getPrefix());
emptyListing.setTruncated(false);
return emptyListing;
}
return listVersions(new ListVersionsRequest(
previousVersionListing.getBucketName(),
previousVersionListing.getPrefix(),
previousVersionListing.getNextKeyMarker(),
previousVersionListing.getNextVersionIdMarker(),
previousVersionListing.getDelimiter(),
new Integer( previousVersionListing.getMaxKeys() ) ));
}
/* (non-Javadoc)
* @see com.amazonaws.services.s3.AmazonS3#listVersions(java.lang.String, java.lang.String)
*/
public VersionListing listVersions(String bucketName, String prefix)
throws AmazonClientException, AmazonServiceException {
return listVersions(new ListVersionsRequest(bucketName, prefix, null, null, null, null));
}
/* (non-Javadoc)
* @see com.amazonaws.services.s3.AmazonS3#listVersions(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.Integer)
*/
public VersionListing listVersions(String bucketName, String prefix, String keyMarker, String versionIdMarker, String delimiter, Integer maxKeys)
throws AmazonClientException, AmazonServiceException {
ListVersionsRequest request = new ListVersionsRequest()
.withBucketName(bucketName)
.withPrefix(prefix)
.withDelimiter(delimiter)
.withKeyMarker(keyMarker)
.withVersionIdMarker(versionIdMarker)
.withMaxResults(maxKeys);
return listVersions(request);
}
/* (non-Javadoc)
* @see com.amazonaws.services.s3.AmazonS3#listVersions(com.amazonaws.services.s3.model.ListVersionsRequest)
*/
public VersionListing listVersions(ListVersionsRequest listVersionsRequest)
throws AmazonClientException, AmazonServiceException {
String bucketName = listVersionsRequest.getBucketName();
String prefix = listVersionsRequest.getPrefix();
String keyMarker = listVersionsRequest.getKeyMarker();
String versionIdMarker = listVersionsRequest.getVersionIdMarker();
String delimiter = listVersionsRequest.getDelimiter();
Integer maxResults = listVersionsRequest.getMaxResults();
assertParameterNotNull(bucketName, "The bucket name parameter must be specified when listing versions in a bucket");
Request<Void> request = createRequest(bucketName, null, listVersionsRequest);
request.addParameter("versions", null);
if (prefix != null) request.addParameter("prefix", prefix);
if (keyMarker != null) request.addParameter("key-marker", keyMarker);
if (versionIdMarker != null) request.addParameter("version-id-marker", versionIdMarker);
if (delimiter != null) request.addParameter("delimiter", delimiter);
if (maxResults != null && maxResults.intValue() >= 0) request.addParameter("max-keys", maxResults.toString());
signRequest(request, HttpMethodName.GET, bucketName, null);
HttpRequest httpRequest = convertToHttpRequest(request, HttpMethodName.GET);
S3XmlResponseHandler<VersionListing> responseHandler =
new S3XmlResponseHandler<VersionListing>(new Unmarshallers.VersionListUnmarshaller());
return (VersionListing)client.execute(httpRequest, responseHandler, errorResponseHandler);
}
/* (non-Javadoc)
* @see com.amazonaws.services.s3.AmazonS3#listObjects(java.lang.String)
*/
public ObjectListing listObjects(String bucketName)
throws AmazonClientException, AmazonServiceException {
return listObjects(new ListObjectsRequest(bucketName, null, null, null, null));
}
/* (non-Javadoc)
* @see com.amazonaws.services.s3.AmazonS3#listObjects(java.lang.String, java.lang.String)
*/
public ObjectListing listObjects(String bucketName, String prefix)
throws AmazonClientException, AmazonServiceException {
return listObjects(new ListObjectsRequest(bucketName, prefix, null, null, null));
}
/* (non-Javadoc)
* @see com.amazonaws.services.s3.AmazonS3#listObjects(com.amazonaws.services.s3.model.ListObjectsRequest)
*/
public ObjectListing listObjects(ListObjectsRequest listObjectsRequest)
throws AmazonClientException, AmazonServiceException {
String bucketName = listObjectsRequest.getBucketName();
String prefix = listObjectsRequest.getPrefix();
String marker = listObjectsRequest.getMarker();
String delimiter = listObjectsRequest.getDelimiter();
Integer maxKeys = listObjectsRequest.getMaxKeys();
assertParameterNotNull(bucketName, "The bucket name parameter must be specified when listing objects in a bucket");
Request<Void> request = createRequest(bucketName, null, listObjectsRequest);
if (prefix != null) request.addParameter("prefix", prefix);
if (marker != null) request.addParameter("marker", marker);
if (delimiter != null) request.addParameter("delimiter", delimiter);
if (maxKeys != null && maxKeys.intValue() > 0) request.addParameter("max-keys", maxKeys.toString());
signRequest(request, HttpMethodName.GET, bucketName, null);
HttpRequest httpRequest = convertToHttpRequest(request, HttpMethodName.GET);
S3XmlResponseHandler<ObjectListing> responseHandler =
new S3XmlResponseHandler<ObjectListing>(new Unmarshallers.ListObjectsUnmarshaller());
return (ObjectListing)client.execute(httpRequest, responseHandler, errorResponseHandler);
}
/* (non-Javadoc)
* @see com.amazonaws.services.s3.AmazonS3#listNextBatchOfObjects(com.amazonaws.services.s3.model.S3ObjectListing)
*/
public ObjectListing listNextBatchOfObjects(ObjectListing previousObjectListing)
throws AmazonClientException, AmazonServiceException {
assertParameterNotNull(previousObjectListing,
"The previous object listing parameter must be specified when listing the next batch of objects in a bucket");
if (!previousObjectListing.isTruncated()) {
ObjectListing emptyListing = new ObjectListing();
emptyListing.setBucketName(previousObjectListing.getBucketName());
emptyListing.setDelimiter(previousObjectListing.getDelimiter());
emptyListing.setMarker(previousObjectListing.getNextMarker());
emptyListing.setMaxKeys(previousObjectListing.getMaxKeys());
emptyListing.setPrefix(previousObjectListing.getPrefix());
emptyListing.setTruncated(false);
return emptyListing;
}
return listObjects(new ListObjectsRequest(
previousObjectListing.getBucketName(),
previousObjectListing.getPrefix(),
previousObjectListing.getNextMarker(),
previousObjectListing.getDelimiter(),
new Integer( previousObjectListing.getMaxKeys() ) ));
}
/* (non-Javadoc)
* @see com.amazonaws.services.s3.AmazonS3#getS3AccountOwner()
*/
public Owner getS3AccountOwner()
throws AmazonClientException, AmazonServiceException {
Request<Void> request = createRequest(null, null, null);
signRequest(request, HttpMethodName.GET, null, null);
HttpRequest httpRequest = convertToHttpRequest(request, HttpMethodName.GET);
S3XmlResponseHandler<Owner> responseHandler =
new S3XmlResponseHandler<Owner>(new Unmarshallers.ListBucketsOwnerUnmarshaller());
return (Owner)client.execute(httpRequest, responseHandler, errorResponseHandler);
}
/* (non-Javadoc)
* @see com.amazonaws.services.s3.AmazonS3#listBuckets()
*/
public List<Bucket> listBuckets(ListBucketsRequest listBucketsRequest)
throws AmazonClientException, AmazonServiceException {
Request<Void> request = createRequest(null, null, listBucketsRequest);
signRequest(request, HttpMethodName.GET, null, null);
HttpRequest httpRequest = convertToHttpRequest(request, HttpMethodName.GET);
S3XmlResponseHandler<List<Bucket>> responseHandler =
new S3XmlResponseHandler<List<Bucket>>(new Unmarshallers.ListBucketsUnmarshaller());
return (List<Bucket>)client.execute(httpRequest, responseHandler, errorResponseHandler);
}
/* (non-Javadoc)
* @see com.amazonaws.services.s3.AmazonS3#listBuckets()
*/
public List<Bucket> listBuckets()
throws AmazonClientException, AmazonServiceException {
return listBuckets(new ListBucketsRequest());
}
/* (non-Javadoc)
* @see com.amazonaws.services.s3.AmazonS3#getBucketLocation(java.lang.String)
*/
public String getBucketLocation(String bucketName)
throws AmazonClientException, AmazonServiceException {
assertParameterNotNull(bucketName, "The bucket name parameter must be specified when requesting a bucket's location");
Request<Void> request = createRequest(bucketName, null, null);
request.addParameter("location", null);
signRequest(request, HttpMethodName.GET, bucketName, null);
HttpRequest httpRequest = convertToHttpRequest(request, HttpMethodName.GET);
S3XmlResponseHandler<String> responseHandler =
new S3XmlResponseHandler<String>(new Unmarshallers.BucketLocationUnmarshaller());
return (String)client.execute(httpRequest, responseHandler, errorResponseHandler);
}
/* (non-Javadoc)
* @see com.amazonaws.services.s3.AmazonS3#createBucket(java.lang.String)
*/
public Bucket createBucket(String bucketName)
throws AmazonClientException, AmazonServiceException {
return createBucket(new CreateBucketRequest(bucketName));
}
/* (non-Javadoc)
* @see com.amazonaws.services.s3.AmazonS3#createBucket(java.lang.String, com.amazonaws.services.s3.model.Region)
*/
public Bucket createBucket(String bucketName, Region region)
throws AmazonClientException, AmazonServiceException {
return createBucket(new CreateBucketRequest(bucketName, region));
}
/* (non-Javadoc)
* @see com.amazonaws.services.s3.AmazonS3#createBucket(java.lang.String, java.lang.String)
*/
public Bucket createBucket(String bucketName, String region)
throws AmazonClientException, AmazonServiceException {
return createBucket(new CreateBucketRequest(bucketName, region));
}
/* (non-Javadoc)
* @see com.amazonaws.services.s3.AmazonS3#createBucket(com.amazonaws.services.s3.model.CreateBucketRequest)
*/
public Bucket createBucket(CreateBucketRequest createBucketRequest)
throws AmazonClientException, AmazonServiceException {
assertParameterNotNull(createBucketRequest,
"The CreateBucketRequest parameter must be specified when creating a bucket");
String bucketName = createBucketRequest.getBucketName();
String region = createBucketRequest.getRegion();
assertParameterNotNull(bucketName,
"The bucket name parameter must be specified when creating a bucket");
if (bucketName != null) bucketName = bucketName.trim();
bucketNameUtils.validateBucketName(bucketName);
Request<Void> request = createRequest(bucketName, null, createBucketRequest);
signRequest(request, HttpMethodName.PUT, bucketName, null);
HttpRequest httpRequest = convertToHttpRequest(request, HttpMethodName.PUT);
/*
* We can only send the CreateBucketConfiguration if we're *not*
* creating a bucket in the US region.
*/
if (region != null && !region.toUpperCase().equals(Region.US_Standard.toString())) {
XmlWriter xml = new XmlWriter();
xml.start("CreateBucketConfiguration", "xmlns", Constants.XML_NAMESPACE);
xml.start("LocationConstraint").value(region).end();
xml.end();
httpRequest.setContent(new ByteArrayInputStream(xml.getBytes()));
}
client.execute(httpRequest, voidResponseHandler, errorResponseHandler);
return new Bucket(bucketName);
}
/* (non-Javadoc)
* @see com.amazonaws.services.s3.AmazonS3#getObjectAcl(java.lang.String, java.lang.String)
*/
public AccessControlList getObjectAcl(String bucketName, String key)
throws AmazonClientException, AmazonServiceException {
return getObjectAcl(bucketName, key, null);
}
/* (non-Javadoc)
* @see com.amazonaws.services.s3.AmazonS3#getObjectAcl(java.lang.String, java.lang.String, java.lang.String)
*/
public AccessControlList getObjectAcl(String bucketName, String key, String versionId)
throws AmazonClientException, AmazonServiceException {
assertParameterNotNull(bucketName, "The bucket name parameter must be specified when requesting an object's ACL");
assertParameterNotNull(key, "The key parameter must be specified when requesting an object's ACL");
return getAcl(bucketName, key, versionId);
}
/* (non-Javadoc)
* @see com.amazonaws.services.s3.AmazonS3#setObjectAcl(java.lang.String, java.lang.String, com.amazonaws.services.s3.model.AccessControlList)
*/
public void setObjectAcl(String bucketName, String key, AccessControlList acl)
throws AmazonClientException, AmazonServiceException {
setObjectAcl(bucketName, key, null, acl);
}
/* (non-Javadoc)
* @see com.amazonaws.services.s3.AmazonS3#setObjectAcl(java.lang.String, java.lang.String, com.amazonaws.services.s3.model.CannedAccessControlList)
*/
public void setObjectAcl(String bucketName, String key, CannedAccessControlList acl)
throws AmazonClientException, AmazonServiceException {
setObjectAcl(bucketName, key, null, acl);
}
/* (non-Javadoc)
* @see com.amazonaws.services.s3.AmazonS3#setObjectAcl(java.lang.String, java.lang.String, java.lang.String, com.amazonaws.services.s3.model.AccessControlList)
*/
public void setObjectAcl(String bucketName, String key, String versionId, AccessControlList acl)
throws AmazonClientException, AmazonServiceException {
assertParameterNotNull(bucketName, "The bucket name parameter must be specified when setting an object's ACL");
assertParameterNotNull(key, "The key parameter must be specified when setting an object's ACL");
assertParameterNotNull(acl, "The ACL parameter must be specified when setting an object's ACL");
setAcl(bucketName, key, versionId, acl);
}
/* (non-Javadoc)
* @see com.amazonaws.services.s3.AmazonS3#setObjectAcl(java.lang.String, java.lang.String, java.lang.String, com.amazonaws.services.s3.model.CannedAccessControlList)
*/
public void setObjectAcl(String bucketName, String key, String versionId, CannedAccessControlList acl)
throws AmazonClientException, AmazonServiceException {
assertParameterNotNull(bucketName, "The bucket name parameter must be specified when setting an object's ACL");
assertParameterNotNull(key, "The key parameter must be specified when setting an object's ACL");
assertParameterNotNull(acl, "The ACL parameter must be specified when setting an object's ACL");
setAcl(bucketName, key, versionId, acl);
}
/* (non-Javadoc)
* @see com.amazonaws.services.s3.AmazonS3#getBucketAcl(java.lang.String)
*/
public AccessControlList getBucketAcl(String bucketName)
throws AmazonClientException, AmazonServiceException {
assertParameterNotNull(bucketName, "The bucket name parameter must be specified when requesting a bucket's ACL");
return getAcl(bucketName, null, null);
}
/* (non-Javadoc)
* @see com.amazonaws.services.s3.AmazonS3#setBucketAcl(java.lang.String, com.amazonaws.services.s3.model.AccessControlList)
*/
public void setBucketAcl(String bucketName, AccessControlList acl)
throws AmazonClientException, AmazonServiceException {
assertParameterNotNull(bucketName, "The bucket name parameter must be specified when setting a bucket's ACL");
assertParameterNotNull(acl, "The ACL parameter must be specified when setting a bucket's ACL");
setAcl(bucketName, null, null, acl);
}
/* (non-Javadoc)
* @see com.amazonaws.services.s3.AmazonS3#setBucketAcl(java.lang.String, com.amazonaws.services.s3.model.CannedAccessControlList)
*/
public void setBucketAcl(String bucketName, CannedAccessControlList acl)
throws AmazonClientException, AmazonServiceException {
assertParameterNotNull(bucketName, "The bucket name parameter must be specified when setting a bucket's ACL");
assertParameterNotNull(acl, "The ACL parameter must be specified when setting a bucket's ACL");
setAcl(bucketName, null, null, acl);
}
/* (non-Javadoc)
* @see com.amazonaws.services.s3.AmazonS3#getObjectMetadata(java.lang.String, java.lang.String)
*/
public ObjectMetadata getObjectMetadata(String bucketName, String key)
throws AmazonClientException, AmazonServiceException {
return getObjectMetadata(new GetObjectMetadataRequest(bucketName, key));
}
/* (non-Javadoc)
* @see com.amazonaws.services.s3.AmazonS3#getObjectMetadata(com.amazonaws.services.s3.model.GetObjectMetadataRequest)
*/
public ObjectMetadata getObjectMetadata(GetObjectMetadataRequest getObjectMetadataRequest)
throws AmazonClientException, AmazonServiceException {
assertParameterNotNull(getObjectMetadataRequest, "The GetObjectMetadataRequest parameter must be specified when requesting an object's metadata");
String bucketName = getObjectMetadataRequest.getBucketName();
String key = getObjectMetadataRequest.getKey();
String versionId = getObjectMetadataRequest.getVersionId();
assertParameterNotNull(bucketName, "The bucket name parameter must be specified when requesting an object's metadata");
assertParameterNotNull(key, "The key parameter must be specified when requesting an object's metadata");
Request<Void> request = createRequest(bucketName, key, getObjectMetadataRequest);
if (versionId != null) request.addParameter("versionId", versionId);
signRequest(request, HttpMethodName.HEAD, bucketName, key);
HttpRequest httpRequest = convertToHttpRequest(request, HttpMethodName.HEAD);
S3MetadataResponseHandler responseHandler = new S3MetadataResponseHandler();
return (ObjectMetadata)client.execute(httpRequest, responseHandler, errorResponseHandler);
}
/* (non-Javadoc)
* @see com.amazonaws.services.s3.AmazonS3#getObject(java.lang.String, java.lang.String)
*/
public S3Object getObject(String bucketName, String key)
throws AmazonClientException, AmazonServiceException {
return getObject(new GetObjectRequest(bucketName, key));
}
/* (non-Javadoc)
* @see com.amazonaws.services.s3.AmazonS3#doesBucketExist(java.lang.String)
*/
public boolean doesBucketExist(String bucketName)
throws AmazonClientException, AmazonServiceException {
try {
listObjects(new ListObjectsRequest(bucketName, null, null, null, 0));
// it exists and the current account owns it
return true;
} catch (AmazonServiceException ase) {
switch (ase.getStatusCode()) {
case 403:
/*
* A permissions error means the bucket exists, but is owned by
* another account.
*/
return true;
case 404:
return false;
default:
throw ase;
}
}
}
/* (non-Javadoc)
* @see com.amazonaws.services.s3.AmazonS3#changeStorageClass(java.lang.String, java.lang.String, java.lang.String)
*/
public void changeObjectStorageClass(String bucketName, String key, StorageClass newStorageClass)
throws AmazonClientException, AmazonServiceException {
assertParameterNotNull(bucketName,
"The bucketName parameter must be specified when changing an object's storage class");
assertParameterNotNull(key,
"The key parameter must be specified when changing an object's storage class");
assertParameterNotNull(newStorageClass,
"The newStorageClass parameter must be specified when changing an object's storage class");
copyObject(new CopyObjectRequest(bucketName, key, bucketName, key)
.withStorageClass(newStorageClass.toString()));
}
/* (non-Javadoc)
* @see com.amazonaws.services.s3.AmazonS3#getObject(com.amazonaws.services.s3.model.GetObjectRequest)
*/
public S3Object getObject(GetObjectRequest getObjectRequest)
throws AmazonClientException, AmazonServiceException {
assertParameterNotNull(getObjectRequest,
"The GetObjectRequest parameter must be specified when requesting an object");
assertParameterNotNull(getObjectRequest.getBucketName(),
"The bucket name parameter must be specified when requesting an object");
assertParameterNotNull(getObjectRequest.getKey(),
"The key parameter must be specified when requesting an object");
String bucketName = getObjectRequest.getBucketName();
String key = getObjectRequest.getKey();
Request<Void> request = createRequest(bucketName, key, getObjectRequest);
if (getObjectRequest.getVersionId() != null) {
request.addParameter("versionId", getObjectRequest.getVersionId());
}
// Range
if (getObjectRequest.getRange() != null) {
long[] range = getObjectRequest.getRange();
request.addHeader(Headers.RANGE, "bytes=" + Long.toString(range[0]) + "-" + Long.toString(range[1]));
}
addDateHeader(request, Headers.GET_OBJECT_IF_MODIFIED_SINCE,
getObjectRequest.getModifiedSinceConstraint());
addDateHeader(request, Headers.GET_OBJECT_IF_UNMODIFIED_SINCE,
getObjectRequest.getUnmodifiedSinceConstraint());
addStringListHeader(request, Headers.GET_OBJECT_IF_MATCH,
getObjectRequest.getMatchingETagConstraints());
addStringListHeader(request, Headers.GET_OBJECT_IF_NONE_MATCH,
getObjectRequest.getNonmatchingETagConstraints());
signRequest(request, HttpMethodName.GET, bucketName, key);
HttpRequest httpRequest = convertToHttpRequest(request, HttpMethodName.GET);
try {
S3ObjectResponseHandler responseHandler = new S3ObjectResponseHandler();
S3Object s3Object = (S3Object)client.execute(httpRequest, responseHandler, errorResponseHandler);
/*
* TODO: For now, it's easiest to set there here in the client, but
* we could push this back into the response handler with a
* little more work.
*/
s3Object.setBucketName(bucketName);
s3Object.setKey(key);
/*
* TODO: It'd be nice to check the integrity of the data was received from S3,
* but we'd have to read off the stream and buffer the contents somewhere
* in order to do that.
*
* We could consider adding an option for this in the future, or wrapping
* the InputStream in another implementation of FilterInputStream that
* would calculate the checksum when the user reads the data and then
* notify them somehow if there was a problem.
*/
return s3Object;
} catch (AmazonS3Exception ase) {
/*
* If the request failed because one of the specified constraints
* was not met (ex: matching ETag, modified since date, etc.), then
* return null, so that users don't have to wrap their code in
* try/catch blocks and check for this status code if they want to
* use constraints.
*/
if (ase.getStatusCode() == 412 || ase.getStatusCode() == 304) {
return null;
}
throw ase;
}
}
/* (non-Javadoc)
* @see com.amazonaws.services.s3.AmazonS3#deleteBucket(java.lang.String)
*/
public void deleteBucket(String bucketName)
throws AmazonClientException, AmazonServiceException {
deleteBucket(new DeleteBucketRequest(bucketName));
}
/* (non-Javadoc)
* @see com.amazonaws.services.s3.AmazonS3#deleteBucket(com.amazonaws.services.s3.model.DeleteBucketRequest)
*/
public void deleteBucket(DeleteBucketRequest deleteBucketRequest)
throws AmazonClientException, AmazonServiceException {
assertParameterNotNull(deleteBucketRequest,
"The DeleteBucketRequest parameter must be specified when deleting a bucket");
String bucketName = deleteBucketRequest.getBucketName();
assertParameterNotNull(bucketName,
"The bucket name parameter must be specified when deleting a bucket");
Request<Void> request = createRequest(bucketName, null, deleteBucketRequest);
signRequest(request, HttpMethodName.DELETE, bucketName, null);
HttpRequest httpRequest = convertToHttpRequest(request, HttpMethodName.DELETE);
client.execute(httpRequest, voidResponseHandler, errorResponseHandler);
}
/* (non-Javadoc)
* @see com.amazonaws.services.s3.AmazonS3#putObject(java.lang.String, java.lang.String, java.io.InputStream, com.amazonaws.services.s3.model.S3ObjectMetadata)
*/
public PutObjectResult putObject(String bucketName, String key, InputStream input, ObjectMetadata metadata)
throws AmazonClientException, AmazonServiceException {
return putObject(new PutObjectRequest(bucketName, key, input, metadata));
}
/* (non-Javadoc)
* @see com.amazonaws.services.s3.AmazonS3#putObject(com.amazonaws.services.s3.model.PutObjectRequest)
*/
public PutObjectResult putObject(PutObjectRequest putObjectRequest)
throws AmazonClientException, AmazonServiceException {
assertParameterNotNull(putObjectRequest, "The PutObjectRequest parameter must be specified when uploading an object");
String bucketName = putObjectRequest.getBucketName();
String key = putObjectRequest.getKey();
ObjectMetadata metadata = putObjectRequest.getMetadata();
InputStream input = putObjectRequest.getInputStream();
ProgressListener progressListener = putObjectRequest.getProgressListener();
if (metadata == null) metadata = new ObjectMetadata();
assertParameterNotNull(bucketName, "The bucket name parameter must be specified when uploading an object");
assertParameterNotNull(key, "The key parameter must be specified when uploading an object");
Request<Void> request = createRequest(bucketName, key, putObjectRequest);
if (putObjectRequest.getCannedAcl() != null) {
request.addHeader(Headers.S3_CANNED_ACL, putObjectRequest.getCannedAcl().toString());
}
if (putObjectRequest.getStorageClass() != null) {
request.addHeader(Headers.STORAGE_CLASS, putObjectRequest.getStorageClass());
}
if (metadata.getContentLength() <= 0) {
/*
* There's nothing we can do except for let the HTTP client buffer
* the input stream contents if the caller doesn't tell us how much
* data to expect in a stream since we have to explicitly tell
* Amazon S3 how much we're sending before we start sending any of
* it.
*/
log.warn("No content length specified for stream data. " +
"Stream contents will be buffered in memory and could result in " +
"out of memory errors.");
}
if (progressListener != null) {
input = new ProgressReportingInputStream(input, progressListener);
fireProgressEvent(progressListener, ProgressEvent.STARTED_EVENT_CODE);
}
if (!input.markSupported()) {
input = new RepeatableInputStream(input, Constants.DEFAULT_STREAM_BUFFER_SIZE);
}
MD5DigestCalculatingInputStream md5DigestStream = null;
if (metadata.getContentMD5() == null) {
/*
* If the user hasn't set the content MD5, then we don't want to
* buffer the whole stream in memory just to calculate it. Instead,
* we can calculate it on the fly and validate it with the returned
* ETag from the object upload.
*/
try {
md5DigestStream = new MD5DigestCalculatingInputStream(input);
input = md5DigestStream;
} catch (NoSuchAlgorithmException e) {
log.warn("No MD5 digest algorithm available. Unable to calculate " +
"checksum and verify data integrity.", e);
}
}
if (metadata.getContentType() == null) {
/*
* Default to the "application/octet-stream" if the user hasn't
* specified a content type.
*/
metadata.setContentType(Mimetypes.MIMETYPE_OCTET_STREAM);
}
populateRequestMetadata(request, metadata);
signRequest(request, HttpMethodName.PUT, bucketName, key);
HttpRequest httpRequest = convertToHttpRequest(request, HttpMethodName.PUT);
httpRequest.setContent(input);
ObjectMetadata returnedMetadata = null;
try {
S3MetadataResponseHandler responseHandler = new S3MetadataResponseHandler();
returnedMetadata = (ObjectMetadata)client.execute(httpRequest, responseHandler, errorResponseHandler);
} catch (AmazonClientException ace) {
fireProgressEvent(progressListener, ProgressEvent.FAILED_EVENT_CODE);
throw ace;
} finally {
try {input.close();} catch (Exception e) {
log.warn("Unable to cleanly close input stream: " + e.getMessage(), e);
}
}
String contentMd5 = metadata.getContentMD5();
if (md5DigestStream != null) {
contentMd5 = ServiceUtils.toBase64(md5DigestStream.getMd5Digest());
}
if (returnedMetadata != null && contentMd5 != null) {
byte[] clientSideHash = ServiceUtils.fromBase64(contentMd5);
byte[] serverSideHash = ServiceUtils.fromHex(returnedMetadata.getETag());
if (!Arrays.equals(clientSideHash, serverSideHash)) {
fireProgressEvent(progressListener, ProgressEvent.FAILED_EVENT_CODE);
throw new AmazonClientException("Unable to verify integrity of data upload. " +
"Client calculated content hash didn't match hash calculated by Amazon S3. " +
"You may need to delete the data stored in Amazon S3.");
}
}
fireProgressEvent(progressListener, ProgressEvent.COMPLETED_EVENT_CODE);
PutObjectResult result = new PutObjectResult();
result.setETag(returnedMetadata.getETag());
result.setVersionId(returnedMetadata.getVersionId());
return result;
}
/* (non-Javadoc)
* @see com.amazonaws.services.s3.AmazonS3#copyObject(java.lang.String, java.lang.String, java.lang.String, java.lang.String)
*/
public CopyObjectResult copyObject(String sourceBucketName, String sourceKey,
String destinationBucketName, String destinationKey)
throws AmazonClientException, AmazonServiceException {
return copyObject(new CopyObjectRequest(sourceBucketName, sourceKey,
destinationBucketName, destinationKey));
}
/* (non-Javadoc)
* @see com.amazonaws.services.s3.AmazonS3#copyObject(com.amazonaws.services.s3.model.CopyObjectRequest)
*/
public CopyObjectResult copyObject(CopyObjectRequest copyObjectRequest)
throws AmazonClientException, AmazonServiceException {
assertParameterNotNull(copyObjectRequest.getSourceBucketName(),
"The source bucket name must be specified when copying an object");
assertParameterNotNull(copyObjectRequest.getSourceKey(),
"The source object key must be specified when copying an object");
assertParameterNotNull(copyObjectRequest.getDestinationBucketName(),
"The destination bucket name must be specified when copying an object");
assertParameterNotNull(copyObjectRequest.getDestinationKey(),
"The destination object key must be specified when copying an object");
String destinationKey = copyObjectRequest.getDestinationKey();
String destinationBucketName = copyObjectRequest.getDestinationBucketName();
Request<Void> request = createRequest(destinationBucketName, destinationKey, copyObjectRequest);
populateRequestWithCopyObjectParameters(request, copyObjectRequest);
/*
* We can't send the Content-Length header if the user specified it,
* otherwise it messes up the HTTP connection when the remote server
* thinks there's more data to pull.
*/
request.getHeaders().remove(Headers.CONTENT_LENGTH);
signRequest(request, HttpMethodName.PUT, destinationBucketName, destinationKey);
HttpRequest httpRequest = convertToHttpRequest(request, HttpMethodName.PUT);
CopyObjectResultHandler copyObjectResultHandler = null;
try {
// TODO: Should we move some more of this logic into CopyObjectResponseHandler?
// For example, detecting the different failure modes?
CopyObjectResponseHandler responseHandler = new CopyObjectResponseHandler();
copyObjectResultHandler =
(CopyObjectResultHandler)client.execute(httpRequest, responseHandler, errorResponseHandler);
} catch (AmazonS3Exception ase) {
/*
* If the request failed because one of the specified constraints
* was not met (ex: matching ETag, modified since date, etc.), then
* return null, so that users don't have to wrap their code in
* try/catch blocks and check for this status code if they want to
* use constraints.
*/
if (ase.getStatusCode() == Constants.FAILED_PRECONDITION_STATUS_CODE) {
return null;
}
throw ase;
}
/*
* CopyObject has two failure modes:
* 1 - An HTTP error code is returned and the error is processed like any
* other error response.
* 2 - An HTTP 200 OK code is returned, but the response content contains
* an XML error response.
*
* This makes it very difficult for the client runtime to cleanly detect
* this case and handle it like any other error response. We could
* extend the runtime to have a more flexible/customizable definition of
* success/error (per request), but it's probably overkill for this
* one special case.
*/
if (copyObjectResultHandler.getErrorCode() != null) {
String errorCode = copyObjectResultHandler.getErrorCode();
String errorMessage = copyObjectResultHandler.getErrorMessage();
String requestId = copyObjectResultHandler.getErrorRequestId();
String hostId = copyObjectResultHandler.getErrorHostId();
AmazonS3Exception ase = new AmazonS3Exception(errorMessage);
ase.setErrorCode(errorCode);
ase.setErrorType(ErrorType.Service);
ase.setRequestId(requestId);
ase.setExtendedRequestId(hostId);
ase.setServiceName(request.getServiceName());
ase.setStatusCode(200);
throw ase;
}
// TODO: Might be nice to create this in our custom CopyObjectResponseHandler
CopyObjectResult copyObjectResult = new CopyObjectResult();
copyObjectResult.setETag(copyObjectResultHandler.getETag());
copyObjectResult.setLastModifiedDate(
copyObjectResultHandler.getLastModified());
copyObjectResult.setVersionId(copyObjectResultHandler.getVersionId());
return copyObjectResult;
}
/* (non-Javadoc)
* @see com.amazonaws.services.s3.AmazonS3#deleteObject(java.lang.String, java.lang.String)
*/
public void deleteObject(String bucketName, String key)
throws AmazonClientException, AmazonServiceException {
deleteObject(new DeleteObjectRequest(bucketName, key));
}
/* (non-Javadoc)
* @see com.amazonaws.services.s3.AmazonS3#deleteObject(com.amazonaws.services.s3.DeleteObjectRequest)
*/
public void deleteObject(DeleteObjectRequest deleteObjectRequest)
throws AmazonClientException, AmazonServiceException {
assertParameterNotNull(deleteObjectRequest,
"The delete object request must be specified when deleting an object");
String bucketName = deleteObjectRequest.getBucketName();
String key = deleteObjectRequest.getKey();
assertParameterNotNull(bucketName, "The bucket name must be specified when deleting an object");
assertParameterNotNull(key, "The key must be specified when deleting an object");
Request<Void> request = createRequest(bucketName, key, deleteObjectRequest);
signRequest(request, HttpMethodName.DELETE, bucketName, key);
HttpRequest httpRequest = convertToHttpRequest(request, HttpMethodName.DELETE);
client.execute(httpRequest, voidResponseHandler, errorResponseHandler);
}
/* (non-Javadoc)
* @see com.amazonaws.services.s3.AmazonS3#deleteObjectVersion(java.lang.String, java.lang.String, java.lang.String)
*/
public void deleteVersion(String bucketName, String key, String versionId)
throws AmazonClientException, AmazonServiceException {
deleteVersion(new DeleteVersionRequest(bucketName, key, versionId));
}
/* (non-Javadoc)
* @see com.amazonaws.services.s3.AmazonS3#deleteVersion(com.amazonaws.services.s3.model.DeleteVersionRequest)
*/
public void deleteVersion(DeleteVersionRequest deleteVersionRequest)
throws AmazonClientException, AmazonServiceException {
assertParameterNotNull(deleteVersionRequest,
"The delete version request object must be specified when deleting a version");
String bucketName = deleteVersionRequest.getBucketName();
String key = deleteVersionRequest.getKey();
String versionId = deleteVersionRequest.getVersionId();
assertParameterNotNull(bucketName, "The bucket name must be specified when deleting a version");
assertParameterNotNull(key, "The key must be specified when deleting a version");
assertParameterNotNull(versionId, "The version ID must be specified when deleting a version");
Request<Void> request = createRequest(bucketName, key, deleteVersionRequest);
if (versionId != null) request.addParameter("versionId", versionId);
if (deleteVersionRequest.getMfa() != null) {
populateRequestWithMfaDetails(request, deleteVersionRequest.getMfa());
}
signRequest(request, HttpMethodName.DELETE, bucketName, key);
HttpRequest httpRequest = convertToHttpRequest(request, HttpMethodName.DELETE);
client.execute(httpRequest, voidResponseHandler, errorResponseHandler);
}
/* (non-Javadoc)
* @see com.amazonaws.services.s3.AmazonS3#setBucketVersioningConfiguration(com.amazonaws.services.s3.model.SetBucketVersioningConfigurationRequest)
*/
public void setBucketVersioningConfiguration(SetBucketVersioningConfigurationRequest setBucketVersioningConfigurationRequest)
throws AmazonClientException, AmazonServiceException {
assertParameterNotNull(setBucketVersioningConfigurationRequest,
"The SetBucketVersioningConfigurationRequest object must be specified when setting versioning configuration");
String bucketName = setBucketVersioningConfigurationRequest.getBucketName();
BucketVersioningConfiguration versioningConfiguration = setBucketVersioningConfigurationRequest.getVersioningConfiguration();
assertParameterNotNull(bucketName,
"The bucket name parameter must be specified when setting versioning configuration");
assertParameterNotNull(versioningConfiguration,
"The bucket versioning parameter must be specified when setting versioning configuration");
if (versioningConfiguration.isMfaDeleteEnabled() != null) {
assertParameterNotNull(setBucketVersioningConfigurationRequest.getMfa(),
"The MFA parameter must be specified when changing MFA Delete status in the versioning configuration");
}
Request<Void> request = createRequest(bucketName, null, setBucketVersioningConfigurationRequest);
request.addParameter("versioning", null);
if (versioningConfiguration.isMfaDeleteEnabled() != null) {
if (setBucketVersioningConfigurationRequest.getMfa() != null) {
populateRequestWithMfaDetails(request, setBucketVersioningConfigurationRequest.getMfa());
}
}
signRequest(request, HttpMethodName.PUT, bucketName, null);
HttpRequest httpRequest = convertToHttpRequest(request, HttpMethodName.PUT);
byte[] bytes = bucketConfigurationXmlFactory.convertToXmlByteArray(versioningConfiguration);
httpRequest.setContent(new ByteArrayInputStream(bytes));
client.execute(httpRequest, voidResponseHandler, errorResponseHandler);
}
/* (non-Javadoc)
* @see com.amazonaws.services.s3.AmazonS3#getBucketVersioningConfiguration(java.lang.String)
*/
public BucketVersioningConfiguration getBucketVersioningConfiguration(String bucketName)
throws AmazonClientException, AmazonServiceException {
assertParameterNotNull(bucketName,
"The bucket name parameter must be specified when querying versioning configuration");
Request<Void> request = createRequest(bucketName, null, null);
request.addParameter("versioning", null);
signRequest(request, HttpMethodName.GET, bucketName, null);
HttpRequest httpRequest = convertToHttpRequest(request, HttpMethodName.GET);
S3XmlResponseHandler<BucketVersioningConfiguration> responseHandler =
new S3XmlResponseHandler<BucketVersioningConfiguration>(new Unmarshallers.BucketVersioningConfigurationUnmarshaller());
return (BucketVersioningConfiguration)client.execute(httpRequest, responseHandler, errorResponseHandler);
}
/* (non-Javadoc)
* @see com.amazonaws.services.s3.AmazonS3#setBucketNotificationConfiguration(java.lang.String,com.amazonaws.services.s3.model.BucketNotificationConfiguration)
*/
public void setBucketNotificationConfiguration(String bucketName, BucketNotificationConfiguration bucketNotificationConfiguration)
throws AmazonClientException, AmazonServiceException {
assertParameterNotNull(bucketName,
"The bucket name parameter must be specified when setting notification configuration");
assertParameterNotNull(bucketNotificationConfiguration,
"The bucket notification parameter must be specified when setting notification configuration");
Request<Void> request = createRequest(bucketName, null, null);
request.addParameter("notification", null);
signRequest(request, HttpMethodName.PUT, bucketName, null);
HttpRequest httpRequest = convertToHttpRequest(request, HttpMethodName.PUT);
byte[] bytes = bucketConfigurationXmlFactory.convertToXmlByteArray(bucketNotificationConfiguration);
httpRequest.setContent(new ByteArrayInputStream(bytes));
client.execute(httpRequest, voidResponseHandler, errorResponseHandler);
}
/* (non-Javadoc)
* @see com.amazonaws.services.s3.AmazonS3#getBucketNotificationConfiguration(java.lang.String)
*/
public BucketNotificationConfiguration getBucketNotificationConfiguration(String bucketName)
throws AmazonClientException, AmazonServiceException {
assertParameterNotNull(bucketName,
"The bucket name parameter must be specified when querying notification configuration");
Request<Void> request = createRequest(bucketName, null, null);
request.addParameter("notification", null);
signRequest(request, HttpMethodName.GET, bucketName, null);
HttpRequest httpRequest = convertToHttpRequest(request, HttpMethodName.GET);
S3XmlResponseHandler<BucketNotificationConfiguration> responseHandler =
new S3XmlResponseHandler<BucketNotificationConfiguration>(new Unmarshallers.BucketNotificationConfigurationUnmarshaller());
return (BucketNotificationConfiguration)client.execute(httpRequest, responseHandler, errorResponseHandler);
}
/* (non-Javadoc)
* @see com.amazonaws.services.s3.AmazonS3#getBucketLoggingConfiguration(java.lang.String)
*/
public BucketLoggingConfiguration getBucketLoggingConfiguration(String bucketName)
throws AmazonClientException, AmazonServiceException {
assertParameterNotNull(bucketName,
"The bucket name parameter must be specified when requesting a bucket's logging status");
Request<Void> request = createRequest(bucketName, null, null);
request.addParameter("logging", null);
signRequest(request, HttpMethodName.GET, bucketName, null);
HttpRequest httpRequest = convertToHttpRequest(request, HttpMethodName.GET);
S3XmlResponseHandler<BucketLoggingConfiguration> responseHandler =
new S3XmlResponseHandler<BucketLoggingConfiguration>(new Unmarshallers.BucketLoggingConfigurationnmarshaller());
return (BucketLoggingConfiguration)client.execute(httpRequest, responseHandler, errorResponseHandler);
}
/* (non-Javadoc)
* @see com.amazonaws.services.s3.AmazonS3#setBucketLoggingConfiguration(com.amazonaws.services.s3.SetBucketLoggingConfigurationRequest)
*/
public void setBucketLoggingConfiguration(SetBucketLoggingConfigurationRequest setBucketLoggingConfigurationRequest)
throws AmazonClientException, AmazonServiceException {
assertParameterNotNull(setBucketLoggingConfigurationRequest,
"The set bucket logging configuration request object must be specified when enabling server access logging");
String bucketName = setBucketLoggingConfigurationRequest.getBucketName();
BucketLoggingConfiguration loggingConfiguration = setBucketLoggingConfigurationRequest.getLoggingConfiguration();
assertParameterNotNull(bucketName,
"The bucket name parameter must be specified when enabling server access logging");
assertParameterNotNull(bucketName,
"The logging configuration parameter must be specified when enabling server access logging");
Request<Void> request = createRequest(bucketName, null, setBucketLoggingConfigurationRequest);
request.addParameter("logging", null);
signRequest(request, HttpMethodName.PUT, bucketName, null);
HttpRequest httpRequest = convertToHttpRequest(request, HttpMethodName.PUT);
byte[] bytes = bucketConfigurationXmlFactory.convertToXmlByteArray(loggingConfiguration);
httpRequest.setContent(new ByteArrayInputStream(bytes));
client.execute(httpRequest, voidResponseHandler, errorResponseHandler);
}
/* (non-Javadoc)
* @see com.amazonaws.services.s3.AmazonS3#getBucketPolicy(java.lang.String)
*/
public BucketPolicy getBucketPolicy(String bucketName)
throws AmazonClientException, AmazonServiceException {
assertParameterNotNull(bucketName,
"The bucket name must be specified when getting a bucket policy");
Request<Void> request = createRequest(bucketName, null, null);
request.addParameter("policy", null);
signRequest(request, HttpMethodName.GET, bucketName, null);
HttpRequest httpRequest = convertToHttpRequest(request, HttpMethodName.GET);
BucketPolicy result = new BucketPolicy();
try {
String policyText = client.execute(httpRequest, new S3StringResponseHandler(), errorResponseHandler);
result.setPolicyText(policyText);
return result;
} catch (AmazonServiceException ase) {
/*
* If we receive an error response telling us that no policy has
* been set for this bucket, then instead of forcing the user to
* deal with the exception, we'll just return an empty result. Any
* other exceptions will be rethrown for the user to handle.
*/
if (ase.getErrorCode().equals("NoSuchBucketPolicy")) return result;
throw ase;
}
}
/* (non-Javadoc)
* @see com.amazonaws.services.s3.AmazonS3#setBucketPolicy(java.lang.String, java.lang.String)
*/
public void setBucketPolicy(String bucketName, String policyText)
throws AmazonClientException, AmazonServiceException {
assertParameterNotNull(bucketName,
"The bucket name must be specified when setting a bucket policy");
assertParameterNotNull(policyText,
"The policy text must be specified when setting a bucket policy");
Request<Void> request = createRequest(bucketName, null, null);
request.addParameter("policy", null);
signRequest(request, HttpMethodName.PUT, bucketName, null);
HttpRequest httpRequest = convertToHttpRequest(request, HttpMethodName.PUT);
httpRequest.setContent(new ByteArrayInputStream(ServiceUtils.toByteArray(policyText)));
client.execute(httpRequest, voidResponseHandler, errorResponseHandler);
}
/* (non-Javadoc)
* @see com.amazonaws.services.s3.AmazonS3#deleteBucketPolicy(java.lang.String)
*/
public void deleteBucketPolicy(String bucketName)
throws AmazonClientException, AmazonServiceException {
assertParameterNotNull(bucketName,
"The bucket name must be specified when deleting a bucket policy");
Request<Void> request = createRequest(bucketName, null, null);
request.addParameter("policy", null);
signRequest(request, HttpMethodName.DELETE, bucketName, null);
HttpRequest httpRequest = convertToHttpRequest(request, HttpMethodName.DELETE);
client.execute(httpRequest, this.voidResponseHandler, this.errorResponseHandler);
}
/* (non-Javadoc)
* @see com.amazonaws.services.s3.AmazonS3#generatePresignedUrl(java.lang.String, java.lang.String, java.util.Date)
*/
public URL generatePresignedUrl(String bucketName, String key, Date expiration)
throws AmazonClientException {
return generatePresignedUrl(bucketName, key, expiration, HttpMethod.GET);
}
/* (non-Javadoc)
* @see com.amazonaws.services.s3.AmazonS3#generatePresignedUrl(java.lang.String, java.lang.String, java.util.Date, com.amazonaws.HttpMethod)
*/
public URL generatePresignedUrl(String bucketName, String key, Date expiration, HttpMethod method)
throws AmazonClientException {
GeneratePresignedUrlRequest request = new GeneratePresignedUrlRequest(bucketName, key, method);
request.setExpiration(expiration);
return generatePresignedUrl(request);
}
/* (non-Javadoc)
* @see com.amazonaws.services.s3.AmazonS3#generatePresignedUrl(com.amazonaws.services.s3.model.GeneratePresignedUrlRequest)
*/
public URL generatePresignedUrl(GeneratePresignedUrlRequest generatePresignedUrlRequest)
throws AmazonClientException {
assertParameterNotNull(generatePresignedUrlRequest,
"The request parameter must be specified when generating a pre-signed URL");
String bucketName = generatePresignedUrlRequest.getBucketName();
String key = generatePresignedUrlRequest.getKey();
assertParameterNotNull(bucketName,
"The bucket name parameter must be specified when generating a pre-signed URL");
assertParameterNotNull(generatePresignedUrlRequest.getMethod(),
"The HTTP method request parameter must be specified when generating a pre-signed URL");
if (generatePresignedUrlRequest.getExpiration() == null) {
generatePresignedUrlRequest.setExpiration(
new Date(System.currentTimeMillis() + 1000 * 60 * 15));
}
Request<Void> request = createRequest(bucketName, key, generatePresignedUrlRequest);
for (Entry<String, String> entry : generatePresignedUrlRequest.getRequestParameters().entrySet()) {
request.addParameter(entry.getKey(), entry.getValue());
}
presignRequest(request, generatePresignedUrlRequest.getMethod(),
bucketName, key, generatePresignedUrlRequest.getExpiration(), null);
return ServiceUtils.convertRequestToUrl(request);
}
/* (non-Javadoc)
* @see com.amazonaws.services.s3.AmazonS3#abortMultipartUpload(com.amazonaws.services.s3.model.AbortMultipartUploadRequest)
*/
public void abortMultipartUpload(AbortMultipartUploadRequest abortMultipartUploadRequest)
throws AmazonClientException, AmazonServiceException {
assertParameterNotNull(abortMultipartUploadRequest,
"The request parameter must be specified when aborting a multipart upload");
assertParameterNotNull(abortMultipartUploadRequest.getBucketName(),
"The bucket name parameter must be specified when aborting a multipart upload");
assertParameterNotNull(abortMultipartUploadRequest.getKey(),
"The key parameter must be specified when aborting a multipart upload");
assertParameterNotNull(abortMultipartUploadRequest.getUploadId(),
"The upload ID parameter must be specified when aborting a multipart upload");
String bucketName = abortMultipartUploadRequest.getBucketName();
String key = abortMultipartUploadRequest.getKey();
Request<Void> request = createRequest(bucketName, key, abortMultipartUploadRequest);
request.addParameter("uploadId", abortMultipartUploadRequest.getUploadId());
signRequest(request, HttpMethodName.DELETE, bucketName, key);
HttpRequest httpRequest = convertToHttpRequest(request, HttpMethodName.DELETE);
client.execute(httpRequest, this.voidResponseHandler, this.errorResponseHandler);
}
/* (non-Javadoc)
* @see com.amazonaws.services.s3.AmazonS3#completeMultipartUpload(com.amazonaws.services.s3.model.CompleteMultipartUploadRequest)
*/
public CompleteMultipartUploadResult completeMultipartUpload(
CompleteMultipartUploadRequest completeMultipartUploadRequest)
throws AmazonClientException, AmazonServiceException {
assertParameterNotNull(completeMultipartUploadRequest,
"The request parameter must be specified when completing a multipart upload");
String bucketName = completeMultipartUploadRequest.getBucketName();
String key = completeMultipartUploadRequest.getKey();
String uploadId = completeMultipartUploadRequest.getUploadId();
assertParameterNotNull(bucketName,
"The bucket name parameter must be specified when completing a multipart upload");
assertParameterNotNull(key,
"The key parameter must be specified when completing a multipart upload");
assertParameterNotNull(uploadId,
"The upload ID parameter must be specified when completing a multipart upload");
assertParameterNotNull(completeMultipartUploadRequest.getPartETags(),
"The part ETags parameter must be specified when completing a multipart upload");
Request<Void> request = createRequest(bucketName, key, completeMultipartUploadRequest);
request.addParameter("uploadId", uploadId);
byte[] xml = RequestXmlFactory.convertToXmlByteArray(completeMultipartUploadRequest.getPartETags());
request.addHeader("Content-Type", "text/plain");
request.addHeader("Content-Length", String.valueOf(xml.length));
signRequest(request, HttpMethodName.POST, bucketName, key);
HttpRequest httpRequest = convertToHttpRequest(request, HttpMethodName.POST);
httpRequest.setContent(new ByteArrayInputStream(xml));
S3XmlResponseHandler<CompleteMultipartUploadHandler> responseHandler =
new S3XmlResponseHandler<CompleteMultipartUploadHandler>(new Unmarshallers.CompleteMultipartUploadResultUnmarshaller());
CompleteMultipartUploadHandler handler = client.execute(httpRequest, responseHandler, errorResponseHandler);
if (handler.getCompleteMultipartUploadResult() != null) {
String versionId = responseHandler.getResponseHeaders().get(Headers.S3_VERSION_ID);
handler.getCompleteMultipartUploadResult().setVersionId(versionId);
return handler.getCompleteMultipartUploadResult();
} else {
throw handler.getAmazonS3Exception();
}
}
/* (non-Javadoc)
* @see com.amazonaws.services.s3.AmazonS3#initiateMultipartUpload(com.amazonaws.services.s3.model.InitiateMultipartUploadRequest)
*/
public InitiateMultipartUploadResult initiateMultipartUpload(
InitiateMultipartUploadRequest initiateMultipartUploadRequest)
throws AmazonClientException, AmazonServiceException {
assertParameterNotNull(initiateMultipartUploadRequest,
"The request parameter must be specified when initiating a multipart upload");
String bucketName = initiateMultipartUploadRequest.getBucketName();
String key = initiateMultipartUploadRequest.getKey();
CannedAccessControlList cannedACL = initiateMultipartUploadRequest.getCannedACL();
StorageClass storageClass = initiateMultipartUploadRequest.getStorageClass();
ObjectMetadata objectMetadata = initiateMultipartUploadRequest.objectMetadata;
assertParameterNotNull(bucketName,
"The bucket name parameter must be specified when initiating a multipart upload");
assertParameterNotNull(key,
"The key parameter must be specified when initiating a multipart upload");
Request<Void> request = createRequest(bucketName, key, initiateMultipartUploadRequest);
request.addParameter("uploads", null);
if (storageClass != null)
request.addHeader(Headers.STORAGE_CLASS, storageClass.toString());
if (cannedACL != null)
request.addHeader(Headers.S3_CANNED_ACL, cannedACL.toString());
if (objectMetadata != null) populateRequestMetadata(request, objectMetadata);
// Be careful that we don't send the object's total size as the content
// length for the InitiateMultipartUpload request.
request.getHeaders().remove(Headers.CONTENT_LENGTH);
signRequest(request, HttpMethodName.POST, bucketName, key);
HttpRequest httpRequest = convertToHttpRequest(request, HttpMethodName.POST);
// Set the request content to be empty (but not null) to force the runtime to pass
// any query params in the query string and not the request body, to keep S3 happy.
httpRequest.setContent(new ByteArrayInputStream(new byte[0]));
S3XmlResponseHandler<InitiateMultipartUploadResult> responseHandler =
new S3XmlResponseHandler<InitiateMultipartUploadResult>(new Unmarshallers.InitiateMultipartUploadResultUnmarshaller());
return (InitiateMultipartUploadResult)client.execute(httpRequest, responseHandler, errorResponseHandler);
}
/* (non-Javadoc)
* @see com.amazonaws.services.s3.AmazonS3#listMultipartUploads(com.amazonaws.services.s3.model.ListMultipartUploadsRequest)
*/
public MultipartUploadListing listMultipartUploads(ListMultipartUploadsRequest listMultipartUploadsRequest)
throws AmazonClientException, AmazonServiceException {
assertParameterNotNull(listMultipartUploadsRequest,
"The request parameter must be specified when listing multipart uploads");
String bucketName = listMultipartUploadsRequest.getBucketName();
String keyMarker = listMultipartUploadsRequest.getKeyMarker();
Integer maxUploads = listMultipartUploadsRequest.getMaxUploads();
String uploadIdMarker = listMultipartUploadsRequest.getUploadIdMarker();
assertParameterNotNull(bucketName,
"The bucket name parameter must be specified when listing multipart uploads");
Request<Void> request = createRequest(bucketName, null, listMultipartUploadsRequest);
request.addParameter("uploads", null);
if (keyMarker != null) request.addParameter("key-marker", keyMarker);
if (maxUploads != null) request.addParameter("max-uploads", maxUploads.toString());
if (uploadIdMarker != null) request.addParameter("upload-id-marker", uploadIdMarker);
signRequest(request, HttpMethodName.GET, bucketName, null);
HttpRequest httpRequest = convertToHttpRequest(request, HttpMethodName.GET);
S3XmlResponseHandler<MultipartUploadListing> responseHandler =
new S3XmlResponseHandler<MultipartUploadListing>(new Unmarshallers.ListMultipartUploadsResultUnmarshaller());
return (MultipartUploadListing)client.execute(httpRequest, responseHandler, errorResponseHandler);
}
/* (non-Javadoc)
* @see com.amazonaws.services.s3.AmazonS3#listParts(com.amazonaws.services.s3.model.ListPartsRequest)
*/
public PartListing listParts(ListPartsRequest listPartsRequest)
throws AmazonClientException, AmazonServiceException {
assertParameterNotNull(listPartsRequest,
"The request parameter must be specified when listing parts");
String bucketName = listPartsRequest.getBucketName();
String key = listPartsRequest.getKey();
String uploadId = listPartsRequest.getUploadId();
Integer maxParts = listPartsRequest.getMaxParts();
Integer partNumberMarker = listPartsRequest.getPartNumberMarker();
assertParameterNotNull(bucketName,
"The bucket name parameter must be specified when listing parts");
assertParameterNotNull(key,
"The key parameter must be specified when listing parts");
assertParameterNotNull(uploadId,
"The upload ID parameter must be specified when listing parts");
Request<Void> request = createRequest(bucketName, key, listPartsRequest);
request.addParameter("uploadId", uploadId);
if (maxParts != null) request.addParameter("max-parts", maxParts.toString());
if (partNumberMarker != null) request.addParameter("part-number-marker", partNumberMarker.toString());
signRequest(request, HttpMethodName.GET, bucketName, key);
HttpRequest httpRequest = convertToHttpRequest(request, HttpMethodName.GET);
S3XmlResponseHandler<PartListing> responseHandler =
new S3XmlResponseHandler<PartListing>(new Unmarshallers.ListPartsResultUnmarshaller());
return (PartListing)client.execute(httpRequest, responseHandler, errorResponseHandler);
}
/* (non-Javadoc)
* @see com.amazonaws.services.s3.AmazonS3#uploadPart(com.amazonaws.services.s3.model.UploadPartRequest)
*/
public UploadPartResult uploadPart(UploadPartRequest uploadPartRequest)
throws AmazonClientException, AmazonServiceException {
assertParameterNotNull(uploadPartRequest,
"The request parameter must be specified when uploading a part");
String bucketName = uploadPartRequest.getBucketName();
String key = uploadPartRequest.getKey();
String uploadId = uploadPartRequest.getUploadId();
int partNumber = uploadPartRequest.getPartNumber();
long partSize = uploadPartRequest.getPartSize();
assertParameterNotNull(bucketName,
"The bucket name parameter must be specified when uploading a part");
assertParameterNotNull(key,
"The key parameter must be specified when uploading a part");
assertParameterNotNull(uploadId,
"The upload ID parameter must be specified when uploading a part");
assertParameterNotNull(partNumber,
"The part number parameter must be specified when uploading a part");
assertParameterNotNull(partSize,
"The part size parameter must be specified when uploading a part");
Request<Void> request = createRequest(bucketName, key, uploadPartRequest);
request.addParameter("uploadId", uploadId);
request.addParameter("partNumber", Integer.toString(partNumber));
if (uploadPartRequest.getMd5Digest() != null)
request.addHeader(Headers.CONTENT_MD5, uploadPartRequest.getMd5Digest());
signRequest(request, HttpMethodName.PUT, bucketName, key);
HttpRequest httpRequest = convertToHttpRequest(request, HttpMethodName.PUT);
httpRequest.addHeader(Headers.CONTENT_LENGTH, Long.toString(partSize));
InputStream inputStream = null;
if (uploadPartRequest.getInputStream() != null) {
inputStream = uploadPartRequest.getInputStream();
} else if (uploadPartRequest.getFile() != null) {
try {
inputStream = new InputSubstream(new FileInputStream(uploadPartRequest.getFile()),
uploadPartRequest.getFileOffset(), partSize);
} catch (FileNotFoundException e) {
throw new IllegalArgumentException("The specified file doesn't exist", e);
}
} else {
throw new IllegalArgumentException("A File or InputStream must be specified when uploading part");
}
ProgressListener progressListener = uploadPartRequest.getProgressListener();
if (progressListener != null) {
inputStream = new ProgressReportingInputStream(inputStream, progressListener);
fireProgressEvent(progressListener, ProgressEvent.PART_STARTED_EVENT_CODE);
}
try {
httpRequest.setContent(inputStream);
S3MetadataResponseHandler responseHandler = new S3MetadataResponseHandler();
ObjectMetadata metadata = client.execute(httpRequest, responseHandler, errorResponseHandler);
fireProgressEvent(progressListener, ProgressEvent.PART_COMPLETED_EVENT_CODE);
UploadPartResult result = new UploadPartResult();
result.setETag(metadata.getETag());
result.setPartNumber(partNumber);
return result;
} catch (AmazonClientException ace) {
fireProgressEvent(progressListener, ProgressEvent.PART_FAILED_EVENT_CODE);
throw ace;
} finally {
if (inputStream != null) {
try {inputStream.close();}
catch (Exception e) {}
}
}
}
/* (non-Javadoc)
* @see com.amazonaws.services.s3.AmazonS3#getResponseMetadataForRequest(com.amazonaws.AmazonWebServiceRequest)
*/
public S3ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request) {
return (S3ResponseMetadata)client.getResponseMetadataForRequest(request);
}
/*
* Private Interface
*/
/**
* <p>
* Asserts that the specified parameter value is not <code>null</code> and if it is,
* throws an <code>IllegalArgumentException</code> with the specified error message.
* </p>
*
* @param parameterValue
* The parameter value being checked.
* @param errorMessage
* The error message to include in the IllegalArgumentException
* if the specified parameter is null.
*/
private void assertParameterNotNull(Object parameterValue, String errorMessage) {
if (parameterValue == null) throw new IllegalArgumentException(errorMessage);
}
/**
* Fires a progress event with the specified event type to the specified
* listener.
*
* @param listener
* The listener to receive the event.
* @param eventType
* The type of event to fire.
*/
private void fireProgressEvent(ProgressListener listener, int eventType) {
if (listener == null) return;
ProgressEvent event = new ProgressEvent(0);
event.setEventCode(eventType);
listener.progressChanged(event);
}
/**
* <p>
* Gets the Amazon S3 {@link AccessControlList} (ACL) for the specified resource.
* (bucket if only the bucketName parameter is specified, otherwise the object with the
* specified key in the bucket).
* </p>
*
* @param bucketName
* The name of the bucket whose ACL should be returned if the key
* parameter is not specified, otherwise the bucket containing
* the specified key.
* @param key
* The object key whose ACL should be retrieve. If not specified,
* the bucket's ACL is returned.
* @param versionId
* The version ID of the object version whose ACL is being
* retrieved.
*
* @return The S3 ACL for the specified resource.
*/
private AccessControlList getAcl(String bucketName, String key, String versionId) {
Request<Void> request = createRequest(bucketName, key, null);
request.addParameter("acl", null);
if (versionId != null) request.addParameter("versionId", versionId);
signRequest(request, HttpMethodName.GET, bucketName, key);
HttpRequest httpRequest = convertToHttpRequest(request, HttpMethodName.GET);
S3XmlResponseHandler<AccessControlList> responseHandler =
new S3XmlResponseHandler<AccessControlList>(new Unmarshallers.AccessControlListUnmarshaller());
return (AccessControlList)client.execute(httpRequest, responseHandler, errorResponseHandler);
}
/**
* Creates and initializes a new request object for the specified S3
* resource. This method is responsible for determining the right way to
* address resources. For example, bucket names that are not DNS addressable
* cannot be addressed in V2, virtual host, style, and instead must use V1,
* path style. The returned request object has the service name, endpoint
* and resource path correctly populated. Callers can take the request, add
* any additional headers or parameters, then sign and execute the request.
*
* @param bucketName
* An optional parameter indicating the name of the bucket
* containing the resource involved in the request.
* @param key
* An optional parameter indicating the key under which the
* desired resource is stored in the specified bucket.
* @param originalRequest
* The original request, as created by the user.
*
* @return A new request object, populated with endpoint, resource path, and
* service name, ready for callers to populate any additional
* headers or parameters, and execute.
*/
protected Request<Void> createRequest(String bucketName, String key, AmazonWebServiceRequest originalRequest) {
Request<Void> request = new DefaultRequest<Void>(originalRequest, Constants.S3_SERVICE_NAME);
if (bucketNameUtils.isValidV2BucketName(bucketName)) {
request.setEndpoint(convertToVirtualHostEndpoint(bucketName));
request.setResourcePath(ServiceUtils.urlEncode(key));
} else {
request.setEndpoint(endpoint);
if (bucketName != null) {
/*
* We don't URL encode the bucket name, since it shouldn't
* contain any characters that need to be encoded based on
* Amazon S3's naming restrictions.
*/
request.setResourcePath(bucketName + "/"
+ (key != null ? ServiceUtils.urlEncode(key) : ""));
}
}
return request;
}
/**
* Sets the Canned ACL for the specified resource in S3. If only bucketName
* is specified, the canned ACL will be applied to the bucket, otherwise if
* bucketName and key are specified, the canned ACL will be applied to the
* object.
*
* @param bucketName
* The name of the bucket containing the specified key, or if no
* key is listed, the bucket whose ACL will be set.
* @param key
* The optional object key within the specified bucket whose ACL
* will be set. If not specified, the bucket ACL will be set.
* @param versionId
* The version ID of the object version whose ACL is being set.
* @param cannedAcl
* The canned ACL to apply to the resource.
*/
private void setAcl(String bucketName, String key, String versionId, CannedAccessControlList cannedAcl) {
Request<Void> request = createRequest(bucketName, key, null);
request.addParameter("acl", null);
request.addHeader(Headers.S3_CANNED_ACL, cannedAcl.toString());
if (versionId != null) request.addParameter("versionId", versionId);
signRequest(request, HttpMethodName.PUT, bucketName, key);
HttpRequest httpRequest = convertToHttpRequest(request, HttpMethodName.PUT);
client.execute(httpRequest, voidResponseHandler, errorResponseHandler);
}
/**
* Sets the ACL for the specified resource in S3. If only bucketName is
* specified, the ACL will be applied to the bucket, otherwise if bucketName
* and key are specified, the ACL will be applied to the object.
*
* @param bucketName
* The name of the bucket containing the specified key, or if no
* key is listed, the bucket whose ACL will be set.
* @param key
* The optional object key within the specified bucket whose ACL
* will be set. If not specified, the bucket ACL will be set.
* @param versionId
* The version ID of the object version whose ACL is being set.
* @param acl
* The ACL to apply to the resource.
*/
private void setAcl(String bucketName, String key, String versionId, AccessControlList acl) {
Request<Void> request = createRequest(bucketName, key, null);
request.addParameter("acl", null);
if (versionId != null) request.addParameter("versionId", versionId);
byte[] aclAsXml = new AclXmlFactory().convertToXmlByteArray(acl);
request.addHeader("Content-Type", "text/plain");
request.addHeader("Content-Length", String.valueOf(aclAsXml.length));
signRequest(request, HttpMethodName.PUT, bucketName, key);
HttpRequest httpRequest = convertToHttpRequest(request, HttpMethodName.PUT);
httpRequest.setContent(new ByteArrayInputStream(aclAsXml));
client.execute(httpRequest, voidResponseHandler, errorResponseHandler);
}
/**
* Signs the specified request.
*
* @param request
* The request to sign.
* @param methodName
* The HTTP method (GET, PUT, DELETE, HEAD) for the specified
* request.
* @param bucketName
* The name of the bucket involved in the request. If the request
* is not an operation on a bucket this parameter should be null.
* @param key
* The object key involved in the request. If the request is not
* an operation on an object, this parameter should be null.
*/
protected <T> void signRequest(Request<T> request, HttpMethodName methodName, String bucketName, String key) {
// Run any additional request handlers if necessary
if (requestHandlers != null) {
for (RequestHandler requestHandler : requestHandlers) {
request = requestHandler.handleRequest(request);
}
}
// Nothing to sign if the client is anonymous and we have no credentials
if (awsCredentials == null) return;
/*
* The string we sign needs to include the exact headers that we
* send with the request, but the client runtime layer adds the
* Content-Type header before the request is sent if one isn't set, so
* we have to set something here otherwise the request will fail.
*/
if (request.getHeaders().get("Content-Type") == null) {
request.addHeader("Content-Type", "application/x-www-form-urlencoded; charset=utf-8");
}
try {
String resourcePath =
"/" +
((bucketName != null) ? bucketName + "/" : "") +
((key != null) ? ServiceUtils.urlEncode(key) : "");
new S3Signer(awsCredentials, methodName.toString(), resourcePath).sign(request, null, null);
} catch (SignatureException e) {
throw new AmazonClientException("Unable to sign request: " + e.getMessage(), e);
}
}
/**
* Pre-signs the specified request, using a signature query-string
* parameter.
*
* @param request
* The request to sign.
* @param methodName
* The HTTP method (GET, PUT, DELETE, HEAD) for the specified
* request.
* @param bucketName
* The name of the bucket involved in the request. If the request
* is not an operation on a bucket this parameter should be null.
* @param key
* The object key involved in the request. If the request is not
* an operation on an object, this parameter should be null.
* @param expiration
* The time at which the signed request is no longer valid, and
* will stop working.
* @param subResource
* The optional sub-resource being requested as part of the
* request (e.g. "location", "acl", "logging", or "torrent").
*/
private <T> void presignRequest(Request<T> request, HttpMethod methodName,
String bucketName, String key, Date expiration, String subResource) {
// Run any additional request handlers if necessary
if (requestHandlers != null) {
for (RequestHandler requestHandler : requestHandlers) {
request = requestHandler.handleRequest(request);
}
}
try {
String resourcePath =
"/" +
((bucketName != null) ? bucketName + "/" : "") +
((key != null) ? ServiceUtils.urlEncode(key) : "") +
((subResource != null) ? "?" + subResource : "");
new S3QueryStringSigner<T>(awsCredentials, methodName.toString(), resourcePath, expiration).sign(request);
} catch (SignatureException e) {
throw new AmazonClientException("Unable to sign request: " + e.getMessage(), e);
}
// The Amazon S3 DevPay token header is a special exception and can be safely moved
// from the request's headers into the query string to ensure that it travels along
// with the pre-signed URL when it's sent back to Amazon S3.
if (request.getHeaders().containsKey(Headers.SECURITY_TOKEN)) {
String value = request.getHeaders().get(Headers.SECURITY_TOKEN);
request.addParameter(Headers.SECURITY_TOKEN, value);
request.getHeaders().remove(Headers.SECURITY_TOKEN);
}
}
/**
* Converts the current endpoint set for this client into virtual addressing
* style, by placing the name of the specified bucket before the S3 service
* endpoint.
*
* @param bucketName
* The name of the bucket to use in the virtual addressing style
* of the returned URI.
*
* @return A new URI, creating from the current service endpoint URI and the
* specified bucket.
*/
private URI convertToVirtualHostEndpoint(String bucketName) {
try {
return new URI(endpoint.getScheme() + "://" + bucketName + "." + endpoint.getAuthority());
} catch (URISyntaxException e) {
throw new AmazonClientException("Can't turn bucket name into a URI: " + e.getMessage(), e);
}
}
/**
* <p>
* Populates the specified request object with the appropriate headers from
* the {@link ObjectMetadata} object.
* </p>
*
* @param request
* The request to populate with headers.
* @param metadata
* The metadata containing the header information to include in
* the request.
*/
protected static void populateRequestMetadata(Request<Void> request, ObjectMetadata metadata) {
Map<String, Object> rawMetadata = metadata.getRawMetadata();
if (rawMetadata != null) {
for (Entry<String, Object> entry : rawMetadata.entrySet()) {
request.addHeader(entry.getKey(), entry.getValue().toString());
}
}
Map<String, String> userMetadata = metadata.getUserMetadata();
if (userMetadata != null) {
for (Entry<String, String> entry : userMetadata.entrySet()) {
request.addHeader(Headers.S3_USER_METADATA_PREFIX + entry.getKey(), entry.getValue());
}
}
}
/**
* <p>
* Populates the specified request with the specified Multi-Factor
* Authentication (MFA) details. This includes the MFA header with device serial
* number and generated token. Since all requests which include the MFA
* header must be sent over HTTPS, this operation also configures the request object to
* use HTTPS instead of HTTP.
* </p>
*
* @param request
* The request to populate.
* @param mfa
* The Multi-Factor Authentication information.
*/
private void populateRequestWithMfaDetails(Request<Void> request, MultiFactorAuthentication mfa) {
if (mfa == null) return;
String endpoint = request.getEndpoint().toString();
if (endpoint.startsWith("http://")) {
String httpsEndpoint = endpoint.replace("http://", "https://");
request.setEndpoint(URI.create(httpsEndpoint));
log.info("Overriding current endpoint to use HTTPS " +
"as required by S3 for requests containing an MFA header");
}
request.addHeader(Headers.S3_MFA,
mfa.getDeviceSerialNumber() + " " + mfa.getToken());
}
/**
* <p>
* Populates the specified request with the numerous options available in
* <code>CopyObjectRequest</code>.
* </p>
*
* @param request
* The request to populate with headers to represent all the
* options expressed in the <code>CopyObjectRequest</code> object.
* @param copyObjectRequest
* The object containing all the options for copying an object in
* Amazon S3.
*/
private static void populateRequestWithCopyObjectParameters(Request<Void> request, CopyObjectRequest copyObjectRequest) {
String copySourceHeader =
"/" + ServiceUtils.urlEncode(copyObjectRequest.getSourceBucketName())
+ "/" + ServiceUtils.urlEncode(copyObjectRequest.getSourceKey());
if (copyObjectRequest.getSourceVersionId() != null) {
copySourceHeader += "?versionId=" + copyObjectRequest.getSourceVersionId();
}
request.addHeader("x-amz-copy-source", copySourceHeader);
addDateHeader(request, Headers.COPY_SOURCE_IF_MODIFIED_SINCE,
copyObjectRequest.getModifiedSinceConstraint());
addDateHeader(request, Headers.COPY_SOURCE_IF_UNMODIFIED_SINCE,
copyObjectRequest.getUnmodifiedSinceConstraint());
addStringListHeader(request, Headers.COPY_SOURCE_IF_MATCH,
copyObjectRequest.getMatchingETagConstraints());
addStringListHeader(request, Headers.COPY_SOURCE_IF_NO_MATCH,
copyObjectRequest.getNonmatchingETagConstraints());
if (copyObjectRequest.getCannedAccessControlList() != null) {
request.addHeader(Headers.S3_CANNED_ACL,
copyObjectRequest.getCannedAccessControlList().toString());
}
if (copyObjectRequest.getStorageClass() != null) {
request.addHeader(Headers.STORAGE_CLASS, copyObjectRequest.getStorageClass());
}
ObjectMetadata newObjectMetadata = copyObjectRequest.getNewObjectMetadata();
if (newObjectMetadata != null) {
request.addHeader(Headers.METADATA_DIRECTIVE, "REPLACE");
populateRequestMetadata(request, newObjectMetadata);
}
}
/**
* <p>
* Adds the specified date header in RFC 822 date format to the specified
* request.
* This method will not add a date header if the specified date value is <code>null</code>.
* </p>
*
* @param request
* The request to add the header to.
* @param header
* The header name.
* @param value
* The header value.
*/
private static void addDateHeader(Request<?> request, String header, Date value) {
if (value != null) {
request.addHeader(header, ServiceUtils.formatRfc822Date(value));
}
}
/**
* <p>
* Adds the specified string list header, joined together separated with
* commas, to the specified request.
* This method will not add a string list header if the specified values
* are <code>null</code> or empty.
* </p>
*
* @param request
* The request to add the header to.
* @param header
* The header name.
* @param values
* The list of strings to join together for the header value.
*/
private static void addStringListHeader(Request<?> request, String header, List<String> values) {
if (values != null && !values.isEmpty()) {
request.addHeader(header, ServiceUtils.join(values));
}
}
}