HHH-8453 - Investigate improving DriverManager-based connection pooling

Author: sebersole

hibernate-core/src/main/java/org/hibernate/engine/jdbc/connections/internal/BasicConnectionCreator.java

@@ -0,0 +1,96 @@
+/*
+ * Hibernate, Relational Persistence for Idiomatic Java
+ *
+ * Copyright (c) 2013, Red Hat Inc. or third-party contributors as
+ * indicated by the @author tags or express copyright attribution
+ * statements applied by the authors.  All third-party contributions are
+ * distributed under license by Red Hat Inc.
+ *
+ * This copyrighted material is made available to anyone wishing to use, modify,
+ * copy, or redistribute it subject to the terms and conditions of the GNU
+ * Lesser General Public License, as published by the Free Software Foundation.
+ *
+ * This program 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 Lesser General Public License
+ * for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this distribution; if not, write to:
+ * Free Software Foundation, Inc.
+ * 51 Franklin Street, Fifth Floor
+ * Boston, MA  02110-1301  USA
+ */
+package org.hibernate.engine.jdbc.connections.internal;
+
+import java.sql.Connection;
+import java.sql.SQLException;
+import java.util.Properties;
+
+import org.hibernate.JDBCException;
+import org.hibernate.engine.jdbc.spi.JdbcServices;
+import org.hibernate.service.spi.ServiceRegistryImplementor;
+
+/**
+ * Template (as in template pattern) support for ConnectionCreator implementors.
+ *
+ * @author Steve Ebersole
+ */
+public abstract class BasicConnectionCreator implements ConnectionCreator {
+	private final ServiceRegistryImplementor serviceRegistry;
+
+	private final String url;
+	private final Properties connectionProps;
+
+	private final boolean autoCommit;
+	private final Integer isolation;
+
+	public BasicConnectionCreator(
+			ServiceRegistryImplementor serviceRegistry,
+			String url,
+			Properties connectionProps,
+			boolean autocommit,
+			Integer isolation) {
+		this.serviceRegistry = serviceRegistry;
+		this.url = url;
+		this.connectionProps = connectionProps;
+		this.autoCommit = autocommit;
+		this.isolation = isolation;
+	}
+
+	@Override
+	public String getUrl() {
+		return url;
+	}
+
+	@Override
+	public Connection createConnection() {
+		final Connection conn = makeConnection( url, connectionProps );
+
+		try {
+			if ( isolation != null ) {
+				conn.setTransactionIsolation( isolation );
+			}
+		}
+		catch (SQLException e) {
+			throw convertSqlException( "Unable to set transaction isolation (" + isolation + ")", e );
+		}
+
+		try {
+			if ( conn.getAutoCommit() != autoCommit ) {
+				conn.setAutoCommit( autoCommit );
+			}
+		}
+		catch (SQLException e) {
+			throw convertSqlException( "Unable to set auto-commit (" + autoCommit + ")", e );
+		}
+
+		return conn;
+	}
+
+	protected JDBCException convertSqlException(String message, SQLException e) {
+		return serviceRegistry.getService( JdbcServices.class ).getSqlExceptionHelper().convert( e, message, null );
+	}
+
+	protected abstract Connection makeConnection(String url, Properties connectionProps);
+}

hibernate-core/src/main/java/org/hibernate/engine/jdbc/connections/internal/ConnectionCreator.java

@@ -0,0 +1,47 @@
+/*
+ * Hibernate, Relational Persistence for Idiomatic Java
+ *
+ * Copyright (c) 2013, Red Hat Inc. or third-party contributors as
+ * indicated by the @author tags or express copyright attribution
+ * statements applied by the authors.  All third-party contributions are
+ * distributed under license by Red Hat Inc.
+ *
+ * This copyrighted material is made available to anyone wishing to use, modify,
+ * copy, or redistribute it subject to the terms and conditions of the GNU
+ * Lesser General Public License, as published by the Free Software Foundation.
+ *
+ * This program 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 Lesser General Public License
+ * for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this distribution; if not, write to:
+ * Free Software Foundation, Inc.
+ * 51 Franklin Street, Fifth Floor
+ * Boston, MA  02110-1301  USA
+ */
+package org.hibernate.engine.jdbc.connections.internal;
+
+import java.sql.Connection;
+
+/**
+ * Contract for creating JDBC Connections on demand
+ *
+ * @author Steve Ebersole
+ */
+interface ConnectionCreator {
+	/**
+	 * Obtain the URL to which this creator connects.  Intended just for informational (logging) purposes.
+	 *
+	 * @return The connection URL.
+	 */
+	public String getUrl();
+
+	/**
+	 * Create a Connection
+	 *
+	 * @return The created Connection
+	 */
+	public Connection createConnection();
+}

hibernate-core/src/main/java/org/hibernate/engine/jdbc/connections/internal/ConnectionCreatorBuilder.java

@@ -0,0 +1,79 @@
+/*
+ * Hibernate, Relational Persistence for Idiomatic Java
+ *
+ * Copyright (c) 2013, Red Hat Inc. or third-party contributors as
+ * indicated by the @author tags or express copyright attribution
+ * statements applied by the authors.  All third-party contributions are
+ * distributed under license by Red Hat Inc.
+ *
+ * This copyrighted material is made available to anyone wishing to use, modify,
+ * copy, or redistribute it subject to the terms and conditions of the GNU
+ * Lesser General Public License, as published by the Free Software Foundation.
+ *
+ * This program 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 Lesser General Public License
+ * for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this distribution; if not, write to:
+ * Free Software Foundation, Inc.
+ * 51 Franklin Street, Fifth Floor
+ * Boston, MA  02110-1301  USA
+ */
+package org.hibernate.engine.jdbc.connections.internal;
+
+import java.sql.Driver;
+import java.util.Properties;
+
+import org.hibernate.service.spi.ServiceRegistryImplementor;
+
+/**
+ * A builder for ConnectionCreator instances
+ *
+ * @author Steve Ebersole
+ */
+public class ConnectionCreatorBuilder {
+	private final ServiceRegistryImplementor serviceRegistry;
+
+	private Driver driver;
+
+	private String url;
+	private Properties connectionProps;
+
+	private boolean autoCommit;
+	private Integer isolation;
+
+	public ConnectionCreatorBuilder(ServiceRegistryImplementor serviceRegistry) {
+		this.serviceRegistry = serviceRegistry;
+	}
+
+	public void setDriver(Driver driver) {
+		this.driver = driver;
+	}
+
+	public void setUrl(String url) {
+		this.url = url;
+	}
+
+	public void setConnectionProps(Properties connectionProps) {
+		this.connectionProps = connectionProps;
+	}
+
+	public void setAutoCommit(boolean autoCommit) {
+		this.autoCommit = autoCommit;
+	}
+
+	public void setIsolation(Integer isolation) {
+		this.isolation = isolation;
+	}
+
+	public ConnectionCreator build() {
+		if ( driver == null ) {
+			return new DriverManagerConnectionCreator( serviceRegistry, url, connectionProps, autoCommit, isolation );
+		}
+		else {
+			return new DriverConnectionCreator( driver, serviceRegistry, url, connectionProps, autoCommit, isolation );
+		}
+	}
+}

hibernate-core/src/main/java/org/hibernate/engine/jdbc/connections/internal/DriverConnectionCreator.java

@@ -0,0 +1,61 @@
+/*
+ * Hibernate, Relational Persistence for Idiomatic Java
+ *
+ * Copyright (c) 2013, Red Hat Inc. or third-party contributors as
+ * indicated by the @author tags or express copyright attribution
+ * statements applied by the authors.  All third-party contributions are
+ * distributed under license by Red Hat Inc.
+ *
+ * This copyrighted material is made available to anyone wishing to use, modify,
+ * copy, or redistribute it subject to the terms and conditions of the GNU
+ * Lesser General Public License, as published by the Free Software Foundation.
+ *
+ * This program 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 Lesser General Public License
+ * for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this distribution; if not, write to:
+ * Free Software Foundation, Inc.
+ * 51 Franklin Street, Fifth Floor
+ * Boston, MA  02110-1301  USA
+ */
+package org.hibernate.engine.jdbc.connections.internal;
+
+import java.sql.Connection;
+import java.sql.Driver;
+import java.sql.SQLException;
+import java.util.Properties;
+
+import org.hibernate.service.spi.ServiceRegistryImplementor;
+
+/**
+ * A specialized ConnectionCreator which uses {@link Driver#connect} to generate Connections
+ *
+ * @author Steve Ebersole
+ */
+public class DriverConnectionCreator extends BasicConnectionCreator {
+	private final Driver driver;
+
+	public DriverConnectionCreator(
+			Driver driver,
+			ServiceRegistryImplementor serviceRegistry,
+			String url,
+			Properties connectionProps,
+			Boolean autocommit,
+			Integer isolation) {
+		super( serviceRegistry, url, connectionProps, autocommit, isolation );
+		this.driver = driver;
+	}
+
+	@Override
+	protected Connection makeConnection(String url, Properties connectionProps) {
+		try {
+			return driver.connect( url, connectionProps );
+		}
+		catch (SQLException e) {
+			throw convertSqlException( "Error calling Driver#connect", e );
+		}
+	}
+}

hibernate-core/src/main/java/org/hibernate/engine/jdbc/connections/internal/DriverManagerConnectionCreator.java

@@ -0,0 +1,57 @@
+/*
+ * Hibernate, Relational Persistence for Idiomatic Java
+ *
+ * Copyright (c) 2013, Red Hat Inc. or third-party contributors as
+ * indicated by the @author tags or express copyright attribution
+ * statements applied by the authors.  All third-party contributions are
+ * distributed under license by Red Hat Inc.
+ *
+ * This copyrighted material is made available to anyone wishing to use, modify,
+ * copy, or redistribute it subject to the terms and conditions of the GNU
+ * Lesser General Public License, as published by the Free Software Foundation.
+ *
+ * This program 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 Lesser General Public License
+ * for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this distribution; if not, write to:
+ * Free Software Foundation, Inc.
+ * 51 Franklin Street, Fifth Floor
+ * Boston, MA  02110-1301  USA
+ */
+package org.hibernate.engine.jdbc.connections.internal;
+
+import java.sql.Connection;
+import java.sql.DriverManager;
+import java.sql.SQLException;
+import java.util.Properties;
+
+import org.hibernate.service.spi.ServiceRegistryImplementor;
+
+/**
+ * A specialized ConnectionCreator which uses {@link DriverManager#getConnection} to generate Connections
+ *
+ * @author Steve Ebersole
+ */
+public class DriverManagerConnectionCreator extends BasicConnectionCreator {
+	public DriverManagerConnectionCreator(
+			ServiceRegistryImplementor serviceRegistry,
+			String url,
+			Properties connectionProps,
+			Boolean autocommit,
+			Integer isolation) {
+		super( serviceRegistry, url, connectionProps, autocommit, isolation );
+	}
+
+	@Override
+	protected Connection makeConnection(String url, Properties connectionProps) {
+		try {
+			return DriverManager.getConnection( url, connectionProps );
+		}
+		catch (SQLException e) {
+			throw convertSqlException( "Error calling DriverManager#getConnection", e );
+		}
+	}
+}