is.codion.common.db.pool.ConnectionPoolFactory Maven / Gradle / Ivy

Go to download
/*
 * This file is part of Codion.
 *
 * Codion is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Codion is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Codion.  If not, see .
 *
 * Copyright (c) 2013 - 2024, Björn Darri Sigurðsson.
 */
package is.codion.common.db.pool;

import is.codion.common.db.connection.ConnectionFactory;
import is.codion.common.db.exception.DatabaseException;
import is.codion.common.user.User;

import java.util.ServiceConfigurationError;
import java.util.ServiceLoader;

import static java.util.Objects.requireNonNull;
import static java.util.stream.StreamSupport.stream;

/**
 * Provides connection pool implementations
 */
public interface ConnectionPoolFactory {

	/**
	 * Creates a connection pool wrapper based on the given database and user.
	 * @param connectionFactory the connection factory
	 * @param user the user to base the pooled connections on
	 * @return a connection pool wrapper based on the given user
	 * @throws DatabaseException in case of an exception
	 */
	ConnectionPoolWrapper createConnectionPool(ConnectionFactory connectionFactory, User user);

	/**
	 * Returns the {@link ConnectionPoolFactory} implementation found by the {@link ServiceLoader}
	 * of the given type.
	 * @param classname the classname of the required connection pool factory
	 * @return a {@link ConnectionPoolFactory} implementation of the given type from the {@link ServiceLoader}.
	 * @throws IllegalStateException in case no such {@link ConnectionPoolFactory} implementation is available.
	 */
	static ConnectionPoolFactory instance(String classname) {
		requireNonNull(classname);
		try {
			return stream(ServiceLoader.load(ConnectionPoolFactory.class).spliterator(), false)
							.filter(factory -> factory.getClass().getName().equals(classname))
							.findFirst()
							.orElseThrow(() -> new IllegalStateException("No connection pool factory of type: " + classname + " available"));
		}
		catch (ServiceConfigurationError e) {
			Throwable cause = e.getCause();
			if (cause instanceof RuntimeException) {
				throw (RuntimeException) cause;
			}
			throw new RuntimeException(cause);
		}
	}

	/**
	 * Returns the first {@link ConnectionPoolFactory} implementation found by the {@link ServiceLoader}.
	 * @return a {@link ConnectionPoolFactory} implementation from the {@link ServiceLoader}.
	 * @throws IllegalStateException in case no {@link ConnectionPoolFactory} implementation is available.
	 */
	static ConnectionPoolFactory instance() {
		try {
			return stream(ServiceLoader.load(ConnectionPoolFactory.class).spliterator(), false)
							.findFirst()
							.orElseThrow(() -> new IllegalStateException("No connection pool factory available"));
		}
		catch (ServiceConfigurationError e) {
			Throwable cause = e.getCause();
			if (cause instanceof RuntimeException) {
				throw (RuntimeException) cause;
			}
			throw new RuntimeException(cause);
		}
	}
}