org.arp.javautil.sql.ConnectionSpec Maven / Gradle / Ivy

Go to download

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

JavaUtil is a utility library to speed the development of Java software. We developed it over multiple years during our internal development efforts, and it has reached a point of stability where we have decided to make it available to the outside world. The JavaUtil package aims to fill in the gaps of the Apache Commons and similar utility libraries out there. Features include convenience classes for string, collections, arrays, dates, iterators, colors, logging, unit testing, a little bit of basic statistics, database queries, caching and more.

The newest version!

/*
 * #%L
 * JavaUtil
 * %%
 * Copyright (C) 2012 - 2013 Emory University
 * %%
 * 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.
 * #L%
 */
package org.arp.javautil.sql;

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

/**
 * Provides an interface for getting a connection to a relational database.
 *
 * @author Andrew Post
 */
public interface ConnectionSpec {
    /**
     * Returns a connection to a SQL database that may be new or part of a
     * connection pool.
     *
     * @return a {@link Connection}.
     * @throws SQLException if an error occurs getting the connection.
     */
    Connection getOrCreate() throws SQLException;
    
    boolean isAutoCommitEnabled();
    
    DatabaseProduct getDatabaseProduct() throws SQLException;
    
    DatabaseVersion getDatabaseVersion() throws SQLException;
    
    Driver getDriver() throws SQLException;
    
    DriverVersion getDriverVersion() throws SQLException;

    /**
     * Performs some processing on this connection spec.
     *
     * @param connectionSpecVisitor
     *            a {@link ConnectionSpecVisitor}.
     */
    void accept(ConnectionSpecVisitor connectionSpecVisitor);
}