opendaylight/md-sal/cds-mgmt-api/src/main/java/org/opendaylight/controller/cluster/datastore/jmx/mbeans/CommitStatsMXBean.java

   1 /*
   2  * Copyright (c) 2014 Brocade Communications Systems, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.controller.cluster.datastore.jmx.mbeans;
   9
  10 import javax.management.MXBean;
  11
  12 /**
  13  * MXBean interface for retrieving write Tx commit statistics.
  14  *
  15  * @author Thomas Pantelis
  16  */
  17 @MXBean
  18 public interface CommitStatsMXBean {
  19     /**
  20      * Returns the total number of commits that have occurred.
  21      *
  22      * @return Returns the total number of commits that have occurred
  23      *
  24      */
  25     long getTotalCommits();
  26
  27     /**
  28      * Returns a string representing the time duration of the longest commit, in the appropriate
  29      * scaled units, along with the date/time that it occurred.
  30      *
  31      * @return string
  32      */
  33     String getLongestCommitTime();
  34
  35     /**
  36      * Returns a string representing the time duration of the shortest commit, in the appropriate
  37      * scaled units, along with the date/time that it occurred.
  38      *
  39      * @return string
  40      */
  41     String getShortestCommitTime();
  42
  43     /**
  44      * Returns a string representing average commit time duration, in the appropriate
  45      * scaled units.
  46      *
  47      * @return string
  48      */
  49     String getAverageCommitTime();
  50
  51     /**
  52      * Clears the current stats to their defaults.
  53      */
  54     void clearStats();
  55 }