org.duracloud.client.report
Interface ServiceReportManager

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

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


Method Summary
 java.util.List<org.duracloud.serviceconfig.ServiceSummary> getCompletedServicesReport()
          Retrieves a listing of completed services up to the default limit (currently 20).
 java.util.List<org.duracloud.serviceconfig.ServiceSummary> getCompletedServicesReport(int limit)
          Retrieves a listing of completed services, including as many services as have completed up to the provided limit.
 java.util.List<org.duracloud.serviceconfig.ServiceSummary> getCompletedServicesReport(java.lang.String reportId)
          Retrieves a specific service report by ID.
 java.util.List<java.lang.String> getCompletedServicesReportList()
          Retrieves the list of all service report files which have been created.
 java.util.List<org.duracloud.serviceconfig.ServiceSummary> getDeployedServicesReport()
          Retrieves a listing of services which are currently deployed in DuraCloud.
 
Methods inherited from interface org.duracloud.common.model.Securable
login, logout
 

Method Detail

getDeployedServicesReport

java.util.List<org.duracloud.serviceconfig.ServiceSummary> getDeployedServicesReport()
                                                                                     throws ReportException
Retrieves a listing of services which are currently deployed in DuraCloud. The returned list can include services which are in process, services which have completed, and services which are long running (i.e. will never complete).

Returns:
list of deployed services
Throws:
ReportException

getCompletedServicesReport

java.util.List<org.duracloud.serviceconfig.ServiceSummary> getCompletedServicesReport()
                                                                                      throws ReportException
Retrieves a listing of completed services up to the default limit (currently 20). The returned list is sorted based on update (completed/started) time, with the most recent at the top of the list.

Returns:
list of the most recent completed services
Throws:
ReportException

getCompletedServicesReport

java.util.List<org.duracloud.serviceconfig.ServiceSummary> getCompletedServicesReport(int limit)
                                                                                      throws ReportException
Retrieves a listing of completed services, including as many services as have completed up to the provided limit. If the provided limit is 0 or less, or over 1000, the default limit (currently 20) is used. The returned list is sorted based on update (completed/started) time, with the most recent at the top of the list.

Parameters:
limit - the maximum number of services to be included in the list
Returns:
list of the most recent completed services
Throws:
ReportException

getCompletedServicesReportList

java.util.List<java.lang.String> getCompletedServicesReportList()
                                                                throws ReportException
Retrieves the list of all service report files which have been created.

Returns:
list of service report Ids
Throws:
ReportException

getCompletedServicesReport

java.util.List<org.duracloud.serviceconfig.ServiceSummary> getCompletedServicesReport(java.lang.String reportId)
                                                                                      throws NotFoundException,
                                                                                             ReportException
Retrieves a specific service report by ID. Each service report will contain a listing of all services which completed within a limited time block.

Parameters:
reportId -
Returns:
Throws:
NotFoundException
ReportException


Copyright © 2009-2011 DuraSpace. All Rights Reserved.