org.duracloud.client.report
Interface StorageReportManager

All Superinterfaces:
org.duracloud.common.model.Securable
All Known Implementing Classes:
StorageReportManagerImpl

public interface StorageReportManager
extends org.duracloud.common.model.Securable

Allows for communication with DuraBoss reporting


Method Summary
 String cancelStorageReport()
          Cancels any currently running storage report.
 String cancelStorageReportSchedule()
          Cancels any existing storage report schedule.
 String getBaseURL()
           
 org.duracloud.reportdata.storage.StorageReport getLatestStorageReport()
          Retrieves the latest completed storage report.
 org.duracloud.reportdata.storage.StorageReport getStorageReport(String reportId)
          Retrieves a storage report indicated by a report ID.
 org.duracloud.reportdata.storage.StorageReportInfo getStorageReportInfo()
          Retrieves information about storage reporting activities.
 List<String> getStorageReportList()
          Retrieves the list of storage report IDs, ordered by report completion date.
 String scheduleStorageReport(Date startTime, long frequency)
          Schedules a series of storage reports to run.
 String startStorageReport()
          Tells DuraBoss reporting to start running a new storage report generation process.
 
Methods inherited from interface org.duracloud.common.model.Securable
login, logout
 

Method Detail

getBaseURL

String getBaseURL()

getLatestStorageReport

org.duracloud.reportdata.storage.StorageReport getLatestStorageReport()
                                                                      throws NotFoundException,
                                                                             ReportException
Retrieves the latest completed storage report.

Returns:
StorageReport
Throws:
NotFoundException - if no reports are available
ReportException

getStorageReportList

List<String> getStorageReportList()
                                  throws ReportException
Retrieves the list of storage report IDs, ordered by report completion date.

Returns:
List os report IDs
Throws:
ReportException

getStorageReport

org.duracloud.reportdata.storage.StorageReport getStorageReport(String reportId)
                                                                throws NotFoundException,
                                                                       ReportException
Retrieves a storage report indicated by a report ID.

Parameters:
reportId -
Returns:
StorageReport
Throws:
NotFoundException - if a storage report with that ID does not exist
ReportException

getStorageReportInfo

org.duracloud.reportdata.storage.StorageReportInfo getStorageReportInfo()
                                                                        throws ReportException
Retrieves information about storage reporting activities.

Returns:
Throws:
ReportException

startStorageReport

String startStorageReport()
                          throws ReportException
Tells DuraBoss reporting to start running a new storage report generation process. If a report generation process is already underway, this call is ignored.

Returns:
success message
Throws:
ReportException

cancelStorageReport

String cancelStorageReport()
                           throws ReportException
Cancels any currently running storage report.

Returns:
success message
Throws:
ReportException

scheduleStorageReport

String scheduleStorageReport(Date startTime,
                             long frequency)
                             throws ReportException
Schedules a series of storage reports to run. The first such report will begin at the indicated start time, followed by reports at the given frequency.

Parameters:
startTime - time to start the next storage report
frequency - time in milliseconds to wait between reports
Returns:
success message
Throws:
ReportException

cancelStorageReportSchedule

String cancelStorageReportSchedule()
                                   throws ReportException
Cancels any existing storage report schedule.

Returns:
success message
Throws:
ReportException


Copyright © 2009-2012 DuraSpace. All Rights Reserved.