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.
File	copyObjectToFile(String bucket, String key, File file)
void	copyObjectToStream(String bucket, String key, OutputStream out)
Bucket	createBucket(String bucket) Create a new bucket
boolean	exists(String bucket, String key) Return true if this key exists in this bucket.
List<ObjectSummary>	getCompleteList(String bucket, String prefix)
com.amazonaws.auth.AWSCredentials	getCredentials()
com.amazonaws.services.s3.model.CannedAccessControlList	getDefaultPermissions()
String	getDirectoryContentType()
ObjectMetadata	getMetadata(String bucket, String key) Return metadata about the object stored in the bucket under the specified key
ObjectListing	getObjectListing(ListObjectsRequest request)
com.google.common.base.Optional<ObjectMetadata>	getOptionalMetadata(String bucket, String key) Return metadata for the object stored in the indicated bucket and key.
Bucket	getOrCreateBucketOwnedByMe(String bucket) Return the bucket if it exists, otherwise create and return a new bucket
String	getRegion() Return the region we are operating on
ObjectSummary	getSummary(String bucket, String key)
PutObjectResult	putDirectory(PutDirRequest request) Create a "directory" on S3.
PutObjectResult	putDirectory(String bucket, String key) Create a "directory" on S3.
PutObjectResult	putFile(PutFileRequest request) Create a file on S3 from a regular file on the local file system
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

putDirectory

public PutObjectResult putDirectory(String bucket,
                           String key)

Description copied from interface: S3Service

Create a "directory" on S3. (Zero-byte object with content-type set to "application/x-directory")

Specified by:

putDirectory in interface S3Service

putDirectory

public PutObjectResult putDirectory(PutDirRequest request)

Description copied from interface: S3Service

Create a "directory" on S3. (Zero-byte object with content-type set to "application/x-directory")

Specified by:

putDirectory in interface S3Service

getSummary

public ObjectSummary getSummary(String bucket,
                       String key)

Specified by:

getSummary in interface S3Service

getCompleteList

public List<ObjectSummary> getCompleteList(String bucket,
                                  String prefix)

Specified by:

getCompleteList in interface S3Service

getObjectListing

public ObjectListing getObjectListing(ListObjectsRequest request)

Specified by:

getObjectListing in interface S3Service

getOrCreateBucketOwnedByMe

public Bucket getOrCreateBucketOwnedByMe(String bucket)

Description copied from interface: S3Service

Return the bucket if it exists, otherwise create and return a new bucket

Specified by:

getOrCreateBucketOwnedByMe in interface S3Service

createBucket

public Bucket createBucket(String bucket)

Description copied from interface: S3Service

Create a new bucket

Specified by:

createBucket in interface S3Service

getMetadata

public ObjectMetadata getMetadata(String bucket,
                         String key)

Return metadata about the object stored in the bucket under the specified key

Specified by:

getMetadata in interface S3Service

Throws:

IllegalArgumentException - If bucket or key are blank, the bucket does not exist, or this key does not exist in this bucket

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

getOptionalMetadata

public com.google.common.base.Optional<ObjectMetadata> getOptionalMetadata(String bucket,
                                                                  String key)

Description copied from interface: S3Service

Return metadata for the object stored in the indicated bucket and key.

Specified by:

getOptionalMetadata in interface S3Service

exists

public boolean exists(String bucket,
             String key)

Description copied from interface: S3Service

Return true if this key exists in this bucket.

Specified by:

exists in interface S3Service

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

putFile

public PutObjectResult putFile(PutFileRequest request)

Create a file on S3 from a regular file on the local file system

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

copyObjectToStream

public void copyObjectToStream(String bucket,
                      String key,
                      OutputStream out)

Specified by:

copyObjectToStream in interface S3Service

copyObjectToFile

public File copyObjectToFile(String bucket,
                    String key,
                    File file)

Specified by:

copyObjectToFile 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()

getDirectoryContentType

public String getDirectoryContentType()