org.duracloud.storage.provider

Class StorageProviderBase

java.lang.Object

org.duracloud.storage.provider.StorageProviderBase

All Implemented Interfaces:

StorageProvider

Direct Known Subclasses:

OpenStackStorageProvider, S3StorageProvider

public abstract class StorageProviderBase
extends Object
implements StorageProvider

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	StorageProviderBase.SpaceDeleteWorker

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	ACL_DELIM
protected static String	ACL_GROUP_READ
protected static String	ACL_GROUP_WRITE
protected static String	ACL_USER_READ
protected static String	ACL_USER_WRITE
protected org.slf4j.Logger	log

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

Method Summary

Methods

Modifier and Type	Method and Description
void	deleteSpace(String spaceId) Deletes a space.
void	deleteSpaceSync(String spaceId) This method is only intended to be used by tests!
protected abstract void	doSetSpaceProperties(String spaceId, Map<String,String> spaceProps)
protected abstract Map<String,String>	getAllSpaceProperties(String spaceId)
Map<String,AclType>	getSpaceACLs(String spaceId) Retrieves the ACLs associated with a space.
StorageProviderBase.SpaceDeleteWorker	getSpaceDeleteWorker(String spaceId)
Map<String,String>	getSpaceProperties(String spaceId) This method returns all of the space properties EXCEPT the ACLs
protected Map<String,String>	packACLs(Map<String,AclType> spaceACLs)
protected Map<String,String>	removeCalculatedProperties(Map<String,String> properties)
protected abstract void	removeSpace(String spaceId)
void	setNewSpaceProperties(String spaceId, Map<String,String> spaceProperties) Sets the properties of this space.
void	setSpaceACLs(String spaceId, Map<String,AclType> spaceACLs) Sets the ACLs associated with a space.
void	setWrappedStorageProvider(StorageProvider wrappedStorageProvider) Sets an alternate storage provider that can be used for select operations.
protected abstract boolean	spaceExists(String spaceId)
protected void	throwIfSpaceExists(String spaceId)
protected void	throwIfSpaceNotExist(String spaceId)
protected void	throwIfSpaceNotExist(String spaceId, boolean wait)
protected Map<String,AclType>	unpackACLs(Map<String,String> spaceProps)

Methods inherited from class java.lang.Object

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

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

addContent, copyContent, createSpace, deleteContent, getContent, getContentProperties, getSpaceContents, getSpaceContentsChunked, getSpaces, setContentProperties

Field Detail

ACL_USER_READ

protected static final String ACL_USER_READ

See Also:

Constant Field Values

ACL_USER_WRITE

protected static final String ACL_USER_WRITE

See Also:

Constant Field Values

ACL_GROUP_READ

protected static final String ACL_GROUP_READ

See Also:

Constant Field Values

ACL_GROUP_WRITE

protected static final String ACL_GROUP_WRITE

See Also:

Constant Field Values

ACL_DELIM

protected static final String ACL_DELIM

See Also:

Constant Field Values

log

protected final org.slf4j.Logger log

Constructor Detail

StorageProviderBase

public StorageProviderBase()

Method Detail

spaceExists

protected abstract boolean spaceExists(String spaceId)

removeSpace

protected abstract void removeSpace(String spaceId)

getAllSpaceProperties

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

doSetSpaceProperties

protected abstract void doSetSpaceProperties(String spaceId,
                        Map<String,String> spaceProps)

getSpaceProperties

public Map<String,String> getSpaceProperties(String spaceId)

This method returns all of the space properties EXCEPT the ACLs

Specified by:

getSpaceProperties in interface StorageProvider

Parameters:

spaceId - - ID of the space

Returns:

map of space properties

setNewSpaceProperties

public void setNewSpaceProperties(String spaceId,
                         Map<String,String> spaceProperties)

Sets the properties of this space. Note that this method is intentionally not exposed to users, as it is not meant to be used for user properties, but only for system-level properties. The names and values need to be kept short, and the overall number of properties needs to be tightly limited, or there will be issues due to provider-specific limitation.

Parameters:

spaceId -

spaceProperties -

getSpaceACLs

public Map<String,AclType> getSpaceACLs(String spaceId)

Description copied from interface: StorageProvider

Retrieves the ACLs associated with a space.

Specified by:

getSpaceACLs in interface StorageProvider

Parameters:

spaceId - - ID of the space

Returns:

Map of space ACLs or empty map if none exists

unpackACLs

protected Map<String,AclType> unpackACLs(Map<String,String> spaceProps)

setSpaceACLs

public void setSpaceACLs(String spaceId,
                Map<String,AclType> spaceACLs)

Description copied from interface: StorageProvider

Sets the ACLs associated with a space.

Specified by:

setSpaceACLs in interface StorageProvider

Parameters:

spaceId - - ID of the space

spaceACLs - - Updated space ACL. Note, null or empty arg spaceACLs will 'clear' the space ACLs.

packACLs

protected Map<String,String> packACLs(Map<String,AclType> spaceACLs)

throwIfSpaceExists

protected void throwIfSpaceExists(String spaceId)

throwIfSpaceNotExist

protected void throwIfSpaceNotExist(String spaceId)

throwIfSpaceNotExist

protected void throwIfSpaceNotExist(String spaceId,
                        boolean wait)

deleteSpace

public void deleteSpace(String spaceId)

Deletes a space.

Specified by:

deleteSpace in interface StorageProvider

Parameters:

spaceId - - ID of the space

deleteSpaceSync

public void deleteSpaceSync(String spaceId)

This method is only intended to be used by tests!

Parameters:

spaceId -

getSpaceDeleteWorker

public StorageProviderBase.SpaceDeleteWorker getSpaceDeleteWorker(String spaceId)

removeCalculatedProperties

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

setWrappedStorageProvider

public void setWrappedStorageProvider(StorageProvider wrappedStorageProvider)

Sets an alternate storage provider that can be used for select operations. The motivation for adding this method came from a need to have the deleteSpace operation generate audit events for content items as they were deleted before the space itself was deleted.

Parameters:

wrappedStorageProvider -