org.duracloud.reporter.storage

Class StorageReportHandler

java.lang.Object

org.duracloud.reporter.storage.StorageReportHandler

public class StorageReportHandler
extends Object

Handles the storage and retrieval of storage reports.

Field Summary

Fields

Modifier and Type	Field and Description
static String	COMPLETION_TIME_META
static String	ELAPSED_TIME_META
static int	maxRetries
protected String	storageSpace

Constructor Summary

Constructors

Constructor and Description
StorageReportHandler(ContentStoreManager storeMgr, String storageSpace, String reportFileNamePrefix, String reportErrorLogFileName)

Method Summary

Methods

Modifier and Type	Method and Description
void	addToErrorLog(String errMsg)
StorageReport	getLatestStorageReport() Returns the latest storage report or null if no reports exist
InputStream	getLatestStorageReportStream() Returns the latest storage report stream or null if no reports exist
StorageReport	getStorageReport(String reportId) Returns a specific storage report or null if the report does not exist.
StorageReportList	getStorageReportList() Retrieve a sorted list of all storage reports in XML format.
InputStream	getStorageReportStream(String reportId) Returns a specific storage report stream or null if the report does not exist.
String	storeReport(DuraStoreMetricsCollector metrics, long completionTime, long elapsedTime) Stores a storage report in the primary storage provider, returns the content ID of the new item.

Methods inherited from class java.lang.Object

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

Field Detail

COMPLETION_TIME_META

public static final String COMPLETION_TIME_META

See Also:

Constant Field Values

ELAPSED_TIME_META

public static final String ELAPSED_TIME_META

See Also:

Constant Field Values

maxRetries

public static final int maxRetries

See Also:

Constant Field Values

storageSpace

protected String storageSpace

Constructor Detail

StorageReportHandler

public StorageReportHandler(ContentStoreManager storeMgr,
                    String storageSpace,
                    String reportFileNamePrefix,
                    String reportErrorLogFileName)

Method Detail

getStorageReportStream

public InputStream getStorageReportStream(String reportId)
                                   throws ContentStoreException

Returns a specific storage report stream or null if the report does not exist.

Parameters:

reportId - content ID of the report to retrieve

Returns:

InputStream containing report

Throws:

ContentStoreException

getStorageReport

public StorageReport getStorageReport(String reportId)
                               throws ContentStoreException

Returns a specific storage report or null if the report does not exist.

Parameters:

reportId - content ID of the report to retrieve

Returns:

StorageReport

Throws:

ContentStoreException

getLatestStorageReportStream

public InputStream getLatestStorageReportStream()
                                         throws ContentStoreException

Returns the latest storage report stream or null if no reports exist

Throws:

ContentStoreException

getLatestStorageReport

public StorageReport getLatestStorageReport()
                                     throws ContentStoreException

Returns the latest storage report or null if no reports exist

Throws:

ContentStoreException

getStorageReportList

public StorageReportList getStorageReportList()
                                       throws ContentStoreException

Retrieve a sorted list of all storage reports in XML format. Sorting is by name in descending order (i.e. the latest report will be first).

Returns:

list of storage reports

Throws:

ContentStoreException

storeReport

public String storeReport(DuraStoreMetricsCollector metrics,
                 long completionTime,
                 long elapsedTime)

Stores a storage report in the primary storage provider, returns the content ID of the new item.

Parameters:

metrics - storage report

completionTime - time report completed (in millis)

elapsedTime - millis required to complete the report

Returns:

contentId of the newly stored report

addToErrorLog

public void addToErrorLog(String errMsg)