org.duracloud.client.report

Class StorageReportManagerImpl

java.lang.Object

org.duracloud.client.report.BaseReportManager

org.duracloud.client.report.StorageReportManagerImpl

All Implemented Interfaces:

StorageReportManager, Securable

Direct Known Subclasses:

DuradminStorageReportManagerImpl

public class StorageReportManagerImpl
extends BaseReportManager
implements StorageReportManager

Allows for communication with Duraboss reporting

Field Summary

Fields inherited from class org.duracloud.client.report.BaseReportManager

restHelper

Constructor Summary

Constructors

Constructor and Description
StorageReportManagerImpl(String host, String port)
StorageReportManagerImpl(String host, String port, String context)

Method Summary

Methods

Modifier and Type	Method and Description
String	cancelStorageReport() Cancels any currently running storage report.
String	cancelStorageReportSchedule() Cancels any existing storage report schedule.
StorageReport	getLatestStorageReport() Retrieves the latest completed storage report.
StorageReport	getStorageReport(String reportId) Retrieves a storage report indicated by a report ID.
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 class org.duracloud.client.report.BaseReportManager

checkResponse, getBaseURL, getRestHelper, login, logout, setRestHelper

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.duracloud.client.report.StorageReportManager

getBaseURL

Methods inherited from interface org.duracloud.common.model.Securable

login, logout

Constructor Detail

StorageReportManagerImpl

public StorageReportManagerImpl(String host,
                        String port)

StorageReportManagerImpl

public StorageReportManagerImpl(String host,
                        String port,
                        String context)

Method Detail

getLatestStorageReport

public StorageReport getLatestStorageReport()
                                     throws NotFoundException,
                                            ReportException

Description copied from interface: StorageReportManager

Retrieves the latest completed storage report.

Specified by:

getLatestStorageReport in interface StorageReportManager

Returns:

StorageReport

Throws:

NotFoundException - if no reports are available

ReportException

getStorageReportList

public List<String> getStorageReportList()
                                  throws ReportException

Description copied from interface: StorageReportManager

Retrieves the list of storage report IDs, ordered by report completion date.

Specified by:

getStorageReportList in interface StorageReportManager

Returns:

List os report IDs

Throws:

ReportException

getStorageReport

public StorageReport getStorageReport(String reportId)
                               throws NotFoundException,
                                      ReportException

Description copied from interface: StorageReportManager

Retrieves a storage report indicated by a report ID.

Specified by:

getStorageReport in interface StorageReportManager

Returns:

StorageReport

Throws:

NotFoundException - if a storage report with that ID does not exist

ReportException

getStorageReportInfo

public StorageReportInfo getStorageReportInfo()
                                       throws ReportException

Description copied from interface: StorageReportManager

Retrieves information about storage reporting activities.

Specified by:

getStorageReportInfo in interface StorageReportManager

Returns:

Throws:

ReportException

startStorageReport

public String startStorageReport()
                          throws ReportException

Description copied from interface: StorageReportManager

Tells DuraBoss reporting to start running a new storage report generation process. If a report generation process is already underway, this call is ignored.

Specified by:

startStorageReport in interface StorageReportManager

Returns:

success message

Throws:

ReportException

cancelStorageReport

public String cancelStorageReport()
                           throws ReportException

Description copied from interface: StorageReportManager

Cancels any currently running storage report.

Specified by:

cancelStorageReport in interface StorageReportManager

Returns:

success message

Throws:

ReportException

scheduleStorageReport

public String scheduleStorageReport(Date startTime,
                           long frequency)
                             throws ReportException

Description copied from interface: StorageReportManager

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.

Specified by:

scheduleStorageReport in interface StorageReportManager

Parameters:

startTime - time to start the next storage report

frequency - time in milliseconds to wait between reports

Returns:

success message

Throws:

ReportException

cancelStorageReportSchedule

public String cancelStorageReportSchedule()
                                   throws ReportException

Description copied from interface: StorageReportManager

Cancels any existing storage report schedule.

Specified by:

cancelStorageReportSchedule in interface StorageReportManager

Returns:

success message

Throws:

ReportException