org.opendaylight.aaa.datastore.h2.ConnectionProvider Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of aaa-docs Show documentation

AAA documentation

There is a newer version: 0.20.3

/*
 * Copyright (c) 2016 Red Hat, Inc. and others. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
 * and is available at http://www.eclipse.org/legal/epl-v10.html
 */
package org.opendaylight.aaa.datastore.h2;

import java.sql.Connection;
import javax.sql.CommonDataSource;
import javax.sql.DataSource;

/**
 * Provider of JDBC Connections. Essentially a much simplified {@link DataSource} -- sans the {@link CommonDataSource}
 * bits, which are a hassle.
 *
 * @author Michael Vorburger
 */
public interface ConnectionProvider {
    /**
     * Get an SQL {@link Connection}.
     *
     * @return a connection from this Factory; it may be a brand new one obtained from the JDBC Driver, or an existing
     *         open one, if it has not previously been closed
     * @throws StoreException if no Connection could be obtained
     */
    // FIXME: what is the blocking behaviour?
    Connection getConnection() throws StoreException;
}