com.github.abhinavmishra14.aws.s3.service

Interface AwsS3IamService

All Known Implementing Classes:

AwsS3IamServiceImpl

public interface AwsS3IamService

The Interface AwsS3IamService.
This service class will use the IAM Roles to perform the operations on S3 buckets.
SDK Location: http://mvnrepository.com/artifact/com.amazonaws/aws-java-sdk-core/1.10.2

Author:

Abhinav kumar mishra

Method Summary

Methods

Modifier and Type	Method and Description
boolean	checkBucketPermission(String bucketName, com.amazonaws.services.s3.model.Permission permission) Check bucket permission. If access to the given bucket is not valid then 'AccessDenied' error will be raised. Read ACP permission should be available to user who is trying to check permission on bucket.
boolean	checkObjectPermission(String bucketName, String key, com.amazonaws.services.s3.model.Permission permission) Check object permission. If object is not available in given bucket, an exception will be thrown
void	cleanAndDeleteBucket(String bucketName) Clean and delete bucket.
com.amazonaws.services.s3.model.Bucket	createBucket(String bucketName) Creates the bucket. A bucket is owned by the AWS account that created it.
com.amazonaws.services.s3.model.Bucket	createBucket(String bucketName, boolean isPublicAccessible) Creates the bucket. Permission set for a Bucket does NOT automatically propagate to files stored in that Bucket. A bucket is owned by the AWS account that created it.
com.amazonaws.services.s3.model.Bucket	createBucket(String bucketName, com.amazonaws.services.s3.model.CannedAccessControlList cannedAcl) Creates the bucket. A bucket is owned by the AWS account that created it.
com.amazonaws.services.s3.model.PutObjectResult	createDirectory(String bucketName, String dirName) Creates the directory.
com.amazonaws.services.s3.model.PutObjectResult	createDirectory(String bucketName, String dirName, boolean isPublicAccessible) Creates the directory. You can pass true/false flag to allow directories created in S3 to be publicly accessible.
com.amazonaws.services.s3.model.PutObjectResult	createDirectory(String bucketName, String dirName, com.amazonaws.services.s3.model.CannedAccessControlList cannedAcl) Creates the directory.
void	deleteBucket(String bucketName) Delete bucket.
void	deleteDirectory(String bucketName, String dirName) Delete directory.
void	deleteObject(String bucketName, String fileName) Delete object.
com.amazonaws.services.s3.model.DeleteObjectsResult	deleteObjects(String bucketName, List<com.amazonaws.services.s3.model.DeleteObjectsRequest.KeyVersion> keys) Delete objects.
com.amazonaws.services.s3.model.ObjectMetadata	downloadObject(String bucketName, String key, String filePath) Download object.
URL	generateObjectURL(String bucketName, String fileName) Generate object url.
String	generateObjectUrlAsString(String bucketName, String fileName) Generate object url as string.
List<com.amazonaws.services.s3.model.Bucket>	getAllBuckets() Gets the all buckets.
com.amazonaws.services.s3.model.AccessControlList	getBucketAccessControlList(String bucketName) Gets the bucket access control list. Provides opportunities to grant permissions and check permissions on bucket. If access to the given bucket is not valid then 'AccessDenied' error will be raised. Read ACP permission should be available to user who is trying to check permission on bucket.
List<com.amazonaws.services.s3.model.Grant>	getBucketPermissions(String bucketName) Gets the bucket permissions. Returns the list of Grant objects in this access control list (ACL). The Grant object has Permission object which tell what kind of permissions are available. and it has Grantee object which tell who are grantees. Following are permissions available: FullControl, Read, Write, ReadAcp, WriteAcp If access to the given bucket is not valid then 'AccessDenied' error will be raised.
com.amazonaws.services.s3.model.S3Object	getObject(com.amazonaws.services.s3.model.GetObjectRequest getObjRequest) Gets the object.
InputStream	getObject(String bucketName, String key) Gets the object.
boolean	hasFullControlPermission(String bucketName) Checks if the bucket has full control permission If access to the given bucket is not valid then 'AccessDenied' error will be raised. Read ACP permission should be available to user who is trying to check permission on bucket.
boolean	hasWritePermissionOnBucket(String bucketName) Checks for write permission on s3 bucket. It checks if user has write permissions on bucket or not, even if ReadACP is not granted.
boolean	isBucketExists(String bucketName) Checks if is bucket exists.
com.amazonaws.services.s3.transfer.Transfer	uploadDirectoryOrFile(String bucketName, File source, String virtualDirectoryKeyPrefix) Upload directory or file. S3 will overwrite any existing objects that happen to have the same key, just as when uploading individual files, so use with caution. This method will upload the files or directory to S3 asynchronously You can use Transfer returning object to check for progress, Usage: transfer.getProgress().getPercentTransferred() It is implemented via TransferManager TransferManager provides a simple API for uploading content to Amazon S3, and makes extensive use of Amazon S3 multipart uploads to achieve enhanced throughput, performance and reliability.
boolean	uploadDirectoryOrFileAndListenProgress(String bucketName, File source, String virtualDirectoryKeyPrefix) Upload directory or file and Listen Progress. S3 will overwrite any existing objects that happen to have the same key, just as when uploading individual files, so use with caution. This method will upload the files or directory to S3 and prints the progress. It is implemented via TransferManager TransferManager provides a simple API for uploading content to Amazon S3, and makes extensive use of Amazon S3 multipart uploads to achieve enhanced throughput, performance and reliability.
com.amazonaws.services.s3.transfer.Upload	uploadFileAsync(String bucketName, String fileName, File fileObj) Upload file async. S3 will overwrite any existing objects that happen to have the same key, just as when uploading individual files, so use with caution. This method will upload the file to S3 asynchronously You can use Upload returning object to check for progress Usage: upload.getProgress().getPercentTransferred() It is implemented via TransferManager TransferManager provides a simple API for uploading content to Amazon S3, and makes extensive use of Amazon S3 multipart uploads to achieve enhanced throughput, performance and reliability.
com.amazonaws.services.s3.transfer.Upload	uploadFileAsync(String bucketName, String fileName, File fileObj, boolean isPublicAccessible) Upload file async. S3 will overwrite any existing objects that happen to have the same key, just as when uploading individual files, so use with caution. This method will upload the file to S3 asynchronously You can use Upload returning object to check for progress Usage: upload.getProgress().getPercentTransferred() It is implemented via TransferManager TransferManager provides a simple API for uploading content to Amazon S3, and makes extensive use of Amazon S3 multipart uploads to achieve enhanced throughput, performance and reliability.
com.amazonaws.services.s3.transfer.Upload	uploadFileAsync(String bucketName, String fileName, File fileObj, com.amazonaws.services.s3.model.CannedAccessControlList cannedAcl) Upload file async. S3 will overwrite any existing objects that happen to have the same key, just as when uploading individual files, so use with caution. This method will upload the file to S3 asynchronously You can use Upload returning object to check for progress Usage: upload.getProgress().getPercentTransferred() It is implemented via TransferManager TransferManager provides a simple API for uploading content to Amazon S3, and makes extensive use of Amazon S3 multipart uploads to achieve enhanced throughput, performance and reliability.
com.amazonaws.services.s3.model.PutObjectResult	uploadObject(com.amazonaws.services.s3.model.PutObjectRequest putObjectRequest) Upload object.
com.amazonaws.services.s3.model.PutObjectResult	uploadObject(String bucketName, String fileName, InputStream inputStream) Upload object.
com.amazonaws.services.s3.model.PutObjectResult	uploadObject(String bucketName, String fileName, InputStream inputStream, boolean isPublicAccessible) Upload object. You can pass true/false flag to allow objects pushed to S3 to be publicly accessible.
com.amazonaws.services.s3.model.PutObjectResult	uploadObject(String bucketName, String fileName, InputStream inputStream, com.amazonaws.services.s3.model.CannedAccessControlList cannedAcl) Upload object.
boolean	uploadObjectAndListenProgress(String bucketName, String fileName, InputStream inputStream) Upload object and Listen progress. S3 will overwrite any existing objects that happen to have the same key, just as when uploading individual files, so use with caution. This method will upload the file to S3 and prints the progress. It is implemented via TransferManager TransferManager provides a simple API for uploading content to Amazon S3, and makes extensive use of Amazon S3 multipart uploads to achieve enhanced throughput, performance and reliability.
boolean	uploadObjectAndListenProgress(String bucketName, String fileName, InputStream inputStream, boolean isPublicAccessible) Upload object and Listen progress. S3 will overwrite any existing objects that happen to have the same key, just as when uploading individual files, so use with caution. This method will upload the file to S3 and prints the progress. It is implemented via TransferManager TransferManager provides a simple API for uploading content to Amazon S3, and makes extensive use of Amazon S3 multipart uploads to achieve enhanced throughput, performance and reliability.
boolean	uploadObjectAndListenProgress(String bucketName, String fileName, InputStream inputStream, com.amazonaws.services.s3.model.CannedAccessControlList cannedAcl) Upload object and Listen progress. S3 will overwrite any existing objects that happen to have the same key, just as when uploading individual files, so use with caution. This method will upload the file to S3 and prints the progress. It is implemented via TransferManager TransferManager provides a simple API for uploading content to Amazon S3, and makes extensive use of Amazon S3 multipart uploads to achieve enhanced throughput, performance and reliability.

Method Detail

getAllBuckets

List<com.amazonaws.services.s3.model.Bucket> getAllBuckets()
                                                           throws com.amazonaws.AmazonClientException,
                                                                  com.amazonaws.AmazonServiceException

Gets the all buckets.

Returns:

the all buckets

Throws:

com.amazonaws.AmazonClientException - the amazon client exception

com.amazonaws.AmazonServiceException - the amazon service exception

createBucket

com.amazonaws.services.s3.model.Bucket createBucket(String bucketName)
                                                    throws com.amazonaws.AmazonClientException,
                                                           com.amazonaws.AmazonServiceException

Creates the bucket.
A bucket is owned by the AWS account that created it. By default, you can create up to 100 buckets in each of your AWS accounts. If you need additional buckets, you can increase your bucket limit by submitting a service limit increase.

Parameters:

bucketName - the bucket name

Returns:

the bucket

Throws:

com.amazonaws.AmazonClientException - the amazon client exception

com.amazonaws.AmazonServiceException - the amazon service exception

createBucket

com.amazonaws.services.s3.model.Bucket createBucket(String bucketName,
                                                  com.amazonaws.services.s3.model.CannedAccessControlList cannedAcl)
                                                    throws com.amazonaws.AmazonClientException,
                                                           com.amazonaws.AmazonServiceException

Creates the bucket.
A bucket is owned by the AWS account that created it. By default, you can create up to 100 buckets in each of your AWS accounts. If you need additional buckets, you can increase your bucket limit by submitting a service limit increase.

Parameters:

bucketName - the bucket name

cannedAcl - the canned acl

Returns:

the bucket

Throws:

com.amazonaws.AmazonClientException - the amazon client exception

com.amazonaws.AmazonServiceException - the amazon service exception

See Also:

ACL Overview, Canned ACL

createBucket

com.amazonaws.services.s3.model.Bucket createBucket(String bucketName,
                                                  boolean isPublicAccessible)
                                                    throws com.amazonaws.AmazonClientException,
                                                           com.amazonaws.AmazonServiceException

Creates the bucket.
Permission set for a Bucket does NOT automatically propagate to files stored in that Bucket.
A bucket is owned by the AWS account that created it. By default, you can create up to 100 buckets in each of your AWS accounts. If you need additional buckets, you can increase your bucket limit by submitting a service limit increase.

Parameters:

bucketName - the bucket name

isPublicAccessible - the is public accessible

Returns:

the bucket

Throws:

com.amazonaws.AmazonClientException - the amazon client exception

com.amazonaws.AmazonServiceException - the amazon service exception

deleteBucket

void deleteBucket(String bucketName)
                  throws com.amazonaws.AmazonClientException,
                         com.amazonaws.AmazonServiceException

Delete bucket.

Parameters:

bucketName - the bucket name

Throws:

com.amazonaws.AmazonClientException - the amazon client exception

com.amazonaws.AmazonServiceException - the amazon service exception

cleanAndDeleteBucket

void cleanAndDeleteBucket(String bucketName)
                          throws com.amazonaws.AmazonClientException,
                                 com.amazonaws.AmazonServiceException

Clean and delete bucket.

Parameters:

bucketName - the bucket name

Throws:

com.amazonaws.AmazonClientException - the amazon client exception

com.amazonaws.AmazonServiceException - the amazon service exception

uploadObject

com.amazonaws.services.s3.model.PutObjectResult uploadObject(com.amazonaws.services.s3.model.PutObjectRequest putObjectRequest)
                                                             throws com.amazonaws.AmazonClientException,
                                                                    com.amazonaws.AmazonServiceException

Upload object.

Parameters:

putObjectRequest - the put object request

Returns:

the put object result

Throws:

com.amazonaws.AmazonClientException - the amazon client exception

com.amazonaws.AmazonServiceException - the amazon service exception

uploadObject

com.amazonaws.services.s3.model.PutObjectResult uploadObject(String bucketName,
                                                           String fileName,
                                                           InputStream inputStream)
                                                             throws com.amazonaws.AmazonClientException,
                                                                    com.amazonaws.AmazonServiceException,
                                                                    IOException

Upload object.

Parameters:

bucketName - the bucket name

fileName - the file name

inputStream - the input stream

Returns:

the put object result

Throws:

com.amazonaws.AmazonClientException - the amazon client exception

com.amazonaws.AmazonServiceException - the amazon service exception

IOException - Signals that an I/O exception has occurred.

uploadObject

com.amazonaws.services.s3.model.PutObjectResult uploadObject(String bucketName,
                                                           String fileName,
                                                           InputStream inputStream,
                                                           com.amazonaws.services.s3.model.CannedAccessControlList cannedAcl)
                                                             throws com.amazonaws.AmazonClientException,
                                                                    com.amazonaws.AmazonServiceException,
                                                                    IOException

Upload object.

Parameters:

bucketName - the bucket name

fileName - the file name

inputStream - the input stream

cannedAcl - the canned acl

Returns:

the put object result

Throws:

com.amazonaws.AmazonClientException - the amazon client exception

com.amazonaws.AmazonServiceException - the amazon service exception

IOException - Signals that an I/O exception has occurred.

See Also:

ACL Overview, Canned ACL

uploadObject

com.amazonaws.services.s3.model.PutObjectResult uploadObject(String bucketName,
                                                           String fileName,
                                                           InputStream inputStream,
                                                           boolean isPublicAccessible)
                                                             throws com.amazonaws.AmazonClientException,
                                                                    com.amazonaws.AmazonServiceException,
                                                                    IOException

Upload object.
You can pass true/false flag to allow objects pushed to S3 to be publicly accessible.

Parameters:

bucketName - the bucket name

fileName - the file name

inputStream - the input stream

isPublicAccessible - the is public accessible

Returns:

the put object result

Throws:

com.amazonaws.AmazonClientException - the amazon client exception

com.amazonaws.AmazonServiceException - the amazon service exception

IOException - Signals that an I/O exception has occurred.

uploadObjectAndListenProgress

boolean uploadObjectAndListenProgress(String bucketName,
                                    String fileName,
                                    InputStream inputStream)
                                      throws com.amazonaws.AmazonClientException,
                                             com.amazonaws.AmazonServiceException,
                                             IOException

Upload object and Listen progress.
S3 will overwrite any existing objects that happen to have the same key, just as when uploading individual files, so use with caution.
This method will upload the file to S3 and prints the progress.
It is implemented via TransferManager
TransferManager provides a simple API for uploading content to Amazon S3, and makes extensive use of Amazon S3 multipart uploads to achieve enhanced throughput, performance and reliability.
When possible, TransferManager attempts to use multiple threads to upload multiple parts of a single upload at once.
When dealing with large content sizes and high bandwidth, this can have a significant increase on throughput.

Parameters:

bucketName - the bucket name

fileName - the file name

inputStream - the input stream

Returns:

the boolean

Throws:

com.amazonaws.AmazonClientException - the amazon client exception

com.amazonaws.AmazonServiceException - the amazon service exception

IOException - Signals that an I/O exception has occurred.

uploadObjectAndListenProgress

boolean uploadObjectAndListenProgress(String bucketName,
                                    String fileName,
                                    InputStream inputStream,
                                    com.amazonaws.services.s3.model.CannedAccessControlList cannedAcl)
                                      throws com.amazonaws.AmazonClientException,
                                             com.amazonaws.AmazonServiceException,
                                             IOException

Upload object and Listen progress.
S3 will overwrite any existing objects that happen to have the same key, just as when uploading individual files, so use with caution.
This method will upload the file to S3 and prints the progress.
It is implemented via TransferManager
TransferManager provides a simple API for uploading content to Amazon S3, and makes extensive use of Amazon S3 multipart uploads to achieve enhanced throughput, performance and reliability.
When possible, TransferManager attempts to use multiple threads to upload multiple parts of a single upload at once.
When dealing with large content sizes and high bandwidth, this can have a significant increase on throughput.

Parameters:

bucketName - the bucket name

fileName - the file name

inputStream - the input stream

cannedAcl - the canned acl

Returns:

the boolean

Throws:

com.amazonaws.AmazonClientException - the amazon client exception

com.amazonaws.AmazonServiceException - the amazon service exception

IOException - Signals that an I/O exception has occurred.

See Also:

ACL Overview, Canned ACL

uploadObjectAndListenProgress

boolean uploadObjectAndListenProgress(String bucketName,
                                    String fileName,
                                    InputStream inputStream,
                                    boolean isPublicAccessible)
                                      throws com.amazonaws.AmazonClientException,
                                             com.amazonaws.AmazonServiceException,
                                             IOException

Upload object and Listen progress.
S3 will overwrite any existing objects that happen to have the same key, just as when uploading individual files, so use with caution.
This method will upload the file to S3 and prints the progress.
It is implemented via TransferManager
TransferManager provides a simple API for uploading content to Amazon S3, and makes extensive use of Amazon S3 multipart uploads to achieve enhanced throughput, performance and reliability.
When possible, TransferManager attempts to use multiple threads to upload multiple parts of a single upload at once.
When dealing with large content sizes and high bandwidth, this can have a significant increase on throughput.
You can pass true/false flag to allow objects pushed to S3 to be publicly accessible.

Parameters:

bucketName - the bucket name

fileName - the file name

inputStream - the input stream

isPublicAccessible - the is public accessible

Returns:

the boolean

Throws:

com.amazonaws.AmazonClientException - the amazon client exception

com.amazonaws.AmazonServiceException - the amazon service exception

IOException - Signals that an I/O exception has occurred.

uploadDirectoryOrFileAndListenProgress

boolean uploadDirectoryOrFileAndListenProgress(String bucketName,
                                             File source,
                                             String virtualDirectoryKeyPrefix)
                                               throws com.amazonaws.AmazonClientException,
                                                      com.amazonaws.AmazonServiceException,
                                                      FileNotFoundException

Upload directory or file and Listen Progress.
S3 will overwrite any existing objects that happen to have the same key, just as when uploading individual files, so use with caution.
This method will upload the files or directory to S3 and prints the progress.
It is implemented via TransferManager
TransferManager provides a simple API for uploading content to Amazon S3, and makes extensive use of Amazon S3 multipart uploads to achieve enhanced throughput, performance and reliability.
When possible, TransferManager attempts to use multiple threads to upload multiple parts of a single upload at once.
When dealing with large content sizes and high bandwidth, this can have a significant increase on throughput.

Parameters:

bucketName - the bucket name

source - the source fir or directory

virtualDirectoryKeyPrefix - the key prefix of the virtual directory to upload to. Use the null or empty string to upload files to the root of the bucket.

Returns:

the true or false

Throws:

com.amazonaws.AmazonClientException - the amazon client exception

com.amazonaws.AmazonServiceException - the amazon service exception

FileNotFoundException - the file not found exception

uploadFileAsync

com.amazonaws.services.s3.transfer.Upload uploadFileAsync(String bucketName,
                                                        String fileName,
                                                        File fileObj)
                                                          throws com.amazonaws.AmazonClientException,
                                                                 com.amazonaws.AmazonServiceException,
                                                                 IOException

Upload file async.
S3 will overwrite any existing objects that happen to have the same key, just as when uploading individual files, so use with caution.
This method will upload the file to S3 asynchronously
You can use Upload returning object to check for progress Usage: upload.getProgress().getPercentTransferred()
It is implemented via TransferManager
TransferManager provides a simple API for uploading content to Amazon S3, and makes extensive use of Amazon S3 multipart uploads to achieve enhanced throughput, performance and reliability.
When possible, TransferManager attempts to use multiple threads to upload multiple parts of a single upload at once.
When dealing with large content sizes and high bandwidth, this can have a significant increase on throughput.

Parameters:

bucketName - the bucket name

fileName - the file name

fileObj - the file object

Returns:

the upload

Throws:

com.amazonaws.AmazonClientException - the amazon client exception

com.amazonaws.AmazonServiceException - the amazon service exception

IOException - Signals that an I/O exception has occurred.

uploadFileAsync

com.amazonaws.services.s3.transfer.Upload uploadFileAsync(String bucketName,
                                                        String fileName,
                                                        File fileObj,
                                                        com.amazonaws.services.s3.model.CannedAccessControlList cannedAcl)
                                                          throws com.amazonaws.AmazonClientException,
                                                                 com.amazonaws.AmazonServiceException,
                                                                 IOException

Upload file async.
S3 will overwrite any existing objects that happen to have the same key, just as when uploading individual files, so use with caution.
This method will upload the file to S3 asynchronously
You can use Upload returning object to check for progress Usage: upload.getProgress().getPercentTransferred()
It is implemented via TransferManager
TransferManager provides a simple API for uploading content to Amazon S3, and makes extensive use of Amazon S3 multipart uploads to achieve enhanced throughput, performance and reliability.
When possible, TransferManager attempts to use multiple threads to upload multiple parts of a single upload at once.
When dealing with large content sizes and high bandwidth, this can have a significant increase on throughput.

Parameters:

bucketName - the bucket name

fileName - the file name

fileObj - the file object

cannedAcl - the canned acl

Returns:

the upload

Throws:

com.amazonaws.AmazonClientException - the amazon client exception

com.amazonaws.AmazonServiceException - the amazon service exception

IOException - Signals that an I/O exception has occurred.

See Also:

ACL Overview, Canned ACL

uploadFileAsync

com.amazonaws.services.s3.transfer.Upload uploadFileAsync(String bucketName,
                                                        String fileName,
                                                        File fileObj,
                                                        boolean isPublicAccessible)
                                                          throws com.amazonaws.AmazonClientException,
                                                                 com.amazonaws.AmazonServiceException,
                                                                 IOException

Upload file async.
S3 will overwrite any existing objects that happen to have the same key, just as when uploading individual files, so use with caution.
This method will upload the file to S3 asynchronously
You can use Upload returning object to check for progress Usage: upload.getProgress().getPercentTransferred()
It is implemented via TransferManager
TransferManager provides a simple API for uploading content to Amazon S3, and makes extensive use of Amazon S3 multipart uploads to achieve enhanced throughput, performance and reliability.
When possible, TransferManager attempts to use multiple threads to upload multiple parts of a single upload at once.
When dealing with large content sizes and high bandwidth, this can have a significant increase on throughput.
You can pass true/false flag to allow objects pushed to S3 to be publicly accessible.

Parameters:

bucketName - the bucket name

fileName - the file name

fileObj - the file object

isPublicAccessible - the is public accessible

Returns:

the upload

Throws:

com.amazonaws.AmazonClientException - the amazon client exception

com.amazonaws.AmazonServiceException - the amazon service exception

IOException - Signals that an I/O exception has occurred.

uploadDirectoryOrFile

com.amazonaws.services.s3.transfer.Transfer uploadDirectoryOrFile(String bucketName,
                                                                File source,
                                                                String virtualDirectoryKeyPrefix)
                                                                  throws com.amazonaws.AmazonClientException,
                                                                         com.amazonaws.AmazonServiceException,
                                                                         IOException

Upload directory or file.
S3 will overwrite any existing objects that happen to have the same key, just as when uploading individual files, so use with caution.
This method will upload the files or directory to S3 asynchronously
You can use Transfer returning object to check for progress, Usage: transfer.getProgress().getPercentTransferred()
It is implemented via TransferManager
TransferManager provides a simple API for uploading content to Amazon S3, and makes extensive use of Amazon S3 multipart uploads to achieve enhanced throughput, performance and reliability.
When possible, TransferManager attempts to use multiple threads to upload multiple parts of a single upload at once.
When dealing with large content sizes and high bandwidth, this can have a significant increase on throughput.

Parameters:

bucketName - the bucket name

source - the source fir or directory

virtualDirectoryKeyPrefix - the key prefix of the virtual directory to upload to. Use the null or empty string to upload files to the root of the bucket.

Returns:

the transfer

Throws:

com.amazonaws.AmazonClientException - the amazon client exception

com.amazonaws.AmazonServiceException - the amazon service exception

IOException - Signals that an I/O exception has occurred.

getObject

com.amazonaws.services.s3.model.S3Object getObject(com.amazonaws.services.s3.model.GetObjectRequest getObjRequest)
                                                   throws com.amazonaws.AmazonClientException,
                                                          com.amazonaws.AmazonServiceException

Gets the object.

Parameters:

getObjRequest - the get obj request

Returns:

the object

Throws:

com.amazonaws.AmazonClientException - the amazon client exception

com.amazonaws.AmazonServiceException - the amazon service exception

getObject

InputStream getObject(String bucketName,
                    String key)
                      throws com.amazonaws.AmazonClientException,
                             com.amazonaws.AmazonServiceException

Gets the object.

Parameters:

bucketName - the bucket name

key - the key

Returns:

the object

Throws:

com.amazonaws.AmazonClientException - the amazon client exception

com.amazonaws.AmazonServiceException - the amazon service exception

downloadObject

com.amazonaws.services.s3.model.ObjectMetadata downloadObject(String bucketName,
                                                            String key,
                                                            String filePath)
                                                              throws com.amazonaws.AmazonClientException,
                                                                     com.amazonaws.AmazonServiceException

Download object.

Parameters:

bucketName - the bucket name

key - the key

filePath - the file path

Returns:

the object metadata

Throws:

com.amazonaws.AmazonClientException - the amazon client exception

com.amazonaws.AmazonServiceException - the amazon service exception

createDirectory

com.amazonaws.services.s3.model.PutObjectResult createDirectory(String bucketName,
                                                              String dirName)
                                                                throws com.amazonaws.AmazonClientException,
                                                                       com.amazonaws.AmazonServiceException

Creates the directory.

Parameters:

bucketName - the bucket name

dirName - the dir name

Returns:

the put object result

Throws:

com.amazonaws.AmazonClientException - the amazon client exception

com.amazonaws.AmazonServiceException - the amazon service exception

createDirectory

com.amazonaws.services.s3.model.PutObjectResult createDirectory(String bucketName,
                                                              String dirName,
                                                              com.amazonaws.services.s3.model.CannedAccessControlList cannedAcl)
                                                                throws com.amazonaws.AmazonClientException,
                                                                       com.amazonaws.AmazonServiceException

Creates the directory.

Parameters:

bucketName - the bucket name

dirName - the dir name

cannedAcl - the canned acl

Returns:

the put object result

Throws:

com.amazonaws.AmazonClientException - the amazon client exception

com.amazonaws.AmazonServiceException - the amazon service exception

See Also:

ACL Overview, Canned ACL

createDirectory

com.amazonaws.services.s3.model.PutObjectResult createDirectory(String bucketName,
                                                              String dirName,
                                                              boolean isPublicAccessible)
                                                                throws com.amazonaws.AmazonClientException,
                                                                       com.amazonaws.AmazonServiceException

Creates the directory.
You can pass true/false flag to allow directories created in S3 to be publicly accessible.

Parameters:

bucketName - the bucket name

dirName - the dir name

isPublicAccessible - the is public accessible

Returns:

the put object result

Throws:

com.amazonaws.AmazonClientException - the amazon client exception

com.amazonaws.AmazonServiceException - the amazon service exception

deleteObject

void deleteObject(String bucketName,
                String fileName)
                  throws com.amazonaws.AmazonClientException,
                         com.amazonaws.AmazonServiceException

Delete object.

Parameters:

bucketName - the bucket name

fileName - the file name

Throws:

com.amazonaws.AmazonClientException - the amazon client exception

com.amazonaws.AmazonServiceException - the amazon service exception

deleteObjects

com.amazonaws.services.s3.model.DeleteObjectsResult deleteObjects(String bucketName,
                                                                List<com.amazonaws.services.s3.model.DeleteObjectsRequest.KeyVersion> keys)
                                                                  throws com.amazonaws.AmazonClientException,
                                                                         com.amazonaws.AmazonServiceException

Delete objects.

Parameters:

bucketName - the bucket name

keys - the keys

Returns:

the delete objects result

Throws:

com.amazonaws.AmazonClientException - the amazon client exception

com.amazonaws.AmazonServiceException - the amazon service exception

deleteDirectory

void deleteDirectory(String bucketName,
                   String dirName)
                     throws com.amazonaws.AmazonClientException,
                            com.amazonaws.AmazonServiceException

Delete directory.

Parameters:

bucketName - the bucket name

dirName - the dir name

Throws:

com.amazonaws.AmazonClientException - the amazon client exception

com.amazonaws.AmazonServiceException - the amazon service exception

isBucketExists

boolean isBucketExists(String bucketName)
                       throws com.amazonaws.AmazonClientException,
                              com.amazonaws.AmazonServiceException

Checks if is bucket exists.

Parameters:

bucketName - the bucket name

Returns:

true, if is bucket exists

Throws:

com.amazonaws.AmazonClientException - the amazon client exception

com.amazonaws.AmazonServiceException - the amazon service exception

generateObjectUrlAsString

String generateObjectUrlAsString(String bucketName,
                               String fileName)
                                 throws com.amazonaws.AmazonClientException,
                                        com.amazonaws.AmazonServiceException

Generate object url as string.

Parameters:

bucketName - the bucket name

fileName - the file name

Returns:

the string

Throws:

com.amazonaws.AmazonClientException - the amazon client exception

com.amazonaws.AmazonServiceException - the amazon service exception

generateObjectURL

URL generateObjectURL(String bucketName,
                    String fileName)
                      throws com.amazonaws.AmazonClientException,
                             com.amazonaws.AmazonServiceException

Generate object url.

Parameters:

bucketName - the bucket name

fileName - the file name

Returns:

the url

Throws:

com.amazonaws.AmazonClientException - the amazon client exception

com.amazonaws.AmazonServiceException - the amazon service exception

getBucketPermissions

List<com.amazonaws.services.s3.model.Grant> getBucketPermissions(String bucketName)
                                                                 throws com.amazonaws.AmazonClientException,
                                                                        com.amazonaws.AmazonServiceException,
                                                                        com.amazonaws.services.s3.model.AmazonS3Exception

Gets the bucket permissions.
Returns the list of Grant objects in this access control list (ACL).
The Grant object has Permission object which tell what kind of permissions are available.
and it has Grantee object which tell who are grantees.
Following are permissions available: FullControl, Read, Write, ReadAcp, WriteAcp
If access to the given bucket is not valid then 'AccessDenied' error will be raised.

Parameters:

bucketName - the bucket name

Returns:

the bucket permissions

Throws:

com.amazonaws.AmazonClientException - the amazon client exception

com.amazonaws.AmazonServiceException - the amazon service exception

com.amazonaws.services.s3.model.AmazonS3Exception - the amazon s3 exception

See Also:

Grant, Permission, Grantee, Permissions

hasFullControlPermission

boolean hasFullControlPermission(String bucketName)
                                 throws com.amazonaws.AmazonClientException,
                                        com.amazonaws.AmazonServiceException,
                                        com.amazonaws.services.s3.model.AmazonS3Exception

Checks if the bucket has full control permission
If access to the given bucket is not valid then 'AccessDenied' error will be raised.
Read ACP permission should be available to user who is trying to check permission on bucket.

Parameters:

bucketName - the bucket name

Returns:

true, if successful

Throws:

com.amazonaws.AmazonClientException - the amazon client exception

com.amazonaws.AmazonServiceException - the amazon service exception

com.amazonaws.services.s3.model.AmazonS3Exception - the amazon s3 exception

See Also:

Permissions

getBucketAccessControlList

com.amazonaws.services.s3.model.AccessControlList getBucketAccessControlList(String bucketName)
                                                                             throws com.amazonaws.AmazonClientException,
                                                                                    com.amazonaws.AmazonServiceException,
                                                                                    com.amazonaws.services.s3.model.AmazonS3Exception

Gets the bucket access control list.
Provides opportunities to grant permissions and check permissions on bucket.
If access to the given bucket is not valid then 'AccessDenied' error will be raised.
Read ACP permission should be available to user who is trying to check permission on bucket.

Parameters:

bucketName - the bucket name

Returns:

the bucket access control list

Throws:

com.amazonaws.AmazonClientException - the amazon client exception

com.amazonaws.AmazonServiceException - the amazon service exception

com.amazonaws.services.s3.model.AmazonS3Exception - the amazon s3 exception

See Also:

AccessControlList, Permissions

checkBucketPermission

boolean checkBucketPermission(String bucketName,
                            com.amazonaws.services.s3.model.Permission permission)
                              throws com.amazonaws.AmazonClientException,
                                     com.amazonaws.AmazonServiceException,
                                     com.amazonaws.services.s3.model.AmazonS3Exception

Check bucket permission.
If access to the given bucket is not valid then 'AccessDenied' error will be raised.
Read ACP permission should be available to user who is trying to check permission on bucket.

Parameters:

bucketName - the bucket name

permission - the permission

Returns:

true, if successful

Throws:

com.amazonaws.AmazonClientException - the amazon client exception

com.amazonaws.AmazonServiceException - the amazon service exception

com.amazonaws.services.s3.model.AmazonS3Exception - the amazon s3 exception

See Also:

Permissions

checkObjectPermission

boolean checkObjectPermission(String bucketName,
                            String key,
                            com.amazonaws.services.s3.model.Permission permission)
                              throws com.amazonaws.AmazonClientException,
                                     com.amazonaws.AmazonServiceException,
                                     com.amazonaws.services.s3.model.AmazonS3Exception

Check object permission.
If object is not available in given bucket, an exception will be thrown

Parameters:

bucketName - the bucket name

key - the full path of object in given bucket

permission - the permission

Returns:

true, if successful

Throws:

com.amazonaws.AmazonClientException - the amazon client exception

com.amazonaws.AmazonServiceException - the amazon service exception

com.amazonaws.services.s3.model.AmazonS3Exception - the amazon s3 exception

See Also:

Permissions

hasWritePermissionOnBucket

boolean hasWritePermissionOnBucket(String bucketName)

Checks for write permission on s3 bucket.
It checks if user has write permissions on bucket or not, even if ReadACP is not granted.

Parameters:

bucketName - the bucket name

Returns:

true, if successful