org.duracloud.client.report
Class ServiceReportManagerImpl

java.lang.Object
  extended by org.duracloud.client.report.BaseReportManager
      extended by org.duracloud.client.report.ServiceReportManagerImpl
All Implemented Interfaces:
ServiceReportManager, org.duracloud.common.model.Securable

public class ServiceReportManagerImpl
extends BaseReportManager
implements ServiceReportManager


Field Summary
 
Fields inherited from class org.duracloud.client.report.BaseReportManager
restHelper
 
Constructor Summary
ServiceReportManagerImpl(java.lang.String host, java.lang.String port)
           
ServiceReportManagerImpl(java.lang.String host, java.lang.String port, java.lang.String context)
           
 
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 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.common.model.Securable
login, logout
 

Constructor Detail

ServiceReportManagerImpl

public ServiceReportManagerImpl(java.lang.String host,
                                java.lang.String port)

ServiceReportManagerImpl

public ServiceReportManagerImpl(java.lang.String host,
                                java.lang.String port,
                                java.lang.String context)
Method Detail

getDeployedServicesReport

public java.util.List<org.duracloud.serviceconfig.ServiceSummary> getDeployedServicesReport()
                                                                                     throws ReportException
Description copied from interface: ServiceReportManager
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).

Specified by:
getDeployedServicesReport in interface ServiceReportManager
Returns:
list of deployed services
Throws:
ReportException

getCompletedServicesReport

public java.util.List<org.duracloud.serviceconfig.ServiceSummary> getCompletedServicesReport()
                                                                                      throws ReportException
Description copied from interface: ServiceReportManager
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.

Specified by:
getCompletedServicesReport in interface ServiceReportManager
Returns:
list of the most recent completed services
Throws:
ReportException

getCompletedServicesReport

public java.util.List<org.duracloud.serviceconfig.ServiceSummary> getCompletedServicesReport(int limit)
                                                                                      throws ReportException
Description copied from interface: ServiceReportManager
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.

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

getCompletedServicesReportList

public java.util.List<java.lang.String> getCompletedServicesReportList()
                                                                throws ReportException
Description copied from interface: ServiceReportManager
Retrieves the list of all service report files which have been created.

Specified by:
getCompletedServicesReportList in interface ServiceReportManager
Returns:
list of service report Ids
Throws:
ReportException

getCompletedServicesReport

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

Specified by:
getCompletedServicesReport in interface ServiceReportManager
Returns:
Throws:
NotFoundException
ReportException


Copyright © 2009-2011 DuraSpace. All Rights Reserved.