Skip navigation links

waggle.common.modules.systemreport
Interface XSystemReportModule.Server

All Superinterfaces:

XAPIInterface, XAPIInterface.Server

Enclosing interface:

XSystemReportModule

public static interface XSystemReportModule.Server

extends XAPIInterface.Server

Server interface for the System Report Module API.

Nested Class Summary

Nested classes/interfaces inherited from interface waggle.core.api.XAPIInterface

XAPIInterface.Client, XAPIInterface.Server

Method Summary

XSystemReportInfo	createSystemReport(Date fromDate, Date toDate, boolean limit) Create a system report for the specified interval.
List<XSystemReportHistoricalInfo>	getHistoricalData(Date fromDate, Date toDate, String rrdName, String mbeanCanonicalObjectName, String mbeanAttributeName) Get historical data for a single mbean attribute.

Method Detail

createSystemReport

XSystemReportInfo createSystemReport(Date fromDate,
                                     Date toDate,
                                     boolean limit)

Create a system report for the specified interval.

Parameters:

fromDate - the starting time stamp

toDate - the ending time stamp

limit - limit result records to those records that have non-zero values within the range of the report

Returns:

the system report

getHistoricalData

List<XSystemReportHistoricalInfo> getHistoricalData(Date fromDate,
                                                    Date toDate,
                                                    String rrdName,
                                                    String mbeanCanonicalObjectName,
                                                    String mbeanAttributeName)

Get historical data for a single mbean attribute.

Parameters:

fromDate - starting date

toDate - ending date

rrdName - the name of the RRD

mbeanCanonicalObjectName - the mbean canonical ObjectName

mbeanAttributeName - the mbean attribute name

Returns:

the data samples in the specified range

Skip navigation links