oracle.axia.api.management.stats

Interface StatisticsServiceMBean

public interface StatisticsServiceMBean

MBean exposed for management of the Statistics Service.

Author:

Copyright (c) 2009 by Oracle Corp. All Rights Reserved.

Method Summary

Modifier and Type	Method and Description
void	deleteCountsBefore(java.lang.String dateTime) Deletes statistics prior to the date-times described.
java.util.Map<java.lang.String,java.lang.Long>	retrieveAllAggregatedCurrentCounts() Retrieves all aggregated current counts, i.e.
java.util.Map<StatsCollectionInfo,java.util.Map<java.lang.String,java.lang.Long>>	retrieveAllCountsBetween(java.lang.String fromDateTime, java.lang.String toDateTime, java.lang.String serverName) Retrieves statistics collection info counts where the collection period began between the date-times described, optionally filtered by server.
java.util.Map<MonitoringGroup,java.util.List<java.util.Map<java.lang.String,java.lang.Long>>>	retrieveAllCurrentCounts() Retrieves all current counts, grouped by MonitoringGroup.
java.util.Map<StatsCollectionInfo,java.util.Map<java.lang.String,java.lang.Long>>	retrieveBundleCountsBetween(java.lang.String bundleName, java.lang.String fromDateTime, java.lang.String toDateTime, java.lang.String serverName) Retrieves statistics collection info counts where the collection period began between the date-times described, filtered by bundle and optionally server.
java.util.Map<MonitoringGroup,java.util.List<java.util.Map<java.lang.String,java.lang.Long>>>	retrieveBundleCurrentCounts(java.lang.String bundleName) Retrieves current counts, grouped by MonitoringGroup, filtered by bundleName.
CollectionPeriodInfo	retrieveCurrentCollectionPeriodInfo() Retrieves collection period info for the current collection period.
java.util.List<MonitoringGroup>	retrieveMonitoringGroups() Lists all monitoring groups.

Method Detail

retrieveMonitoringGroups

java.util.List<MonitoringGroup> retrieveMonitoringGroups()

Lists all monitoring groups.

Returns:

List all unique MonitoringGroups

retrieveAllCurrentCounts

java.util.Map<MonitoringGroup,java.util.List<java.util.Map<java.lang.String,java.lang.Long>>> retrieveAllCurrentCounts()

Retrieves all current counts, grouped by MonitoringGroup.

Returns:

Map>> all current counts of statistics-category-description to Long, grouped by MonitoringGroup

retrieveBundleCurrentCounts

java.util.Map<MonitoringGroup,java.util.List<java.util.Map<java.lang.String,java.lang.Long>>> retrieveBundleCurrentCounts(java.lang.String bundleName)

Retrieves current counts, grouped by MonitoringGroup, filtered by bundleName.

Parameters:

bundleName - the name required of MonitoringGroup's bundle

Returns:

Map>> all current counts of statistics-category-description to Long, grouped by (matching) MonitoringGroup

retrieveAllCountsBetween

java.util.Map<StatsCollectionInfo,java.util.Map<java.lang.String,java.lang.Long>> retrieveAllCountsBetween(java.lang.String fromDateTime,
                                                                                                           java.lang.String toDateTime,
                                                                                                           java.lang.String serverName)
                                                                                                    throws java.text.ParseException

Retrieves statistics collection info counts where the collection period began between the date-times described, optionally filtered by server. Date formats are "yyyy-MM-dd HH:mm", e.g. "2010-11-12 17:33"

Parameters:

fromDateTime - Date-time string after which earliest collection period would have started, inclusive, yyyy-MM-dd HH:mm format.

toDateTime - Date-time string before which latest collection period would have started, exclusive, yyyy-MM-dd HH:mm format.

serverName - (optional) name of server on which stats were collected

Returns:

Map> statistics collection info counts where the collection period began within [ fromDateTime, toDateTime ], optionally filtered by server

Throws:

java.text.ParseException - if either date-time string has invalid syntax

retrieveBundleCountsBetween

java.util.Map<StatsCollectionInfo,java.util.Map<java.lang.String,java.lang.Long>> retrieveBundleCountsBetween(java.lang.String bundleName,
                                                                                                              java.lang.String fromDateTime,
                                                                                                              java.lang.String toDateTime,
                                                                                                              java.lang.String serverName)
                                                                                                       throws java.text.ParseException

Retrieves statistics collection info counts where the collection period began between the date-times described, filtered by bundle and optionally server. Date formats are "yyyy-MM-dd HH:mm", e.g. "2010-11-12 17:33"

Parameters:

bundleName - the name required of MonitoringGroup's bundle

fromDateTime - Date-time string after which earliest collection period would have started, inclusive, yyyy-MM-dd HH:mm format.

toDateTime - Date-time string before which latest collection period would have started, exclusive, yyyy-MM-dd HH:mm format.

serverName - the (optional) name of server on which stats were collected

Returns:

Map> statistics collection info counts where the collection period began within [ fromDateTime, toDateTime ], filtered by bundle and optionally server

Throws:

java.text.ParseException - if either date-time string has invalid syntax

deleteCountsBefore

void deleteCountsBefore(java.lang.String dateTime)
                 throws java.text.ParseException

Deletes statistics prior to the date-times described. Date formats are "yyyy-MM-dd HH:mm", e.g. "2010-11-12 17:33"

Parameters:

dateTime - Date-time string before which collection period statistics should be deleted, inclusive, yyyy-MM-dd HH:mm format.

Throws:

java.text.ParseException - if the date-time string has invalid syntax

retrieveAllAggregatedCurrentCounts

java.util.Map<java.lang.String,java.lang.Long> retrieveAllAggregatedCurrentCounts()

Retrieves all aggregated current counts, i.e. not grouped by MonitoringGroup.

Returns:

Map all aggregated current counts of statistics-category-description to Long

retrieveCurrentCollectionPeriodInfo

CollectionPeriodInfo retrieveCurrentCollectionPeriodInfo()

Retrieves collection period info for the current collection period.

Returns:

CollectionPeriodInfo (estimated) information for the current collection period