patterntesting.runtime.monitor.db.ConnectionMonitorMBean Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of patterntesting-rt Show documentation

PatternTesting Runtime (patterntesting-rt) is the runtime component for the PatternTesting framework. It provides the annotations and base classes for the PatternTesting testing framework (e.g. patterntesting-check, patterntesting-concurrent or patterntesting-exception) but can be also used standalone for classpath monitoring or profiling. It uses AOP and AspectJ to perform this feat.

There is a newer version: 2.4.0

Show newest version

package patterntesting.runtime.monitor.db;

import javax.management.openmbean.*;

import patterntesting.runtime.jmx.Description;

/**
 * This is the interface for the {@link ConnectionMonitor} for the use of this
 * class as MBean. You can monitor DB connections with it and ask the class for
 * open connections.
 * 
 * Note: Since 1.4.2 this class was moved from package
 * "patterntesting.runtime.db" to here.
 * 
 *
 * @author oliver ([email protected])
 * @since 1.3 (02-Jan-2013)
 * @version $Revision: 1.3 $
 */
public interface ConnectionMonitorMBean {

    /**
     * Gets the caller of all connections.
     *
     * @return all callers
     */
    @Description("get the caller of the open connections")
    public abstract StackTraceElement[] getCallers();

    /**
     * Gets the caller stacktraces of all connections.
     *
     * @return stacktraces of all callers
     * @throws OpenDataException the open data exception
     */
    @Description("get the caller of the open connections")
    public abstract TabularData getCallerStacktraces() throws OpenDataException;

    /**
     * Gets the caller which opens the last connection.
     *
     * @return the all caller
     */
    @Description("get the caller of the last open connection")
    public abstract StackTraceElement getLastCaller();


    /**
     * Gets the stacktrace of the caller which opens the last connection.
     *
     * @return the all caller
     */
    @Description("get the call stacktrace of the last open connection")
    public abstract StackTraceElement[] getLastCallerStacktrace();

    /**
     * Gets the number of open connections.
     * 
     * Note: Till 1.4.0 this method was named "getCount()".
     * 
     *
     * @return the number of open connections
     */
    @Description("get the number of open connections")
    public abstract int getOpenConnections();

    /**
     * Gets the closed connections.
     *
     * @return the closed connections
     * @since 1.4.1
     */
    @Description("get the number of closed connections")
    public abstract int getClosedConnections();

    /**
     * Gets the total sum of open and closed connections.
     *
     * @return the sum of connections
     * @since 1.4.1
     */
    @Description("get the total sum of open and closed connections")
    public abstract int getSumOfConnections();

}