org.jclouds.s3

Interface S3AsyncClient

All Known Subinterfaces:

AWSS3AsyncClient, WalrusAsyncClient

public interface S3AsyncClient

Provides asynchronous access to S3 via their REST API.

All commands return a ListenableFuture of the result from S3. Any exceptions incurred during processing will be backend in an ExecutionException as documented in Future.get().

Author:

Adrian Cole, James Murty

See Also:

S3Client,

Field Summary

Fields

Modifier and Type	Field and Description
static String	VERSION

Method Summary

Methods

Modifier and Type	Method and Description
com.google.common.util.concurrent.ListenableFuture<Boolean>	bucketExists(String bucketName)
com.google.common.util.concurrent.ListenableFuture<ObjectMetadata>	copyObject(String sourceBucket, String sourceObject, String destinationBucket, String destinationObject, CopyObjectOptions... options)
com.google.common.util.concurrent.ListenableFuture<Boolean>	deleteBucketIfEmpty(String bucketName)
com.google.common.util.concurrent.ListenableFuture<Void>	deleteObject(String bucketName, String key)
com.google.common.util.concurrent.ListenableFuture<Void>	disableBucketLogging(String bucketName)
com.google.common.util.concurrent.ListenableFuture<Void>	enableBucketLogging(String bucketName, BucketLogging logging)
com.google.common.util.concurrent.ListenableFuture<AccessControlList>	getBucketACL(String bucketName)
com.google.common.util.concurrent.ListenableFuture<String>	getBucketLocation(String bucketName)
com.google.common.util.concurrent.ListenableFuture<BucketLogging>	getBucketLogging(String bucketName)
com.google.common.util.concurrent.ListenableFuture<Payer>	getBucketPayer(String bucketName)
com.google.common.util.concurrent.ListenableFuture<S3Object>	getObject(String bucketName, String key, GetOptions... options)
com.google.common.util.concurrent.ListenableFuture<AccessControlList>	getObjectACL(String bucketName, String key)
com.google.common.util.concurrent.ListenableFuture<ObjectMetadata>	headObject(String bucketName, String key)
com.google.common.util.concurrent.ListenableFuture<ListBucketResponse>	listBucket(String bucketName, ListBucketOptions... options)
com.google.common.util.concurrent.ListenableFuture<? extends Set<BucketMetadata>>	listOwnedBuckets()
S3Object	newS3Object() Creates a default implementation of S3Object
com.google.common.util.concurrent.ListenableFuture<Boolean>	objectExists(String bucketName, String key)
com.google.common.util.concurrent.ListenableFuture<Boolean>	putBucketACL(String bucketName, AccessControlList acl)
com.google.common.util.concurrent.ListenableFuture<Boolean>	putBucketInRegion(String region, String bucketName, PutBucketOptions... options)
com.google.common.util.concurrent.ListenableFuture<String>	putObject(String bucketName, S3Object object, PutObjectOptions... options)
com.google.common.util.concurrent.ListenableFuture<Boolean>	putObjectACL(String bucketName, String key, AccessControlList acl)
com.google.common.util.concurrent.ListenableFuture<Void>	setBucketPayer(String bucketName, Payer payer)

Field Detail

VERSION

static final String VERSION

See Also:

Constant Field Values

Method Detail

newS3Object

@Provides
S3Object newS3Object()

Creates a default implementation of S3Object

getObject

@Named(value="s3:GetObject")
com.google.common.util.concurrent.ListenableFuture<S3Object> getObject(String bucketName,
                                                                           String key,
                                                                           GetOptions... options)

See Also:

S3Client.getObject(java.lang.String, java.lang.String, org.jclouds.http.options.GetOptions...)

headObject

@Named(value="s3:GetObject")
com.google.common.util.concurrent.ListenableFuture<ObjectMetadata> headObject(String bucketName,
                                                                                  String key)

See Also:

S3Client.headObject(java.lang.String, java.lang.String)

objectExists

@Named(value="s3:GetObject")
com.google.common.util.concurrent.ListenableFuture<Boolean> objectExists(String bucketName,
                                                                             String key)

See Also:

S3Client.objectExists(java.lang.String, java.lang.String)

deleteObject

@Named(value="s3:DeleteObject")
com.google.common.util.concurrent.ListenableFuture<Void> deleteObject(String bucketName,
                                                                          String key)

See Also:

S3Client.deleteObject(java.lang.String, java.lang.String)

putObject

@Named(value="s3:PutObject")
com.google.common.util.concurrent.ListenableFuture<String> putObject(String bucketName,
                                                                         S3Object object,
                                                                         PutObjectOptions... options)

See Also:

S3Client.putObject(java.lang.String, org.jclouds.s3.domain.S3Object, org.jclouds.s3.options.PutObjectOptions...)

putBucketInRegion

@Named(value="s3:CreateBucket")
com.google.common.util.concurrent.ListenableFuture<Boolean> putBucketInRegion(@Nullable
                                                                                  String region,
                                                                                  String bucketName,
                                                                                  PutBucketOptions... options)

See Also:

S3Client.putBucketInRegion(java.lang.String, java.lang.String, org.jclouds.s3.options.PutBucketOptions...)

deleteBucketIfEmpty

@Named(value="s3:DeleteBucket")
com.google.common.util.concurrent.ListenableFuture<Boolean> deleteBucketIfEmpty(String bucketName)

See Also:

S3Client.deleteBucketIfEmpty(java.lang.String)

bucketExists

@Named(value="s3:ListBucket")
com.google.common.util.concurrent.ListenableFuture<Boolean> bucketExists(String bucketName)

See Also:

S3Client.bucketExists(java.lang.String)

getBucketLocation

@Named(value="s3:GetBucketLocation")
com.google.common.util.concurrent.ListenableFuture<String> getBucketLocation(String bucketName)

See Also:

S3Client.getBucketLocation(java.lang.String)

getBucketPayer

@Named(value="s3:GetBucketRequestPayment")
com.google.common.util.concurrent.ListenableFuture<Payer> getBucketPayer(String bucketName)

See Also:

S3Client.getBucketPayer(java.lang.String)

setBucketPayer

@Named(value="s3:PutBucketRequestPayment")
com.google.common.util.concurrent.ListenableFuture<Void> setBucketPayer(String bucketName,
                                                                            Payer payer)

See Also:

S3Client.setBucketPayer(java.lang.String, org.jclouds.s3.domain.Payer)

listBucket

@Named(value="s3:ListBucket")
com.google.common.util.concurrent.ListenableFuture<ListBucketResponse> listBucket(String bucketName,
                                                                                      ListBucketOptions... options)

See Also:

S3Client.listBucket(java.lang.String, org.jclouds.s3.options.ListBucketOptions...)

listOwnedBuckets

@Named(value="s3:ListAllMyBuckets")
com.google.common.util.concurrent.ListenableFuture<? extends Set<BucketMetadata>> listOwnedBuckets()

See Also:

S3Client.listOwnedBuckets()

copyObject

@Named(value="s3:PutObject")
com.google.common.util.concurrent.ListenableFuture<ObjectMetadata> copyObject(String sourceBucket,
                                                                                  String sourceObject,
                                                                                  String destinationBucket,
                                                                                  String destinationObject,
                                                                                  CopyObjectOptions... options)

See Also:

S3Client.copyObject(java.lang.String, java.lang.String, java.lang.String, java.lang.String, org.jclouds.s3.options.CopyObjectOptions...)

getBucketACL

@Named(value="s3:GetBucketAcl")
com.google.common.util.concurrent.ListenableFuture<AccessControlList> getBucketACL(String bucketName)

See Also:

S3Client.getBucketACL(java.lang.String)

putBucketACL

@Named(value="s3:PutBucketAcl")
com.google.common.util.concurrent.ListenableFuture<Boolean> putBucketACL(String bucketName,
                                                                             AccessControlList acl)

See Also:

S3Client.putBucketACL(java.lang.String, org.jclouds.s3.domain.AccessControlList)

getObjectACL

@Named(value="s3:GetObjectAcl")
com.google.common.util.concurrent.ListenableFuture<AccessControlList> getObjectACL(String bucketName,
                                                                                       String key)

See Also:

S3Client.getObjectACL(java.lang.String, java.lang.String)

putObjectACL

@Named(value="s3:PutObjectAcl")
com.google.common.util.concurrent.ListenableFuture<Boolean> putObjectACL(String bucketName,
                                                                             String key,
                                                                             AccessControlList acl)

See Also:

S3Client.putObjectACL(java.lang.String, java.lang.String, org.jclouds.s3.domain.AccessControlList)

getBucketLogging

@Named(value="s3:GetBucketLogging")
com.google.common.util.concurrent.ListenableFuture<BucketLogging> getBucketLogging(String bucketName)

See Also:

S3Client.getBucketLogging(java.lang.String)

enableBucketLogging

@Named(value="s3:PutBucketLogging")
com.google.common.util.concurrent.ListenableFuture<Void> enableBucketLogging(String bucketName,
                                                                                 BucketLogging logging)

See Also:

S3Client.enableBucketLogging(java.lang.String, org.jclouds.s3.domain.BucketLogging)

disableBucketLogging

@Named(value="s3:PutBucketLogging")
com.google.common.util.concurrent.ListenableFuture<Void> disableBucketLogging(String bucketName)

See Also:

S3Client#putBucketLogging