org.duracloud.irodsstorage

Class IrodsStorageProvider

java.lang.Object

org.duracloud.irodsstorage.IrodsStorageProvider

All Implemented Interfaces:

StorageProvider

public class IrodsStorageProvider
extends Object
implements StorageProvider

The irods provider assumes that storage spaces are subdirectories in the base directory given to the constructor. All files in the subdir will be listed recursively back to a client as contents of that space. spaceid - directory name under base directory - spaceid reserved words {spaces,security,stores}

Author:

toaster

Field Summary

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
IrodsStorageProvider(String username, String password, Map<String,String> options)

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) Add new content to irods, content path is baseDirectory /spaceId/contentId
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) Create a new directory under the baseDirectory
void	deleteContent(String spaceId, String contentId) Removes content from a space.
void	deleteSpace(String spaceId) Deletes a space.
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.
Map<String,AclType>	getSpaceACLs(String spaceId) Retrieves the ACLs associated with a space.
Iterator<String>	getSpaceContents(String spaceId, String prefix) Prefix is assumed to be part of the collection name.
List<String>	getSpaceContentsChunked(String spaceId, String prefix, long maxResults, String marker) Provides a listing of the content files within a space.
Map<String,String>	getSpaceProperties(String spaceId) Retrieves the properties associated with a space.
Iterator<String>	getSpaces() Return a list of irods spaces.
void	setContentProperties(String spaceId, String contentId, Map<String,String> contentProperties) Sets the properties associated with content.
void	setSpaceACLs(String spaceId, Map<String,AclType> spaceACLs) Sets the ACLs associated with a space.

Methods inherited from class java.lang.Object

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

Constructor Detail

IrodsStorageProvider

public IrodsStorageProvider(String username,
                    String password,
                    Map<String,String> options)

Method Detail

getSpaces

public Iterator<String> getSpaces()

Return a list of irods spaces. IRODS spaces are directories under the baseDirectory of this provider.

Specified by:

getSpaces in interface StorageProvider

Returns:

getSpaceContents

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

Prefix is assumed to be part of the collection name. This also has an issue where items in /irods/home/account/dir1 will br returned if /irods/home/account/dir is asked for (ie, spaceId=dir)

Specified by:

getSpaceContents in interface StorageProvider

Parameters:

spaceId -

prefix -

Returns:

getSpaceContentsChunked

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

Description copied from interface: StorageProvider

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.

Specified by:

getSpaceContentsChunked in interface StorageProvider

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

createSpace

public void createSpace(String spaceId)

Create a new directory under the baseDirectory

Specified by:

createSpace in interface StorageProvider

Parameters:

spaceId -

deleteSpace

public void deleteSpace(String spaceId)

Description copied from interface: StorageProvider

Deletes a space.

Specified by:

deleteSpace in interface StorageProvider

Parameters:

spaceId - - ID of the space

getSpaceProperties

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

Description copied from interface: StorageProvider

Retrieves the properties associated with a space.

Specified by:

getSpaceProperties in interface StorageProvider

Parameters:

spaceId - - ID of the space

Returns:

Map of space properties or empty map if no properties exists

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

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.

addContent

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

Add new content to irods, content path is baseDirectory /spaceId/contentId

Specified by:

addContent in interface StorageProvider

Parameters:

spaceId -

contentId -

contentMimeType -

contentSize - may be set to 0 in some cases (entry through admin client)

contentChecksum -

content -

userProperties - - the metadata associated with the content

Returns:

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.

Specified by:

copyContent in interface StorageProvider

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)

Description copied from interface: StorageProvider

Gets content from a space.

Specified by:

getContent in interface StorageProvider

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)

Description copied from interface: StorageProvider

Removes content from a space.

Specified by:

deleteContent in interface StorageProvider

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)

Description copied from interface: StorageProvider

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

Specified by:

setContentProperties in interface StorageProvider

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)

Description copied from interface: StorageProvider

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.

Specified by:

getContentProperties in interface StorageProvider

Parameters:

spaceId - - ID of the space

contentId - - ID of the content in the space

Returns:

content properties