|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.duracloud.client.report.BaseReportManager
org.duracloud.client.report.StorageReportManagerImpl
public class StorageReportManagerImpl
Allows for communication with DuraReport
Field Summary |
---|
Fields inherited from class org.duracloud.client.report.BaseReportManager |
---|
restHelper |
Constructor Summary | |
---|---|
StorageReportManagerImpl(java.lang.String host,
java.lang.String port)
|
|
StorageReportManagerImpl(java.lang.String host,
java.lang.String port,
java.lang.String context)
|
Method Summary | |
---|---|
java.lang.String |
cancelStorageReport()
Cancels any currently running storage report. |
java.lang.String |
cancelStorageReportSchedule()
Cancels any existing storage report schedule. |
org.duracloud.reportdata.storage.StorageReport |
getLatestStorageReport()
Retrieves the latest completed storage report. |
org.duracloud.reportdata.storage.StorageReport |
getStorageReport(java.lang.String reportId)
Retrieves a storage report indicated by a report ID. |
org.duracloud.reportdata.storage.StorageReportInfo |
getStorageReportInfo()
Retrieves information about storage reporting activities. |
java.util.List<java.lang.String> |
getStorageReportList()
Retrieves the list of storage report IDs, ordered by report completion date. |
java.lang.String |
scheduleStorageReport(java.util.Date startTime,
long frequency)
Schedules a series of storage reports to run. |
java.lang.String |
startStorageReport()
Tells DuraReport 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 |
---|
public StorageReportManagerImpl(java.lang.String host, java.lang.String port)
public StorageReportManagerImpl(java.lang.String host, java.lang.String port, java.lang.String context)
Method Detail |
---|
public org.duracloud.reportdata.storage.StorageReport getLatestStorageReport() throws NotFoundException, ReportException
StorageReportManager
getLatestStorageReport
in interface StorageReportManager
NotFoundException
- if no reports are available
ReportException
public java.util.List<java.lang.String> getStorageReportList() throws ReportException
StorageReportManager
getStorageReportList
in interface StorageReportManager
ReportException
public org.duracloud.reportdata.storage.StorageReport getStorageReport(java.lang.String reportId) throws NotFoundException, ReportException
StorageReportManager
getStorageReport
in interface StorageReportManager
NotFoundException
- if a storage report with that ID does not exist
ReportException
public org.duracloud.reportdata.storage.StorageReportInfo getStorageReportInfo() throws ReportException
StorageReportManager
getStorageReportInfo
in interface StorageReportManager
ReportException
public java.lang.String startStorageReport() throws ReportException
StorageReportManager
startStorageReport
in interface StorageReportManager
ReportException
public java.lang.String cancelStorageReport() throws ReportException
StorageReportManager
cancelStorageReport
in interface StorageReportManager
ReportException
public java.lang.String scheduleStorageReport(java.util.Date startTime, long frequency) throws ReportException
StorageReportManager
scheduleStorageReport
in interface StorageReportManager
startTime
- time to start the next storage reportfrequency
- time in milliseconds to wait between reports
ReportException
public java.lang.String cancelStorageReportSchedule() throws ReportException
StorageReportManager
cancelStorageReportSchedule
in interface StorageReportManager
ReportException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |