org.kuali.common.aws.s3

Class DefaultS3Service

java.lang.Object

org.kuali.common.aws.s3.DefaultS3Service

All Implemented Interfaces:

S3Service

@IdiotProofImmutable
public final class DefaultS3Service
extends Object
implements S3Service

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DefaultS3Service.Builder

Method Summary

Methods

Modifier and Type	Method and Description
static DefaultS3Service	build(com.amazonaws.auth.AWSCredentials credentials)
static DefaultS3Service.Builder	builder(com.amazonaws.auth.AWSCredentials credentials)
CopyObjectResult	copyObject(String bucket, String srcKey, String dstKey) Copy an object in a bucket to another name.
Bucket	createBucket(String bucket) Create a new bucket
boolean	exists(String bucket, String key) Return true if we are able to determine that this key exists in this bucket.
com.amazonaws.auth.AWSCredentials	getCredentials()
com.amazonaws.services.s3.model.CannedAccessControlList	getDefaultPermissions()
String	getRegion() Return the region we are operating on
PutObjectResult	putFile(String bucket, String key, File file) Copy a file from the local file system to a bucket using UTF8
PutObjectResult	putFile(String bucket, String key, File file, String encoding) Copy a file from the local file system to a bucket using the indicated encoding
String	readObjectToString(String bucket, String key) Read the contents of an object into a string using UTF8
PutObjectResult	writeStringToObject(String bucket, String key, String data) Write a string to a bucket using UTF8

Methods inherited from class java.lang.Object

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

Method Detail

createBucket

public Bucket createBucket(String bucket)

Create a new bucket

exists

public boolean exists(String bucket,
             String key)

Return true if we are able to determine that this key exists in this bucket. Return false if we are able to determine that this key does not exist in this bucket.

Specified by:

exists in interface S3Service

Throws:

IllegalArgumentException - If bucket or key are blank or the bucket does not exist.

com.amazonaws.services.s3.model.AmazonS3Exception - If the bucket exists but permissions deny read access to the bucket or object

putFile

public PutObjectResult putFile(String bucket,
                      String key,
                      File file)

Description copied from interface: S3Service

Copy a file from the local file system to a bucket using UTF8

Specified by:

putFile in interface S3Service

putFile

public PutObjectResult putFile(String bucket,
                      String key,
                      File file,
                      String encoding)

Description copied from interface: S3Service

Copy a file from the local file system to a bucket using the indicated encoding

Specified by:

putFile in interface S3Service

writeStringToObject

public PutObjectResult writeStringToObject(String bucket,
                                  String key,
                                  String data)

Description copied from interface: S3Service

Write a string to a bucket using UTF8

Specified by:

writeStringToObject in interface S3Service

readObjectToString

public String readObjectToString(String bucket,
                        String key)

Description copied from interface: S3Service

Read the contents of an object into a string using UTF8

Specified by:

readObjectToString in interface S3Service

copyObject

public CopyObjectResult copyObject(String bucket,
                          String srcKey,
                          String dstKey)

Copy an object in a bucket to another name. Copies the original objects metadata and ACL.

Specified by:

copyObject in interface S3Service

build

public static DefaultS3Service build(com.amazonaws.auth.AWSCredentials credentials)

builder

public static DefaultS3Service.Builder builder(com.amazonaws.auth.AWSCredentials credentials)

getCredentials

public com.amazonaws.auth.AWSCredentials getCredentials()

getRegion

public String getRegion()

Description copied from interface: S3Service

Return the region we are operating on

Specified by:

getRegion in interface S3Service

getDefaultPermissions

public com.amazonaws.services.s3.model.CannedAccessControlList getDefaultPermissions()