deprecating class loading in the DriverDataSource
Project: http://git-wip-us.apache.org/repos/asf/cayenne/repo Commit: http://git-wip-us.apache.org/repos/asf/cayenne/commit/00dc7211 Tree: http://git-wip-us.apache.org/repos/asf/cayenne/tree/00dc7211 Diff: http://git-wip-us.apache.org/repos/asf/cayenne/diff/00dc7211 Branch: refs/heads/master Commit: 00dc7211985f4d6c84c3aeabde346ad35afa9efe Parents: 6b79b82 Author: aadamchik <aadamc...@apache.org> Authored: Mon May 18 15:08:48 2015 +0300 Committer: aadamchik <aadamc...@apache.org> Committed: Mon May 18 15:11:26 2015 +0300 ---------------------------------------------------------------------- .../cayenne/datasource/DriverDataSource.java | 489 +++++++++---------- .../datasource/DriverDataSourceTest.java | 44 -- 2 files changed, 232 insertions(+), 301 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/cayenne/blob/00dc7211/cayenne-server/src/main/java/org/apache/cayenne/datasource/DriverDataSource.java ---------------------------------------------------------------------- diff --git a/cayenne-server/src/main/java/org/apache/cayenne/datasource/DriverDataSource.java b/cayenne-server/src/main/java/org/apache/cayenne/datasource/DriverDataSource.java index af096dc..3dda4b4 100644 --- a/cayenne-server/src/main/java/org/apache/cayenne/datasource/DriverDataSource.java +++ b/cayenne-server/src/main/java/org/apache/cayenne/datasource/DriverDataSource.java @@ -30,269 +30,244 @@ import java.util.logging.Logger; import javax.sql.DataSource; +import org.apache.cayenne.CayenneRuntimeException; import org.apache.cayenne.log.JdbcEventLogger; import org.apache.cayenne.util.Util; /** * A non-pooling DataSource implementation wrapping a JDBC driver. - * */ public class DriverDataSource implements DataSource { - protected Driver _driver; - protected String driverClassName; - - protected String connectionUrl; - protected String userName; - protected String password; - - protected JdbcEventLogger logger; - - /** - * Loads JDBC driver using current thread class loader. - * - * @since 3.0 - * @deprecated since 4.0 as class loading should not happen here. - */ - @Deprecated - private static Driver loadDriver(String driverClassName) throws SQLException { - - Class<?> driverClass; - try { - driverClass = Util.getJavaClass(driverClassName); - } - catch (Exception ex) { - throw new SQLException("Can not load JDBC driver named '" - + driverClassName - + "': " - + ex.getMessage()); - } - - try { - return (Driver) driverClass.newInstance(); - } - catch (Exception ex) { - throw new SQLException("Error instantiating driver '" - + driverClassName - + "': " - + ex.getMessage()); - } - } - - /** - * Creates a new DriverDataSource. If "driverClassName" is null, DriverDataSource will - * consult DriverManager for a registered driver for the given URL. So when specifying - * null, a user must take care of registering the driver. "connectionUrl" on the other - * hand must NOT be null. - */ - public DriverDataSource(String driverClassName, String connectionUrl) { - this(driverClassName, connectionUrl, null, null); - } - - /** - * Creates a new DriverDataSource. If "driverClassName" is null, DriverDataSource will - * consult DriverManager for a registered driver for the given URL. So when specifying - * null, a user must take care of registering the driver. "connectionUrl" on the other - * hand must NOT be null. - * - * @since 3.0 - */ - public DriverDataSource(String driverClassName, String connectionUrl, - String userName, String password) { - - setDriverClassName(driverClassName); - - this.connectionUrl = connectionUrl; - this.userName = userName; - this.password = password; - } - - /** - * Creates a new DriverDataSource wrapping a given Driver. If "driver" is null, - * DriverDataSource will consult DriverManager for a registered driver for the given - * URL. So when specifying null, a user must take care of registering the driver. - * "connectionUrl" on the other hand must NOT be null. - * - * @since 1.1 - */ - public DriverDataSource(Driver driver, String connectionUrl, String userName, - String password) { - - this._driver = driver; - this.driverClassName = driver.getClass().getName(); - this.connectionUrl = connectionUrl; - this.userName = userName; - this.password = password; - } - - /** - * Returns a new database connection, using preconfigured data to locate the database - * and obtain a connection. - */ - public Connection getConnection() throws SQLException { - // login with internal credentials - return getConnection(userName, password); - } - - /** - * Returns a new database connection using provided credentials to login to the - * database. - */ - public Connection getConnection(String userName, String password) throws SQLException { - try { - if (logger != null) { - logger.logConnect(connectionUrl, userName, password); - } - - Connection c = null; - - if (getDriver() == null) { - c = DriverManager.getConnection(connectionUrl, userName, password); - } - else { - Properties connectProperties = new Properties(); - - if (userName != null) { - connectProperties.put("user", userName); - } - - if (password != null) { - connectProperties.put("password", password); - } - c = getDriver().connect(connectionUrl, connectProperties); - } - - // some drivers (Oracle) return null connections instead of throwing - // an exception... fix it here - - if (c == null) { - throw new SQLException("Can't establish connection: " + connectionUrl); - } - - if (logger != null) { - logger.logConnectSuccess(); - } - - return c; - } - catch (SQLException sqlex) { - if (logger != null) { - logger.logConnectFailure(sqlex); - } - - throw sqlex; - } - } - - public int getLoginTimeout() throws SQLException { - return -1; - } - - public void setLoginTimeout(int seconds) throws SQLException { - // noop - } - - public PrintWriter getLogWriter() throws SQLException { - return DriverManager.getLogWriter(); - } - - public void setLogWriter(PrintWriter out) throws SQLException { - DriverManager.setLogWriter(out); - } - - public JdbcEventLogger getLogger() { - return logger; - } - - public void setLogger(JdbcEventLogger delegate) { - logger = delegate; - } - - /** - * @since 3.0 - */ - public String getConnectionUrl() { - return connectionUrl; - } - - /** - * @since 3.0 - */ - public void setConnectionUrl(String connectionUrl) { - this.connectionUrl = connectionUrl; - } - - /** - * @since 3.0 - */ - public String getPassword() { - return password; - } - - /** - * @since 3.0 - */ - public void setPassword(String password) { - this.password = password; - } - - /** - * @since 3.0 - */ - public String getUserName() { - return userName; - } - - /** - * @since 3.0 - */ - public void setUserName(String userName) { - this.userName = userName; - } - - public String getDriverClassName() { - return driverClassName; - } - - public void setDriverClassName(String driverClassName) { - if (!Util.nullSafeEquals(getDriverClassName(), driverClassName)) { - this.driverClassName = driverClassName; - this._driver = null; // force reload - } - } - - /** - * Lazily instantiate the driver class to prevent errors for connections that are never opened - */ - private Driver getDriver() throws SQLException { - if (_driver == null && driverClassName != null) { - _driver = loadDriver(driverClassName); - } - return _driver; - } - - /** - * @since 3.0 - */ - // JDBC 4 compatibility under Java 1.5 - public boolean isWrapperFor(Class<?> iface) throws SQLException { - throw new UnsupportedOperationException(); - } - - /** - * @since 3.0 - */ - // JDBC 4 compatibility under Java 1.5 - public <T> T unwrap(Class<T> iface) throws SQLException { - throw new UnsupportedOperationException(); - } - - /** - * @since 3.1 - * - * JDBC 4.1 compatibility under Java 1.5 - */ - public Logger getParentLogger() throws SQLFeatureNotSupportedException { - throw new UnsupportedOperationException(); - } + protected Driver driver; + protected String connectionUrl; + protected String userName; + protected String password; + + protected JdbcEventLogger logger; + + /** + * Loads JDBC driver using current thread class loader. + * + * @since 3.0 + * @deprecated since 4.0 as class loading should not happen here. + */ + @Deprecated + private static Driver loadDriver(String driverClassName) { + + Class<?> driverClass; + try { + driverClass = Util.getJavaClass(driverClassName); + } catch (Exception ex) { + throw new CayenneRuntimeException("Can not load JDBC driver named '" + driverClassName + "': " + + ex.getMessage()); + } + + try { + return (Driver) driverClass.newInstance(); + } catch (Exception ex) { + throw new CayenneRuntimeException("Error instantiating driver '" + driverClassName + "': " + + ex.getMessage()); + } + } + + /** + * Creates a new DriverDataSource. If "driverClassName" is null, + * DriverDataSource will consult DriverManager for a registered driver for + * the given URL. So when specifying null, a user must take care of + * registering the driver. "connectionUrl" on the other hand must NOT be + * null. + * + * @deprecated since 4.0 as class loading should not happen here. Use + * {@link #DriverDataSource(Driver, String, String, String)}. + */ + @Deprecated + public DriverDataSource(String driverClassName, String connectionUrl) { + this(driverClassName, connectionUrl, null, null); + } + + /** + * Creates a new DriverDataSource. If "driverClassName" is null, + * DriverDataSource will consult DriverManager for a registered driver for + * the given URL. So when specifying null, a user must take care of + * registering the driver. "connectionUrl" on the other hand must NOT be + * null. + * + * @deprecated since 4.0 as class loading should not happen here. Use + * {@link #DriverDataSource(Driver, String, String, String)}. + */ + @Deprecated + public DriverDataSource(String driverClassName, String connectionUrl, String userName, String password) { + + this(loadDriver(driverClassName), connectionUrl, userName, password); + + this.connectionUrl = connectionUrl; + this.userName = userName; + this.password = password; + } + + /** + * Creates a new DriverDataSource wrapping a given Driver. If "driver" is + * null, DriverDataSource will consult DriverManager for a registered driver + * for the given URL. So when specifying null, a user must take care of + * registering the driver. "connectionUrl" on the other hand must NOT be + * null. + * + * @since 1.1 + */ + public DriverDataSource(Driver driver, String connectionUrl, String userName, String password) { + + this.driver = driver; + this.connectionUrl = connectionUrl; + this.userName = userName; + this.password = password; + } + + /** + * Returns a new database connection, using preconfigured data to locate the + * database and obtain a connection. + */ + public Connection getConnection() throws SQLException { + // login with internal credentials + return getConnection(userName, password); + } + + /** + * Returns a new database connection using provided credentials to login to + * the database. + */ + public Connection getConnection(String userName, String password) throws SQLException { + try { + if (logger != null) { + logger.logConnect(connectionUrl, userName, password); + } + + Connection c = null; + + if (driver == null) { + c = DriverManager.getConnection(connectionUrl, userName, password); + } else { + Properties connectProperties = new Properties(); + + if (userName != null) { + connectProperties.put("user", userName); + } + + if (password != null) { + connectProperties.put("password", password); + } + c = driver.connect(connectionUrl, connectProperties); + } + + // some drivers (Oracle) return null connections instead of throwing + // an exception... fix it here + + if (c == null) { + throw new SQLException("Can't establish connection: " + connectionUrl); + } + + if (logger != null) { + logger.logConnectSuccess(); + } + + return c; + } catch (SQLException sqlex) { + if (logger != null) { + logger.logConnectFailure(sqlex); + } + + throw sqlex; + } + } + + public int getLoginTimeout() throws SQLException { + return -1; + } + + public void setLoginTimeout(int seconds) throws SQLException { + // noop + } + + public PrintWriter getLogWriter() throws SQLException { + return DriverManager.getLogWriter(); + } + + public void setLogWriter(PrintWriter out) throws SQLException { + DriverManager.setLogWriter(out); + } + + public JdbcEventLogger getLogger() { + return logger; + } + + public void setLogger(JdbcEventLogger delegate) { + logger = delegate; + } + + /** + * @since 3.0 + */ + public String getConnectionUrl() { + return connectionUrl; + } + + /** + * @since 3.0 + */ + public void setConnectionUrl(String connectionUrl) { + this.connectionUrl = connectionUrl; + } + + /** + * @since 3.0 + */ + public String getPassword() { + return password; + } + + /** + * @since 3.0 + */ + public void setPassword(String password) { + this.password = password; + } + + /** + * @since 3.0 + */ + public String getUserName() { + return userName; + } + + /** + * @since 3.0 + */ + public void setUserName(String userName) { + this.userName = userName; + } + + /** + * @since 3.0 + */ + @Override + public boolean isWrapperFor(Class<?> iface) throws SQLException { + throw new UnsupportedOperationException(); + } + + /** + * @since 3.0 + */ + @Override + public <T> T unwrap(Class<T> iface) throws SQLException { + throw new UnsupportedOperationException(); + } + + /** + * @since 3.1 + * + * JDBC 4.1 compatibility under Java 1.5 + */ + public Logger getParentLogger() throws SQLFeatureNotSupportedException { + throw new UnsupportedOperationException(); + } } http://git-wip-us.apache.org/repos/asf/cayenne/blob/00dc7211/cayenne-server/src/test/java/org/apache/cayenne/datasource/DriverDataSourceTest.java ---------------------------------------------------------------------- diff --git a/cayenne-server/src/test/java/org/apache/cayenne/datasource/DriverDataSourceTest.java b/cayenne-server/src/test/java/org/apache/cayenne/datasource/DriverDataSourceTest.java deleted file mode 100644 index cb361f2..0000000 --- a/cayenne-server/src/test/java/org/apache/cayenne/datasource/DriverDataSourceTest.java +++ /dev/null @@ -1,44 +0,0 @@ -/***************************************************************** - * Licensed to the Apache Software Foundation (ASF) under one - * or more contributor license agreements. See the NOTICE file - * distributed with this work for additional information - * regarding copyright ownership. The ASF licenses this file - * to you 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. - ****************************************************************/ -package org.apache.cayenne.datasource; - -import org.apache.cayenne.datasource.DriverDataSource; -import org.junit.Test; - -import java.sql.SQLException; - -import static org.junit.Assert.assertNotNull; -import static org.junit.Assert.fail; - -public class DriverDataSourceTest { - - @Test - public void testLazyInstantiationOfDriverClass() { - DriverDataSource dataSource = new DriverDataSource("does.not.exist.Driver", "jdbc:postgresql://localhost/database"); - assertNotNull(dataSource); - - try { - dataSource.getConnection(); - fail(); - } catch (SQLException e) { - // expected because driver class does not exist - } - } - -}
