org.duracloud.s3storage

Class S3StorageProvider

java.lang.Object

org.duracloud.storage.provider.StorageProviderBase

org.duracloud.s3storage.S3StorageProvider

All Implemented Interfaces:

StorageProvider

public class S3StorageProvider
extends StorageProviderBase

Provides content storage backed by Amazon's Simple Storage Service.

Author:

Bill Branan

Nested Class Summary

Nested classes/interfaces inherited from class org.duracloud.storage.provider.StorageProviderBase

StorageProviderBase.SpaceDeleteWorker

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	MAX_ITEM_COUNT
protected com.amazonaws.services.s3.AmazonS3Client	s3Client

Fields inherited from class org.duracloud.storage.provider.StorageProviderBase

ACL_DELIM, ACL_GROUP_READ, ACL_GROUP_WRITE, ACL_USER_READ, ACL_USER_WRITE

Fields inherited from interface org.duracloud.storage.provider.StorageProvider

DEFAULT_MAX_RESULTS, DEFAULT_MIMETYPE, ISO8601_DATE_FORMAT, PROPERTIES_CONTENT_CHECKSUM, PROPERTIES_CONTENT_CREATOR, PROPERTIES_CONTENT_FILE_CREATED, PROPERTIES_CONTENT_FILE_LAST_ACCESSED, PROPERTIES_CONTENT_FILE_MODIFIED, PROPERTIES_CONTENT_FILE_PATH, PROPERTIES_CONTENT_MD5, PROPERTIES_CONTENT_MIMETYPE, PROPERTIES_CONTENT_MODIFIED, PROPERTIES_CONTENT_SIZE, PROPERTIES_COPY_SOURCE, PROPERTIES_COPY_SOURCE_STORE, PROPERTIES_SPACE_ACL, PROPERTIES_SPACE_ACL_GROUP, PROPERTIES_SPACE_ACL_PUBLIC, PROPERTIES_SPACE_COUNT, PROPERTIES_SPACE_CREATED, PROPERTIES_SPACE_SIZE, PROPERTIES_STREAMING_HOST, PROPERTIES_STREAMING_TYPE

Constructor Summary

Constructors

Constructor and Description
S3StorageProvider(com.amazonaws.services.s3.AmazonS3Client s3Client, String accessKey, Map<String,String> options)
S3StorageProvider(String accessKey, String secretKey)
S3StorageProvider(String accessKey, String secretKey, Map<String,String> options)

Method Summary

Modifier and Type	Method and Description
String	addContent(String spaceId, String contentId, String contentMimeType, Map<String,String> userProperties, long contentSize, String contentChecksum, InputStream content)
String	copyContent(String sourceSpaceId, String sourceContentId, String destSpaceId, String destContentId)
void	createSpace(String spaceId)
void	deleteContent(String spaceId, String contentId)
protected String	doesContentExist(String bucketName, String contentId)
protected void	doSetSpaceProperties(String spaceId, Map<String,String> spaceProperties)
protected Map<String,String>	getAllSpaceProperties(String spaceId)
String	getBucketName(String spaceId) Gets the name of an existing bucket based on a space ID.
InputStream	getContent(String spaceId, String contentId)
Map<String,String>	getContentProperties(String spaceId, String contentId)
protected String	getETagValue(String etag)
protected String	getNewBucketName(String spaceId)
Iterator<String>	getSpaceContents(String spaceId, String prefix)
List<String>	getSpaceContentsChunked(String spaceId, String prefix, long maxResults, String marker)
protected String	getSpaceCount(String spaceId, int maxCount)
protected String	getSpaceFree(String name) Replaces all spaces with "%20"
protected String	getSpaceId(String bucketName) Converts a bucket name into what could be passed in as a space ID.
Iterator<String>	getSpaces()
protected StoragePolicy	getStoragePolicy() Defines the storage policy for the primary S3 provider.
StorageProviderType	getStorageProviderType()
protected String	getWithSpace(String name) Converts "%20" back to spaces
protected boolean	isSpace(String bucketName) Determines if an S3 bucket is a DuraCloud space
protected Map<String,String>	removeCalculatedProperties(Map<String,String> contentProperties)
void	removeSpace(String spaceId)
void	setContentProperties(String spaceId, String contentId, Map<String,String> contentProperties)
void	setSpaceLifecycle(String bucketName, com.amazonaws.services.s3.model.BucketLifecycleConfiguration config) Sets a lifecycle policy on an S3 bucket based on the given configuration
protected boolean	spaceExists(String spaceId)
protected void	wait(int seconds)

Methods inherited from class org.duracloud.storage.provider.StorageProviderBase

deleteSpace, deleteSpaceSync, getSpaceACLs, getSpaceDeleteWorker, getSpaceProperties, packACLs, setNewSpaceProperties, setNewSpaceProperties, setSpaceACLs, setWrappedStorageProvider, throwIfSpaceExists, throwIfSpaceNotExist, throwIfSpaceNotExist, unpackACLs

Methods inherited from class java.lang.Object

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

Field Detail

MAX_ITEM_COUNT

protected static final int MAX_ITEM_COUNT

See Also:

Constant Field Values

s3Client

protected com.amazonaws.services.s3.AmazonS3Client s3Client

Constructor Detail

S3StorageProvider

public S3StorageProvider(String accessKey,
                         String secretKey)

S3StorageProvider

public S3StorageProvider(String accessKey,
                         String secretKey,
                         Map<String,String> options)

S3StorageProvider

public S3StorageProvider(com.amazonaws.services.s3.AmazonS3Client s3Client,
                         String accessKey,
                         Map<String,String> options)

Method Detail

getStorageProviderType

public StorageProviderType getStorageProviderType()

getSpaces

public Iterator<String> getSpaces()

getSpaceContents

public Iterator<String> getSpaceContents(String spaceId,
                                         String prefix)

getSpaceContentsChunked

public List<String> getSpaceContentsChunked(String spaceId,
                                            String prefix,
                                            long maxResults,
                                            String marker)

spaceExists

protected boolean spaceExists(String spaceId)

Specified by:

spaceExists in class StorageProviderBase

createSpace

public void createSpace(String spaceId)

getStoragePolicy

protected StoragePolicy getStoragePolicy()

Defines the storage policy for the primary S3 provider. Subclasses can define different policy choices.

Returns:

storage policy to set, or null if no policy should be defined

setSpaceLifecycle

public void setSpaceLifecycle(String bucketName,
                              com.amazonaws.services.s3.model.BucketLifecycleConfiguration config)

Sets a lifecycle policy on an S3 bucket based on the given configuration

Parameters:

bucketName - name of the bucket to update

config - bucket lifecycle configuration

getNewBucketName

protected String getNewBucketName(String spaceId)

removeSpace

public void removeSpace(String spaceId)

Specified by:

removeSpace in class StorageProviderBase

getAllSpaceProperties

protected Map<String,String> getAllSpaceProperties(String spaceId)

Specified by:

getAllSpaceProperties in class StorageProviderBase

getSpaceCount

protected String getSpaceCount(String spaceId,
                               int maxCount)

doSetSpaceProperties

protected void doSetSpaceProperties(String spaceId,
                                    Map<String,String> spaceProperties)

Specified by:

doSetSpaceProperties in class StorageProviderBase

addContent

public String addContent(String spaceId,
                         String contentId,
                         String contentMimeType,
                         Map<String,String> userProperties,
                         long contentSize,
                         String contentChecksum,
                         InputStream content)

doesContentExist

protected String doesContentExist(String bucketName,
                                  String contentId)

wait

protected void wait(int seconds)

copyContent

public String copyContent(String sourceSpaceId,
                          String sourceContentId,
                          String destSpaceId,
                          String destContentId)

getContent

public InputStream getContent(String spaceId,
                              String contentId)

deleteContent

public void deleteContent(String spaceId,
                          String contentId)

setContentProperties

public void setContentProperties(String spaceId,
                                 String contentId,
                                 Map<String,String> contentProperties)

removeCalculatedProperties

protected Map<String,String> removeCalculatedProperties(Map<String,String> contentProperties)

Overrides:

removeCalculatedProperties in class StorageProviderBase

getContentProperties

public Map<String,String> getContentProperties(String spaceId,
                                               String contentId)

getETagValue

protected String getETagValue(String etag)

getBucketName

public String getBucketName(String spaceId)

Gets the name of an existing bucket based on a space ID. If no bucket with this spaceId exists, throws a NotFoundException

Parameters:

spaceId - the space Id to convert into an S3 bucket name

Returns:

S3 bucket name of a given DuraCloud space

Throws:

NotFoundException - if no bucket matches this spaceID

getSpaceId

protected String getSpaceId(String bucketName)

Converts a bucket name into what could be passed in as a space ID.

Parameters:

bucketName - name of the S3 bucket

Returns:

the DuraCloud space name equivalent to a given S3 bucket Id

isSpace

protected boolean isSpace(String bucketName)

Determines if an S3 bucket is a DuraCloud space

Parameters:

bucketName - name of the S3 bucket

Returns:

true if the given S3 bucket name is named according to the DuraCloud space naming conventions, false otherwise

getSpaceFree

protected String getSpaceFree(String name)

Replaces all spaces with "%20"

Parameters:

name - string with possible space

Returns:

converted to string without spaces

getWithSpace

protected String getWithSpace(String name)

Converts "%20" back to spaces

Parameters:

name - string

Returns:

converted to spaces