patterntesting.runtime.monitor.db.ConnectionMonitor 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.5.0

Show newest version

/*
 * $Id: ConnectionMonitor.java,v 1.17 2016/12/18 20:19:38 oboehm Exp $
 *
 * Copyright (c) 2012 by Oliver Boehm
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express orimplied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * (c)reated 07.10.2012 by oliver ([email protected])
 */

package patterntesting.runtime.monitor.db;

import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;

import java.sql.Connection;
import java.util.List;
import java.util.concurrent.CopyOnWriteArrayList;

/**
 * This is the monitor class for the {@link ProxyConnection} which monitors the
 * different newInstance() and close() calls. So you can ask this class how many
 * connections and which connections are open.
 * 
 * The instance of this class is automatically registered as MBean as soon as a
 * {@link ProxyConnection} is used.
 * 
 * 
 * Note: Since 1.4.2 this class was moved from package
 * "patterntesting.runtime.db" to here.
 * 
 *
 * @author oliver ([email protected])
 * @version $Revision: 1.17 $
 * @since 1.3 (07.10.2012)
 * @deprecated since 2.0, use {@link clazzfish.jdbc.ConnectionMonitor}
 */
@Deprecated
public class ConnectionMonitor extends clazzfish.jdbc.ConnectionMonitor implements ConnectionMonitorMBean {

	private static final Logger LOG = LogManager.getLogger(ConnectionMonitor.class);
	private static final ConnectionMonitor INSTANCE;
	private static final List openConnections = new CopyOnWriteArrayList<>();

	private static int sumOfConnections = 0;

	static {
		INSTANCE = new ConnectionMonitor();
	}

	/**
	 * No need to instantiate it - we provide only some services. The
	 * constructor is protected because it is still used by the (deprecated)
	 * ConnectionMonitor in patterntesting.runtime.db.
	 */
	protected ConnectionMonitor() {
		super();
		LOG.trace("New instance of {} created.", ConnectionMonitor.class);
	}

	/**
	 * Yes, it is a Singleton because it offers only some services. So we don't
	 * need the object twice.
	 *
	 * @return the only instance
	 */
	public static ConnectionMonitor getInstance() {
		return INSTANCE;
	}

	/**
	 * If you want to monitor the connection use this method.
	 *
	 * @param connection
	 *            the original connection
	 * @return a proxy for the connection
	 */
	public static Connection getMonitoredConnection(final Connection connection) {
		return ProxyConnection.newInstance(connection);
	}

	/**
	 * Adds the connection to the list of open connections.
	 *
	 * @param proxyConnection
	 *            the proxy connection
	 */
	public static void addConnection(final ProxyConnection proxyConnection) {
		openConnections.add(proxyConnection);
		sumOfConnections++;
	}

	/**
	 * Removes the connection from the list of open connections.
	 *
	 * @param proxyConnection
	 *            the proxy connection
	 */
	public static void removeConnection(final ProxyConnection proxyConnection) {
		openConnections.remove(proxyConnection);
	}

	/**
	 * Gets the caller of the given connection.
	 *
	 * @param connection
	 *            the connection
	 * @return the caller of the connection
	 */
	public static StackTraceElement getCallerOf(final Connection connection) {
		return clazzfish.jdbc.ConnectionMonitor.getCallerOf(connection);
	}

	/**
	 * Assert that all connections are closed.
	 */
	public static void assertConnectionsClosed() {
		clazzfish.jdbc.ConnectionMonitor.assertConnectionsClosed();
	}

}