com.greenpepper.internal.ch.qos.logback.core.db.ConnectionSource Maven / Gradle / Ivy
/**
* Logback: the reliable, generic, fast and flexible logging framework.
* Copyright (C) 1999-2015, QOS.ch. All rights reserved.
*
* This program and the accompanying materials are dual-licensed under
* either the terms of the Eclipse Public License v1.0 as published by
* the Eclipse Foundation
*
* or (per the licensee's choosing)
*
* under the terms of the GNU Lesser General Public License version 2.1
* as published by the Free Software Foundation.
*/
package com.greenpepper.internal.com.greenpepper.internal.ch.qos.logback.core.db;
import java.sql.Connection;
import java.sql.SQLException;
import com.greenpepper.internal.com.greenpepper.internal.ch.qos.logback.core.db.dialect.SQLDialectCode;
import com.greenpepper.internal.com.greenpepper.internal.ch.qos.logback.core.spi.LifeCycle;
/**
* The ConnectionSource interface provides a pluggable means of
* transparently obtaining JDBC {@link java.sql.Connection}s for logback classes
* that require the use of a {@link java.sql.Connection}.
*
* For more information about this component, please refer to the online manual at
* http://logback.qos.ch/manual/appenders.html#DBAppender
*
* @author Ray DeCampo
*/
public interface ConnectionSource extends LifeCycle {
/**
* Obtain a {@link java.sql.Connection} for use. The client is
* responsible for closing the {@link java.sql.Connection} when it is no
* longer required.
*
* @throws SQLException if a {@link java.sql.Connection} could not be
* obtained
*/
Connection getConnection() throws SQLException;
/**
* Get the SQL dialect that should be used for this connection. Note that the
* dialect is not needed if the JDBC driver supports the getGeneratedKeys
* method.
*/
SQLDialectCode getSQLDialectCode();
/**
* If the connection supports the JDBC 3.0 getGeneratedKeys method, then
* we do not need any specific dialect support.
*/
boolean supportsGetGeneratedKeys();
/**
* If the connection does not support batch updates, we will avoid using them.
*/
boolean supportsBatchUpdates();
}