org.rhq.enterprise.server.measurement

Interface MeasurementDataManagerRemote

All Known Subinterfaces:

MeasurementDataManagerLocal

All Known Implementing Classes:

MeasurementDataManagerBean

public interface MeasurementDataManagerRemote

Public API for measurement data.

Method Summary

Methods

Modifier and Type	Method and Description
List<org.rhq.core.domain.measurement.MeasurementDataTrait>	findCurrentTraitsForResource(org.rhq.core.domain.auth.Subject subject, int resourceId, org.rhq.core.domain.measurement.DisplayType displayType)
List<List<org.rhq.core.domain.measurement.composite.MeasurementDataNumericHighLowComposite>>	findDataForCompatibleGroup(org.rhq.core.domain.auth.Subject subject, int groupId, int definitionId, long beginTime, long endTime, int numPoints) Returns a list of numeric data point lists for the given compatible group - one per specified measurement definition (only one).
List<List<org.rhq.core.domain.measurement.composite.MeasurementDataNumericHighLowComposite>>	findDataForResource(org.rhq.core.domain.auth.Subject subject, int resourceId, int[] definitionIds, long beginTime, long endTime, int numPoints) Returns a list of numeric data point lists for the given resource - one list per specified measurement definition.
Set<org.rhq.core.domain.measurement.MeasurementData>	findLiveData(org.rhq.core.domain.auth.Subject subject, int resourceId, int[] definitionIds) Deprecated. use findDataForResource(Subject, int, int[], long, long, int)
Set<org.rhq.core.domain.measurement.MeasurementData>	findLiveDataForGroup(org.rhq.core.domain.auth.Subject subject, int groupId, int[] resourceIds, int[] definitionIds) Deprecated. use findDataForCompatibleGroup(Subject, int, int, long, long, int)
List<org.rhq.core.domain.measurement.MeasurementDataTrait>	findTraits(org.rhq.core.domain.auth.Subject subject, int resourceId, int definitionId) Return all known trait data for the passed schedule, defined by resourceId and definitionId
org.rhq.core.domain.util.PageList<org.rhq.core.domain.measurement.MeasurementDataTrait>	findTraitsByCriteria(org.rhq.core.domain.auth.Subject subject, org.rhq.core.domain.criteria.MeasurementDataTraitCriteria criteria) Finds traits that match the specified criteria.
org.rhq.core.domain.measurement.MeasurementAggregate	getAggregate(org.rhq.core.domain.auth.Subject subject, int groupId, int definitionId, long startTime, long endTime) Get the aggregate values of the numerical values for a given group and metric definition.
MeasurementAggregate	getAggregate(org.rhq.core.domain.auth.Subject subject, int scheduleId, long startTime, long endTime) Deprecated. class MeasurementAggregate has been deprecated since RHQ 4.8, therefore this method was deprecated as well and replaced by getMeasurementAggregate(org.rhq.core.domain.auth.Subject,int,long,long)
org.rhq.core.domain.measurement.MeasurementAggregate	getMeasurementAggregate(org.rhq.core.domain.auth.Subject subject, int scheduleId, long startTime, long endTime) Get the aggregate values of the numerical values for a given schedule.

Method Detail

getAggregate

@Deprecated
MeasurementAggregate getAggregate(org.rhq.core.domain.auth.Subject subject,
                                           int scheduleId,
                                           long startTime,
                                           long endTime)

Deprecated. class MeasurementAggregate has been deprecated since RHQ 4.8, therefore this method was deprecated as well and replaced by getMeasurementAggregate(org.rhq.core.domain.auth.Subject,int,long,long)

Get the aggregate values of the numerical values for a given schedule. This can only provide aggregates for data in the "live" table

Parameters:

subject - the user requesting the aggregate

scheduleId - the id of the MeasurementSchedule for which this aggregate is being requested

startTime -

endTime -

Returns:

MeasurementAggregate bean with the data

getMeasurementAggregate

org.rhq.core.domain.measurement.MeasurementAggregate getMeasurementAggregate(org.rhq.core.domain.auth.Subject subject,
                                                                           int scheduleId,
                                                                           long startTime,
                                                                           long endTime)
                                                                             throws MeasurementException

Get the aggregate values of the numerical values for a given schedule. This can only provide aggregates for data in the "live" table

Parameters:

subject - the user requesting the aggregate

scheduleId - the id of the MeasurementSchedule for which this aggregate is being requested

startTime - in millis

endTime - in millis

Returns:

MeasurementAggregate bean with the data

Throws:

MeasurementException - if the schedule does not reference numerical data or if the user is not allowed to view the Resource corresponding to this scheduleId

Since:

4.10

findTraits

List<org.rhq.core.domain.measurement.MeasurementDataTrait> findTraits(org.rhq.core.domain.auth.Subject subject,
                                                                    int resourceId,
                                                                    int definitionId)

Return all known trait data for the passed schedule, defined by resourceId and definitionId

Parameters:

subject -

resourceId - PK of a Resource

definitionId - PK of a MeasurementDefinition

Returns:

a List of MeasurementDataTrait objects.

findCurrentTraitsForResource

List<org.rhq.core.domain.measurement.MeasurementDataTrait> findCurrentTraitsForResource(org.rhq.core.domain.auth.Subject subject,
                                                                                      int resourceId,
                                                                                      org.rhq.core.domain.measurement.DisplayType displayType)

Parameters:

subject -

resourceId -

displayType -

Returns:

not null

findTraitsByCriteria

org.rhq.core.domain.util.PageList<org.rhq.core.domain.measurement.MeasurementDataTrait> findTraitsByCriteria(org.rhq.core.domain.auth.Subject subject,
                                                                                                           org.rhq.core.domain.criteria.MeasurementDataTraitCriteria criteria)

Finds traits that match the specified criteria.

Parameters:

subject - the user that is requesting the traits

criteria - the criteria by which to filter the traits

Returns:

the traits that match the specified criteria; never null

findLiveData

@Deprecated
Set<org.rhq.core.domain.measurement.MeasurementData> findLiveData(org.rhq.core.domain.auth.Subject subject,
                                                                           int resourceId,
                                                                           int[] definitionIds)

Deprecated. use findDataForResource(Subject, int, int[], long, long, int)

Parameters:

subject -

resourceId -

definitionIds -

Returns:

not null

findLiveDataForGroup

@Deprecated
Set<org.rhq.core.domain.measurement.MeasurementData> findLiveDataForGroup(org.rhq.core.domain.auth.Subject subject,
                                                                                   int groupId,
                                                                                   int[] resourceIds,
                                                                                   int[] definitionIds)

Deprecated. use findDataForCompatibleGroup(Subject, int, int, long, long, int)

Parameters:

subject -

groupId -

resourceIds -

definitionIds -

Returns:

not null

findDataForCompatibleGroup

List<List<org.rhq.core.domain.measurement.composite.MeasurementDataNumericHighLowComposite>> findDataForCompatibleGroup(org.rhq.core.domain.auth.Subject subject,
                                                                                                                      int groupId,
                                                                                                                      int definitionId,
                                                                                                                      long beginTime,
                                                                                                                      long endTime,
                                                                                                                      int numPoints)

Returns a list of numeric data point lists for the given compatible group - one per specified measurement definition (only one). The data points represent the average min/avg/max values of the members of the group.

Parameters:

subject -

groupId -

definitionId - measurement definition id for numeric metric associated with the given compatible group

beginTime -

endTime -

numPoints -

Returns:

not null

findDataForResource

List<List<org.rhq.core.domain.measurement.composite.MeasurementDataNumericHighLowComposite>> findDataForResource(org.rhq.core.domain.auth.Subject subject,
                                                                                                               int resourceId,
                                                                                                               int[] definitionIds,
                                                                                                               long beginTime,
                                                                                                               long endTime,
                                                                                                               int numPoints)

Returns a list of numeric data point lists for the given resource - one list per specified measurement definition.

Parameters:

subject -

resourceId -

definitionIds - measurement definition id for numeric metric associated with the given resource

beginTime -

endTime -

numPoints -

Returns:

not null

getAggregate

org.rhq.core.domain.measurement.MeasurementAggregate getAggregate(org.rhq.core.domain.auth.Subject subject,
                                                                int groupId,
                                                                int definitionId,
                                                                long startTime,
                                                                long endTime)

Get the aggregate values of the numerical values for a given group and metric definition.

Parameters:

subject - the user requesting the aggregate

groupId - the id of the ResourceGroup for which this aggregate is being requested

definitionId - the id of the MeasurementDefinition for the metric

startTime - in millis

endTime - in millis

Returns:

MeasurementAggregate aggregate data

Throws:

MeasurementException - if aggregate cannot be found

Since:

4.12