com.jolbox.bonecp.ConnectionStrategy Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of bonecp Show documentation

Lightweight connection pool.

There is a newer version: 0.8.0.RELEASE

/**
 *  Copyright 2010 Wallace Wadge
 *
 *    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 or implied.
 *    See the License for the specific language governing permissions and
 *    limitations under the License.
 */

package com.jolbox.bonecp;

import java.sql.Connection;
import java.sql.SQLException;

/**
 * Marker interface.
 * @author wallacew
 *
 */
public interface ConnectionStrategy {
	
	/** Obtains a connection using the configured strategy. Main entry point. 
	 * @return Connection
	 * @throws SQLException on error
	 */
	Connection getConnection() throws SQLException;
	
	/** Obtains a connection using the configured strategy without blocking.
	 * @return Connection
	 */
	Connection pollConnection();

	/** Destroys all connections using this strategy.
	 */
	void terminateAllConnections();
	
	/** Give a chance to do some cleanups before closing off the connection. */
	void cleanupConnection(ConnectionHandle oldHandle, ConnectionHandle newHandle);

}