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_BUCKET, 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_HLS_STREAMING_HOST, PROPERTIES_HLS_STREAMING_TYPE, 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
IrodsStorageProvider(String username, String password, 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) Add new content to irods, content path is baseDirectory /spaceId/contentId
String	copyContent(String sourceSpaceId, String sourceContentId, String destSpaceId, String destContentId)
void	createSpace(String spaceId) Create a new directory under the baseDirectory
void	deleteContent(String spaceId, String contentId)
void	deleteSpace(String spaceId)
RetrievedContent	getContent(String spaceId, String contentId)
RetrievedContent	getContent(String spaceId, String contentId, String range)
Map<String,String>	getContentProperties(String spaceId, String contentId)
Map<String,AclType>	getSpaceACLs(String spaceId)
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)
Map<String,String>	getSpaceProperties(String spaceId)
Iterator<String>	getSpaces() Return a list of irods spaces.
StorageProviderType	getStorageProviderType()
void	setContentProperties(String spaceId, String contentId, Map<String,String> contentProperties)
void	setSpaceACLs(String spaceId, Map<String,AclType> spaceACLs)

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

getStorageProviderType

public StorageProviderType getStorageProviderType()

Specified by:

getStorageProviderType in interface StorageProvider

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)

Specified by:

getSpaceContentsChunked in interface StorageProvider

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)

Specified by:

deleteSpace in interface StorageProvider

getSpaceProperties

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

Specified by:

getSpaceProperties in interface StorageProvider

getSpaceACLs

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

Specified by:

getSpaceACLs in interface StorageProvider

setSpaceACLs

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

Specified by:

setSpaceACLs in interface StorageProvider

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 -

Returns:

copyContent

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

Specified by:

copyContent in interface StorageProvider

getContent

public RetrievedContent getContent(String spaceId,
                                   String contentId)

Specified by:

getContent in interface StorageProvider

getContent

public RetrievedContent getContent(String spaceId,
                                   String contentId,
                                   String range)

Specified by:

getContent in interface StorageProvider

deleteContent

public void deleteContent(String spaceId,
                          String contentId)

Specified by:

deleteContent in interface StorageProvider

setContentProperties

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

Specified by:

setContentProperties in interface StorageProvider

getContentProperties

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

Specified by:

getContentProperties in interface StorageProvider