org.duracloud.openstackstorage

Class OpenStackStorageProvider

java.lang.Object

org.duracloud.storage.provider.StorageProviderBase

org.duracloud.openstackstorage.OpenStackStorageProvider

All Implemented Interfaces:

StorageProvider

Direct Known Subclasses:

RackspaceStorageProvider, SDSCStorageProvider

public abstract class OpenStackStorageProvider
extends StorageProviderBase

Provides content storage access to OpenStack storage providers.

Author:

Bill Branan

Nested Class Summary

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

StorageProviderBase.SpaceDeleteWorker

Field Summary

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

Constructor Summary

Constructors

Constructor and Description
OpenStackStorageProvider(String username, String apiAccessKey)
OpenStackStorageProvider(String username, String apiAccessKey, String authUrl)
OpenStackStorageProvider(org.jclouds.openstack.swift.SwiftClient swiftClient)

Method Summary

Methods

Modifier and Type	Method and Description
String	addContent(String spaceId, String contentId, String contentMimeType, Map<String,String> userProperties, long contentSize, String contentChecksum, InputStream content) Adds content to a space.
String	copyContent(String sourceSpaceId, String sourceContentId, String destSpaceId, String destContentId) This method copies the content item found in source-space with the id of source-content-id into the dest-space, naming it to dest-content-id.
void	createSpace(String spaceId) Creates a new space.
protected com.google.common.util.concurrent.ListeningExecutorService	createThreadPool()
void	deleteContent(String spaceId, String contentId) Removes content from a space.
protected void	doSetSpaceProperties(String spaceId, Map<String,String> spaceProperties)
protected Map<String,String>	getAllSpaceProperties(String spaceId)
abstract String	getAuthUrl()
protected String	getContainerName(String spaceId) Converts a provided space ID into a valid Rackspace container name.
InputStream	getContent(String spaceId, String contentId) Gets content from a space.
Map<String,String>	getContentProperties(String spaceId, String contentId) Retrieves the properties associated with content.
abstract String	getProviderName()
Iterator<String>	getSpaceContents(String spaceId, String prefix) Provides access to the content files within a space.
List<String>	getSpaceContentsChunked(String spaceId, String prefix, long maxResults, String marker) Provides a listing of the content files within a space.
protected String	getSpaceFree(String name) Replaces all spaces with "%20"
Iterator<String>	getSpaces() Provides a listing of all spaces owned by a customer.
protected String	getWithSpace(String name) Converts "%20" back to spaces
void	removeSpace(String spaceId)
static String	sanitizeForURI(String str) Encode any unicode characters that will cause us problems.
void	setContentProperties(String spaceId, String contentId, Map<String,String> contentProperties) Sets the properties associated with content.
protected boolean	spaceExists(String spaceId)

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

deleteSpace, deleteSpaceSync, getSpaceACLs, getSpaceDeleteWorker, getSpaceProperties, packACLs, removeCalculatedProperties, 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

Constructor Detail

OpenStackStorageProvider

public OpenStackStorageProvider(String username,
                        String apiAccessKey,
                        String authUrl)

OpenStackStorageProvider

public OpenStackStorageProvider(String username,
                        String apiAccessKey)

OpenStackStorageProvider

public OpenStackStorageProvider(org.jclouds.openstack.swift.SwiftClient swiftClient)

Method Detail

createThreadPool

protected com.google.common.util.concurrent.ListeningExecutorService createThreadPool()

getAuthUrl

public abstract String getAuthUrl()

getProviderName

public abstract String getProviderName()

getSpaces

public Iterator<String> getSpaces()

Provides a listing of all spaces owned by a customer.

Returns:

Iterator listing spaceIds

getSpaceContents

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

Provides access to the content files within a space. Chunking of the list is handled internally. Prefix can be set to return only content IDs starting with the prefix value.

Parameters:

spaceId - - ID of the space

prefix - - The prefix of the content id (null for no constraints)

Returns:

Iterator of contentIds

getSpaceContentsChunked

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

Provides a listing of the content files within a space. The number of items returned is limited to maxResults (default is 1000). Retrieve further results by including the last content ID in the previous list as the marker. Set prefix to return only content IDs starting with the prefix value.

Parameters:

spaceId - - ID of the space

prefix - - Only retrieve content IDs with this prefix (null for all content ids)

maxResults - - The maximum number of content IDs to return in the list (0 indicates default (1000))

marker - - The content ID marking the last item in the previous set (null indicates the first set of ids)

Returns:

List of contentIds

spaceExists

protected boolean spaceExists(String spaceId)

Specified by:

spaceExists in class StorageProviderBase

createSpace

public void createSpace(String spaceId)

Creates a new space. Depending on the storage implementation, the spaceId may be changed somewhat to comply with the naming rules of the underlying storage provider. The same spaceId value used here can be used in all other methods, as the conversion will be applied internally, however a call to getSpaces() may not include a space with exactly this same name.

Parameters:

spaceId - - ID of the space

doSetSpaceProperties

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

Specified by:

doSetSpaceProperties in class StorageProviderBase

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

addContent

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

Adds content to a space. Computes the checksum of the provided content and checks this against the checksum of the uploaded content to protect against loss or corruption during transfer.

Parameters:

spaceId - - ID of the space

contentId - - ID of the content in the space

contentMimeType - - the MIME type of the content being added

userProperties - - the metadata associated with the content

contentSize - - the file size (in bytes) of the content being added

contentChecksum - - the MD5 checksum of the content being added (null if no checksum is known)

content - - content to add

Returns:

The checksum of the provided content

copyContent

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

Description copied from interface: StorageProvider

This method copies the content item found in source-space with the id of source-content-id into the dest-space, naming it to dest-content-id.

Parameters:

sourceSpaceId - of content to copy

sourceContentId - of content to copy

destSpaceId - where copied content will end up

destContentId - given to copied content

Returns:

MD5 checksum of destination content item

getContent

public InputStream getContent(String spaceId,
                     String contentId)

Gets content from a space.

Parameters:

spaceId - - ID of the space

contentId - - ID of the content in the space

Returns:

the content stream

deleteContent

public void deleteContent(String spaceId,
                 String contentId)

Removes content from a space.

Parameters:

spaceId - - ID of the space

contentId - - ID of the content in the space

setContentProperties

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

Sets the properties associated with content. This effectively removes all of the current content properties and adds a new set of properties. Some properties, such as system properties provided by the underlying storage system, cannot be updated or removed. Some of the values which cannot be updated or removed: Content-MD5 ETag Last-Modified Content-Type cannot be removed, but it can be updated

Parameters:

spaceId - - ID of the space

contentId - - ID of the content in the space

contentProperties - - new content properties

getContentProperties

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

Retrieves the properties associated with content. This includes both properties generated by the underlying storage system as well as custom properties. Use the PROPERTIES_CONTENT_* constants to retrieve standard properties values.

Parameters:

spaceId - - ID of the space

contentId - - ID of the content in the space

Returns:

content properties

getContainerName

protected String getContainerName(String spaceId)

Converts a provided space ID into a valid Rackspace container name. From Cloud Files Docs: The only restrictions on Container names is that they cannot contain a forward slash (/) character or a question mark (?) character and they must be less than 64 characters in length (after URL encoding).

Parameters:

spaceId - user preferred ID of the space

Returns:

spaceId converted to valid Rackspace container name

sanitizeForURI

public static String sanitizeForURI(String str)

Encode any unicode characters that will cause us problems.

Parameters:

str -

Returns:

The string encoded for a URI

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