org.mule.extension.s3.internal.operation.bucket

Class BucketOperations

java.lang.Object

org.mule.connectors.commons.template.operation.ConnectorOperations<CONFIG,CONNECTION,SERVICE>

org.mule.extension.aws.commons.internal.operation.AWSOperations<S3Configuration,S3Connection,S>

org.mule.extension.s3.internal.operation.S3Operations<BucketService>

org.mule.extension.s3.internal.operation.bucket.BucketOperations

@Throws(value=S3ErrorTypeProvider.class)
public class BucketOperations
extends S3Operations<BucketService>

Field Summary

Fields inherited from class org.mule.extension.s3.internal.operation.S3Operations

DEFAULT_CANNED_ACL, NOT_ENCODED, REGION_DEFAULT

Constructor Summary

Constructors

Constructor and Description
BucketOperations()

Method Summary

Modifier and Type	Method and Description
Bucket	createBucket(S3Configuration config, S3Connection connection, String bucketName, String region, CannedAccessControlList acl) Creates a new bucket; connector must not be configured as anonymous for this operation to succeed.
void	deleteBucket(S3Configuration config, S3Connection connection, String bucketName, boolean force) Deletes the specified bucket.
void	deleteBucketPolicy(S3Configuration config, S3Connection connection, String bucketName) Deletes the bucket's policy.
org.mule.runtime.extension.api.runtime.operation.Result<List<Grant>,AccessControlListAttributes>	getBucketAcl(S3Configuration config, S3Connection connection, String bucketName) Answers the access control list of the specified bucket.
String	getBucketLocation(S3Configuration config, S3Connection connection, String bucketName) Gets the geographical region where Amazon S3 stores the specified bucket.
String	getBucketPolicy(S3Configuration config, S3Connection connection, String bucketName) Answers the policy for the given bucket.
List<Bucket>	listBuckets(S3Configuration config, S3Connection connection, String region) Answers a list of all Amazon S3 buckets that the authenticated sender of the request owns.
void	setBucketAcl(S3Configuration config, S3Connection connection, String bucketName, Owner owner, List<Grant> grants) Set the permissions on an existing bucket using access control lists (ACL)
void	setBucketPolicy(S3Configuration config, S3Connection connection, String bucketName, String policyText) Sets the bucket's policy, overriding any previously set.

Methods inherited from class org.mule.extension.aws.commons.internal.operation.AWSOperations

newExecutionBuilder

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BucketOperations

public BucketOperations()

Method Detail

createBucket

public Bucket createBucket(@Config
                           S3Configuration config,
                           @Connection
                           S3Connection connection,
                           String bucketName,
                           @Optional(defaultValue="US_STANDARD") @OfValues(value=RegionValueProvider.class)
                           String region,
                           @DisplayName(value="Canned ACL") @Optional(defaultValue="PRIVATE")
                           CannedAccessControlList acl)

Creates a new bucket; connector must not be configured as anonymous for this operation to succeed. Bucket names must be unique across all of Amazon S3, that is, among all their users. Bucket ownership is similar to the ownership of Internet domain names. Within Amazon S3, only a single user owns each bucket. Once a uniquely named bucket is created in Amazon S3, organize and name the objects within the bucket in any way. Ownership of the bucket is retained as long as the owner has an Amazon S3 account. To conform with DNS requirements, buckets names must: not contain underscores, be between 3 and 63 characters long, not end with a dash, not contain adjacent periods, not contain dashes next to periods and not contain uppercase characters. Do not make bucket create or delete calls in the high availability code path of an application. Create or delete buckets in a separate initialization or setup.

Parameters:

config - Configuration for Amazon S3 connector.

connection - Amazon S3 connection instance.

bucketName - The bucket to create. It must not exist yet.

region - the region where to create the new bucket

acl - the access control list of the new bucket

Returns:

the non null, new Bucket

deleteBucket

public void deleteBucket(@Config
                         S3Configuration config,
                         @Connection
                         S3Connection connection,
                         String bucketName,
                         @Summary(value="Optional true if the bucket must be deleted even if it is not empty, false if operation should fail in such scenario.") @Optional(defaultValue="false")
                         boolean force)

Deletes the specified bucket. All objects (and all object versions, if versioning was ever enabled) in the bucket must be deleted before the bucket itself can be deleted; this restriction can be relaxed by specifying the attribute force="true".

Parameters:

config - Configuration for Amazon S3 connector.

connection - Amazon S3 connection instance.

bucketName - the bucket to delete

force - optional true if the bucket must be deleted even if it is not empty, false if operation should fail in such scenario.

listBuckets

public List<Bucket> listBuckets(@Config
                                S3Configuration config,
                                @Connection
                                S3Connection connection,
                                @Optional @OfValues(value=RegionValueProvider.class)
                                String region)

Answers a list of all Amazon S3 buckets that the authenticated sender of the request owns. Users must authenticate with a valid AWS Access Key ID that is registered with Amazon S3. Anonymous requests cannot list buckets, and users cannot list buckets that they did not create.

Parameters:

config - Configuration for Amazon S3 connector.

connection - Amazon S3 connection instance.

region - the region from where to list the buckets.

Returns:

A list of all of the Amazon S3 buckets owned by the authenticated sender of the request for the specified region, if no region mentioned, lists buckets from all regions.

getBucketLocation

@MediaType(value="application/plain")
public String getBucketLocation(@Config
                                                                      S3Configuration config,
                                                                      @Connection
                                                                      S3Connection connection,
                                                                      String bucketName)

Gets the geographical region where Amazon S3 stores the specified bucket.

Parameters:

config - Configuration for Amazon S3 connector.

connection - Amazon S3 connection instance.

bucketName - The target bucket name.

Returns:

the location of the specified Amazon S3 bucket.

getBucketPolicy

@MediaType(value="text/plain")
public String getBucketPolicy(@Config
                                                             S3Configuration config,
                                                             @Connection
                                                             S3Connection connection,
                                                             String bucketName)

Answers the policy for the given bucket. Only the owner of the bucket can retrieve it. If no policy has been set for the bucket, then a null policy text field will be returned.

Parameters:

config - Configuration for Amazon S3 connector.

connection - Amazon S3 connection instance.

bucketName - the bucket whose policy to retrieve

Returns:

the bucket policy, or null, if not set

deleteBucketPolicy

public void deleteBucketPolicy(@Config
                               S3Configuration config,
                               @Connection
                               S3Connection connection,
                               String bucketName)

Deletes the bucket's policy. Only the owner of the bucket can delete the bucket policy. Bucket policies provide access control management at the bucket level for both the bucket resource and contained object resources.

Parameters:

config - Configuration for Amazon S3 connector.

connection - Amazon S3 connection instance.

bucketName - the bucket whose policy to delete

setBucketPolicy

public void setBucketPolicy(@Config
                            S3Configuration config,
                            @Connection
                            S3Connection connection,
                            String bucketName,
                            @Content @Text
                            String policyText)

Sets the bucket's policy, overriding any previously set. Only the owner of the bucket can set a bucket policy. Bucket policies provide access control management at the bucket level for both the bucket resource and contained object resources. Only one policy can be specified per-bucket.

Parameters:

config - Configuration for Amazon S3 connector.

connection - Amazon S3 connection instance.

bucketName - the bucket name

policyText - the policy text

getBucketAcl

public org.mule.runtime.extension.api.runtime.operation.Result<List<Grant>,AccessControlListAttributes> getBucketAcl(@Config
                                                                                                                     S3Configuration config,
                                                                                                                     @Connection
                                                                                                                     S3Connection connection,
                                                                                                                     String bucketName)

Answers the access control list of the specified bucket.

Parameters:

config - Configuration for Amazon S3 connector.

connection - Amazon S3 connection instance.

bucketName - the bucket whose acl to retrieve.

Returns:

The List of Grants and the Owner.

setBucketAcl

public void setBucketAcl(@Config
                         S3Configuration config,
                         @Connection
                         S3Connection connection,
                         String bucketName,
                         Owner owner,
                         @Content
                         List<Grant> grants)

Set the permissions on an existing bucket using access control lists (ACL)

Parameters:

config - Configuration for Amazon S3 connector.

connection - Amazon S3 connection instance.

bucketName - the bucket name

owner - The owner of the ACL.

grants - The grants of the ACL.