| /** |
| * Licensed to jclouds, Inc. (jclouds) under one or more |
| * contributor license agreements. See the NOTICE file |
| * distributed with this work for additional information |
| * regarding copyright ownership. jclouds licenses this file |
| * to you under the Apache License, Version 2.0 (the |
| * "License"); you may not use this file except in compliance |
| * with the License. You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, |
| * software distributed under the License 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 org.jclouds.aws.s3; |
| |
| import static org.jclouds.blobstore.attr.BlobScopes.CONTAINER; |
| |
| import java.util.Map; |
| |
| import org.jclouds.javax.annotation.Nullable; |
| import javax.ws.rs.DELETE; |
| import javax.ws.rs.GET; |
| import javax.ws.rs.POST; |
| import javax.ws.rs.PUT; |
| import javax.ws.rs.Path; |
| import javax.ws.rs.PathParam; |
| import javax.ws.rs.QueryParam; |
| |
| import org.jclouds.aws.s3.binders.BindObjectMetadataToRequest; |
| import org.jclouds.aws.s3.binders.BindPartIdsAndETagsToRequest; |
| import org.jclouds.aws.s3.functions.ETagFromHttpResponseViaRegex; |
| import org.jclouds.aws.s3.functions.ObjectMetadataKey; |
| import org.jclouds.aws.s3.functions.UploadIdFromHttpResponseViaRegex; |
| import org.jclouds.blobstore.attr.BlobScope; |
| import org.jclouds.http.functions.ParseETagHeader; |
| import org.jclouds.io.Payload; |
| import org.jclouds.rest.annotations.BinderParam; |
| import org.jclouds.rest.annotations.Endpoint; |
| import org.jclouds.rest.annotations.ExceptionParser; |
| import org.jclouds.rest.annotations.ParamParser; |
| import org.jclouds.rest.annotations.ParamValidators; |
| import org.jclouds.rest.annotations.QueryParams; |
| import org.jclouds.rest.annotations.RequestFilters; |
| import org.jclouds.rest.annotations.ResponseParser; |
| import org.jclouds.rest.annotations.SkipEncoding; |
| import org.jclouds.rest.annotations.XMLResponseParser; |
| import org.jclouds.rest.functions.ReturnVoidOnNotFoundOr404; |
| import org.jclouds.s3.Bucket; |
| import org.jclouds.s3.S3AsyncClient; |
| import org.jclouds.s3.S3Client; |
| import org.jclouds.s3.binders.BindAsHostPrefixIfConfigured; |
| import org.jclouds.s3.domain.ObjectMetadata; |
| import org.jclouds.s3.filters.RequestAuthorizeSignature; |
| import org.jclouds.s3.functions.BindRegionToXmlPayload; |
| import org.jclouds.s3.functions.ReturnFalseIfBucketAlreadyOwnedByYouOrIllegalState; |
| import org.jclouds.s3.options.PutBucketOptions; |
| import org.jclouds.s3.options.PutObjectOptions; |
| import org.jclouds.s3.predicates.validators.BucketNameValidator; |
| import org.jclouds.s3.xml.LocationConstraintHandler; |
| |
| import com.google.common.util.concurrent.ListenableFuture; |
| |
| /** |
| * Provides access to amazon-specific S3 features |
| * |
| * @author Adrian Cole |
| */ |
| @SkipEncoding('/') |
| @RequestFilters(RequestAuthorizeSignature.class) |
| @BlobScope(CONTAINER) |
| public interface AWSS3AsyncClient extends S3AsyncClient { |
| /** |
| * @see S3Client#putBucketInRegion |
| */ |
| @Override |
| @PUT |
| @Path("/") |
| @Endpoint(Bucket.class) |
| @ExceptionParser(ReturnFalseIfBucketAlreadyOwnedByYouOrIllegalState.class) |
| ListenableFuture<Boolean> putBucketInRegion( |
| @BinderParam(BindRegionToXmlPayload.class) @Nullable String region, |
| @Bucket @BinderParam(BindAsHostPrefixIfConfigured.class) @ParamValidators({ BucketNameValidator.class }) String bucketName, |
| PutBucketOptions... options); |
| |
| /** |
| * @see S3Client#getBucketLocation |
| */ |
| @Override |
| @GET |
| @QueryParams(keys = "location") |
| @Path("/") |
| @Endpoint(Bucket.class) |
| @XMLResponseParser(LocationConstraintHandler.class) |
| ListenableFuture<String> getBucketLocation( |
| @Bucket @BinderParam(BindAsHostPrefixIfConfigured.class) @ParamValidators({ BucketNameValidator.class }) String bucketName); |
| |
| /** |
| * @see AWSS3Client#initiateMultipartUpload |
| */ |
| @POST |
| @QueryParams(keys = "uploads") |
| @Path("/{key}") |
| @ResponseParser(UploadIdFromHttpResponseViaRegex.class) |
| ListenableFuture<String> initiateMultipartUpload( |
| @Bucket @BinderParam(BindAsHostPrefixIfConfigured.class) @ParamValidators({ BucketNameValidator.class }) String bucketName, |
| @PathParam("key") @ParamParser(ObjectMetadataKey.class) @BinderParam(BindObjectMetadataToRequest.class) ObjectMetadata objectMetadata, |
| PutObjectOptions... options); |
| |
| /** |
| * @see AWSS3Client#abortMultipartUpload |
| */ |
| @DELETE |
| @Path("/{key}") |
| @ExceptionParser(ReturnVoidOnNotFoundOr404.class) |
| ListenableFuture<Void> abortMultipartUpload( |
| @Bucket @BinderParam(BindAsHostPrefixIfConfigured.class) @ParamValidators({ BucketNameValidator.class }) String bucketName, |
| @PathParam("key") String key, @QueryParam("uploadId") String uploadId); |
| |
| /** |
| * @see AWSS3Client#uploadPart |
| */ |
| @PUT |
| @Path("/{key}") |
| @ResponseParser(ParseETagHeader.class) |
| ListenableFuture<String> uploadPart( |
| @Bucket @BinderParam(BindAsHostPrefixIfConfigured.class) @ParamValidators({ BucketNameValidator.class }) String bucketName, |
| @PathParam("key") String key, @QueryParam("partNumber") int partNumber, |
| @QueryParam("uploadId") String uploadId, Payload part); |
| |
| /** |
| * @see AWSS3Client#completeMultipartUpload |
| */ |
| @POST |
| @Path("/{key}") |
| @ResponseParser(ETagFromHttpResponseViaRegex.class) |
| ListenableFuture<String> completeMultipartUpload( |
| @Bucket @BinderParam(BindAsHostPrefixIfConfigured.class) @ParamValidators({ BucketNameValidator.class }) String bucketName, |
| @PathParam("key") String key, @QueryParam("uploadId") String uploadId, |
| @BinderParam(BindPartIdsAndETagsToRequest.class) Map<Integer, String> parts); |
| |
| } |