Skip navigation links

Oracle Communications Service Broker Configuration and Runtime MBean Java API Referencee
6.1

E38079-01


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

 

Method Detail

retrieveMonitoringGroups

List<MonitoringGroup> retrieveMonitoringGroups()
Lists all monitoring groups.
Returns:
List<MonitoringGroup> all unique MonitoringGroups

retrieveAllCurrentCounts

Map<MonitoringGroup,List<Map<String,Long>>> retrieveAllCurrentCounts()
Retrieves all current counts, grouped by MonitoringGroup.
Returns:
Map<MonitoringGroup, List>> all current counts of statistics-category-description to Long, grouped by MonitoringGroup

retrieveBundleCurrentCounts

Map<MonitoringGroup,List<Map<String,Long>>> retrieveBundleCurrentCounts(String bundleName)
Retrieves current counts, grouped by MonitoringGroup, filtered by bundleName.
Parameters:
bundleName - the name required of MonitoringGroup's bundle
Returns:
Map<MonitoringGroup, List>> all current counts of statistics-category-description to Long, grouped by (matching) MonitoringGroup

retrieveAllCountsBetween

Map<StatsCollectionInfo,Map<String,Long>> retrieveAllCountsBetween(String fromDateTime,
                                                                   String toDateTime,
                                                                   String serverName)
                                                                   throws 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<StatsCollectionInfo, Map<String, Long>> statistics collection info counts where the collection period began within [ fromDateTime, toDateTime ], optionally filtered by server
Throws:
ParseException - if either date-time string has invalid syntax

retrieveBundleCountsBetween

Map<StatsCollectionInfo,Map<String,Long>> retrieveBundleCountsBetween(String bundleName,
                                                                      String fromDateTime,
                                                                      String toDateTime,
                                                                      String serverName)
                                                                      throws 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<StatsCollectionInfo, Map<String, Long>> statistics collection info counts where the collection period began within [ fromDateTime, toDateTime ], filtered by bundle and optionally server
Throws:
ParseException - if either date-time string has invalid syntax

deleteCountsBefore

void deleteCountsBefore(String dateTime)
                        throws 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:
ParseException - if the date-time string has invalid syntax

retrieveAllAggregatedCurrentCounts

Map<String,Long> retrieveAllAggregatedCurrentCounts()
Retrieves all aggregated current counts, i.e. not grouped by MonitoringGroup.
Returns:
Map<String, Long> 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

Skip navigation links

Oracle Communications Service Broker Configuration and Runtime MBean Java API Referencee
6.1

E38079-01


Copyright © 2013, Oracle and/or its affiliates. All rights reserved.