SinkModuleMXBean.java

package org.marketcetera.module;

import org.marketcetera.util.misc.ClassVersion;

import javax.management.MXBean;
import java.util.Map;

/* $License$ */
/**
 * The management / monitoring interface for the sink module.
 *
 * @author anshul@marketcetera.com
 * @version $Id: SinkModuleMXBean.java 16154 2012-07-14 16:34:05Z colin $
 * @since 1.0.0
 */
@ClassVersion("$Id: SinkModuleMXBean.java 16154 2012-07-14 16:34:05Z colin $")  //$NON-NLS-1$
@MXBean(true)
@DisplayName("Sink Module")
public interface SinkModuleMXBean {
    /**
     * Returns statistics on various types of data received by
     * the sink module.
     * The map has the data type name as the key and a counter of number
     * of instances that have been received by the sink module as the value
     *
     * @return map containing statistics on the different types of data
     * received by the module
     */
    @DisplayName("Statistics based on data types")
    Map<String, Integer> getTypeStats();

    /**
     * Returns statistics on the number of data instances received by
     * the sink module for different data flows.
     * The map has the data flow ID as they key and a counter of
     * number of data instances received for that data flow as a value.
     *
     * @return map containing statistics on the number of data instances
     * received by the sink module for different data flows.
     */
    @DisplayName("Statistics based on data flows")
    Map<DataFlowID, Integer> getDataFlowStats();

    /**
     * Resets the statistics for data flows and data types.
     */
    @DisplayName("Reset all statistics")  
    void resetStats();
}