Package org.duracloud.retrieval.source
Interface RetrievalSource
-
- All Known Implementing Classes:
DuraStoreRetrievalSource,DuraStoreSpecifiedRetrievalSource,DuraStoreStitchingRetrievalSource
public interface RetrievalSource
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description ContentItemgetNextContentItem()Provides the next content item to be processed, cycles through all spaces as necessary.StringgetSourceChecksum(ContentItem contentItem)Provides the checksum of the specified source file based on the file's properties.default ContentStreamgetSourceContent(ContentItem contentItem)Gets the actual content, including the stream and the checksum.ContentStreamgetSourceContent(ContentItem contentItem, RetrievalListener listener)Get the actual content using a retrieval listener callback.Map<String,String>getSourceProperties(ContentItem contentItem)Retrieves the Duracloud properties for the specified ContentItem.
-
-
-
Method Detail
-
getNextContentItem
ContentItem getNextContentItem()
Provides the next content item to be processed, cycles through all spaces as necessary. Returns null when there are no further content ids to process.- Returns:
- the next content item to be processed
-
getSourceProperties
Map<String,String> getSourceProperties(ContentItem contentItem)
Retrieves the Duracloud properties for the specified ContentItem.- Parameters:
contentItem- the file whose properties to retrieve- Returns:
- the Map of Duracloud properties
-
getSourceChecksum
String getSourceChecksum(ContentItem contentItem)
Provides the checksum of the specified source file based on the file's properties.- Parameters:
contentItem- the file to consider- Returns:
- MD5 checksum of the given file
-
getSourceContent
default ContentStream getSourceContent(ContentItem contentItem)
Gets the actual content, including the stream and the checksum.- Parameters:
contentItem- the file to retrieve- Returns:
- content stream of the specified file
-
getSourceContent
ContentStream getSourceContent(ContentItem contentItem, RetrievalListener listener)
Get the actual content using a retrieval listener callback. The listener should be called synchronously.- Parameters:
contentItem- the file to retrievelistener- of the specified operation- Returns:
-
-