org.duracloud.openstackstorage

Class OpenStackStorageProvider

java.lang.Object

org.duracloud.storage.provider.StorageProviderBase

org.duracloud.openstackstorage.OpenStackStorageProvider

All Implemented Interfaces:

StorageProvider

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, PROPERTIES_STREAMING_TYPE

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

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)
protected com.google.common.util.concurrent.ListeningExecutorService	createThreadPool()
void	deleteContent(String spaceId, String contentId)
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)
Map<String,String>	getContentProperties(String spaceId, String contentId)
abstract String	getProviderName()
Iterator<String>	getSpaceContents(String spaceId, String prefix)
List<String>	getSpaceContentsChunked(String spaceId, String prefix, long maxResults, String marker)
protected String	getSpaceFree(String name) Replaces all spaces with "%20"
Iterator<String>	getSpaces()
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)
protected boolean	spaceExists(String spaceId)

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

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

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

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)

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)

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)

getContentProperties

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

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