activerecord-jdbc-adapter 1.0.3-java → 50.1-java

data/src/java/arjdbc/jdbc/ConnectionFactory.java

@@ -0,0 +1,132 @@
+/***** BEGIN LICENSE BLOCK *****
+ * Copyright (c) 2012-2014 Karol Bucek <self@kares.org>
+ * Copyright (c) 2006-2010 Nick Sieger <nick@nicksieger.com>
+ * Copyright (c) 2006-2007 Ola Bini <ola.bini@gmail.com>
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining
+ * a copy of this software and associated documentation files (the
+ * "Software"), to deal in the Software without restriction, including
+ * without limitation the rights to use, copy, modify, merge, publish,
+ * distribute, sublicense, and/or sell copies of the Software, and to
+ * permit persons to whom the Software is furnished to do so, subject to
+ * the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be
+ * included in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+ * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+ * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+ * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+ * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+ * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+ * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ ***** END LICENSE BLOCK *****/
+
+package arjdbc.jdbc;
+
+import java.sql.Connection;
+import java.sql.SQLException;
+import javax.sql.DataSource;
+
+import org.jruby.RubyObject;
+import org.jruby.RubyString;
+import org.jruby.runtime.ThreadContext;
+import org.jruby.runtime.builtin.IRubyObject;
+
+/**
+ * Interface to be implemented in Ruby for retrieving a new connection.
+ *
+ * @author nicksieger
+ */
+public interface ConnectionFactory {
+
+    /**
+     * Retrieve a (new) connection from the factory.
+     * @return a connection
+     * @throws SQLException
+     */
+    Connection newConnection() throws SQLException;
+
+}
+
+class DataSourceConnectionFactoryImpl implements ConnectionFactory {
+
+    private final DataSource dataSource;
+    final String username, password; // optional
+
+    public DataSourceConnectionFactoryImpl(final DataSource dataSource) {
+        this.dataSource = dataSource;
+        this.username = null; this.password = null;
+    }
+
+    public DataSourceConnectionFactoryImpl(final DataSource dataSource,
+        final String username, final String password) {
+        this.dataSource = dataSource;
+        this.username = username; this.password = password;
+    }
+
+    @Override
+    public Connection newConnection() throws SQLException {
+        if ( username != null ) {
+            dataSource.getConnection(username, password);
+        }
+        return dataSource.getConnection();
+    }
+
+    DataSource getDataSource() { return dataSource; } /* for tests */
+
+}
+
+class DriverConnectionFactoryImpl implements ConnectionFactory {
+
+    private final DriverWrapper driverWrapper;
+    final String url;
+    final String username, password; // null allowed
+
+    public DriverConnectionFactoryImpl(final DriverWrapper driver, final String url) {
+        this.driverWrapper = driver; this.url = url;
+        this.username = null; this.password = null;
+    }
+
+    public DriverConnectionFactoryImpl(final DriverWrapper driver, final String url,
+        final String username, final String password) {
+        this.driverWrapper = driver; this.url = url;
+        this.username = username; this.password = password;
+    }
+
+    @Override
+    public Connection newConnection() throws SQLException {
+        return driverWrapper.connect(url, username, password);
+    }
+
+    DriverWrapper getDriverWrapper() { return driverWrapper; } /* for tests */
+
+}
+
+// @legacy ActiveRecord::ConnectionAdapters::JdbcDriver
+class RubyConnectionFactoryImpl implements ConnectionFactory {
+
+    private final IRubyObject driver;
+    final RubyString url;
+    final IRubyObject username, password; // null allowed
+
+    private final RubyObject contextProvider;
+
+    public RubyConnectionFactoryImpl(final IRubyObject driver, final RubyString url,
+        final IRubyObject username, final IRubyObject password) {
+        this.driver = driver; this.url = url;
+        this.username = username; this.password = password;
+        contextProvider = (RubyObject) driver;
+    }
+
+    @Override
+    public Connection newConnection() throws SQLException {
+        final ThreadContext context = contextProvider.getRuntime().getCurrentContext();
+        final IRubyObject connection = driver.callMethod(context, "connection", new IRubyObject[] { url, username, password });
+        return (Connection) connection.toJava(Connection.class);
+    }
+
+    IRubyObject getDriver() { return driver; } /* for tests */
+
+}

data/src/java/arjdbc/jdbc/DataSourceConnectionFactory.java

@@ -0,0 +1,157 @@
+/*
+ * The MIT License
+ *
+ * Copyright 2014 Karol Bucek.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+package arjdbc.jdbc;
+
+import java.sql.Connection;
+import java.sql.SQLException;
+
+import javax.sql.DataSource;
+import javax.naming.InitialContext;
+import javax.naming.NameNotFoundException;
+import javax.naming.NamingException;
+
+import org.jruby.runtime.ThreadContext;
+import org.jruby.util.SafePropertyAccessor;
+
+import static arjdbc.jdbc.RubyJdbcConnection.getConnectionNotEstablished;
+import static arjdbc.jdbc.RubyJdbcConnection.wrapException;
+
+/**
+ *
+ * @author kares
+ */
+final class DataSourceConnectionFactory implements ConnectionFactory {
+
+    private DataSource dataSource;
+    private final String lookupName;
+    String username;
+    String password; // optional
+
+    public DataSourceConnectionFactory(final DataSource dataSource) {
+        this.dataSource = dataSource;
+        this.lookupName = null;
+    }
+
+    DataSourceConnectionFactory(final DataSource dataSource, final String lookupName) {
+        this.dataSource = dataSource;
+        this.lookupName = lookupName;
+    }
+
+    public void setUsername(final String username) {
+        this.username = username;
+    }
+
+    public void setPassword(final String password) {
+        this.password = password;
+    }
+
+    @Override
+    public Connection newConnection() throws SQLException {
+        DataSource dataSource = this.dataSource;
+        // in case DS failed previously look it up again from JNDI :
+        if (dataSource == null) {
+            lookupDataSource();
+        }
+        try {
+            if (username != null) {
+                return dataSource.getConnection(username, password);
+            }
+            return dataSource.getConnection();
+        }
+        catch (SQLException e) {
+            // DS failed - maybe it's no longer a valid one
+            if (lookupName != null) {
+                this.dataSource = null;
+            }
+            throw e;
+        }
+    }
+
+    private DataSource lookupDataSource() throws SQLException {
+        try {
+            return dataSource = (DataSource) getInitialContext().lookup(lookupName);
+        }
+        catch (NamingException e) { throw new SQLException(e); }
+    }
+
+    DataSource getDataSource() { return dataSource; } /* for tests */
+
+    // NOTE: keep it here so that RubyJdbcConnection does not force loading of javax.naming classes
+    static DataSource lookupDataSource(final ThreadContext context, final String name) {
+        try {
+            final Object bound = getInitialContext().lookup(name);
+            if ( ! ( bound instanceof DataSource ) ) {
+                if ( bound == null ) throw new NameNotFoundException(); // unlikely to happen
+                final String msg = "bound object at '" + name + "' is not a " + DataSource.class.getName() + " but a " + bound.getClass().getName() + "\n" + bound;
+                throw wrapException(context, getConnectionNotEstablished(context.runtime), new ClassCastException(msg), msg);
+            }
+            return (DataSource) bound;
+        }
+        catch (NameNotFoundException e) {
+            final String message;
+            if ( name == null || name.isEmpty() ) {
+                message = "unable to lookup data source - no name given, please set jndi:";
+            }
+            else if ( name.indexOf("env", 0) == -1 ) {
+                final StringBuilder msg = new StringBuilder();
+                msg.append("name: '").append(name).append("' not found, ");
+                msg.append("try using full name (including env) e.g. ");
+                msg.append("java:/comp/env"); // e.g. java:/comp/env/jdbc/MyDS
+                if ( name.charAt(0) != '/' ) msg.append('/');
+                msg.append(name);
+                message = msg.toString();
+            }
+            else {
+                message = "unable to lookup data source - name: '" + name + "' not found";
+            }
+            throw wrapException(context, getConnectionNotEstablished(context.runtime), e, message);
+        }
+        catch (NamingException e) {
+            throw wrapException(context, context.runtime.getRuntimeError(), e);
+        }
+    }
+
+    // NamigHelper :
+
+    static final boolean contextCached = SafePropertyAccessor.getBoolean("arjdbc.jndi.context.cached");
+
+    private static InitialContext initialContext;
+
+    static InitialContext getInitialContext() throws NamingException {
+        if ( initialContext != null ) return initialContext;
+        if ( contextCached ) return initialContext = new InitialContext();
+        return new InitialContext();
+    }
+
+    /**
+     * Currently, the only way to bypass <code>new InitialContext()</code>
+     * without the environment being passed in.
+     * @param context
+     * @see #getInitialContext()
+     */
+    static void setInitialContext(final InitialContext context) {
+        DataSourceConnectionFactory.initialContext = context;
+    }
+
+}

data/src/java/arjdbc/jdbc/DriverConnectionFactory.java

@@ -0,0 +1,63 @@
+/*
+ * The MIT License
+ *
+ * Copyright 2014 Karol Bucek.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+package arjdbc.jdbc;
+
+import java.sql.Connection;
+import java.sql.SQLException;
+
+/**
+ *
+ * @author kares
+ */
+final class DriverConnectionFactory implements ConnectionFactory {
+
+    private final DriverWrapper driverWrapper;
+    final String url;
+    final String username;
+    final String password; // null allowed
+
+    public DriverConnectionFactory(final DriverWrapper driver, final String url) {
+        this.driverWrapper = driver;
+        this.url = url;
+        this.username = null;
+        this.password = null;
+    }
+
+    public DriverConnectionFactory(final DriverWrapper driver, final String url, final String username, final String password) {
+        this.driverWrapper = driver;
+        this.url = url;
+        this.username = username;
+        this.password = password;
+    }
+
+    @Override
+    public Connection newConnection() throws SQLException {
+        return driverWrapper.connect(url, username, password);
+    }
+
+    DriverWrapper getDriverWrapper() {
+        return driverWrapper;
+    } /* for tests */
+
+}

data/src/java/arjdbc/jdbc/DriverWrapper.java

@@ -0,0 +1,119 @@
+/*
+ * The MIT License
+ *
+ * Copyright 2014 Karol Bucek.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+package arjdbc.jdbc;
+
+import java.sql.Connection;
+import java.sql.Driver;
+import java.sql.SQLException;
+import java.util.Map;
+import java.util.Properties;
+
+import org.jruby.Ruby;
+
+
+/**
+ * A driver wrapper (we're avoiding DriverManager due possible leaks).
+ *
+ * When the driver is not loaded we're load it using JRuby's class-loader.
+ *
+ * @author kares
+ */
+public class DriverWrapper {
+
+    private final Driver driver;
+    private final Properties properties;
+
+    DriverWrapper(final Ruby runtime, final String name, final Properties properties)
+        throws ClassCastException, InstantiationException, IllegalAccessException {
+        this.driver = allocateDriver( loadDriver(runtime, name) );
+        this.properties = properties == null ? new Properties() : properties;
+    }
+
+    public Properties getProperties() {
+        return properties;
+    }
+
+    public Driver getDriverInstance() {
+        return driver;
+    }
+
+    private Driver allocateDriver(final Class<? extends Driver> driverClass)
+        throws InstantiationException, IllegalAccessException {
+        try {
+            return driverClass.newInstance();
+        }
+        catch (InstantiationException e) {
+            throw e;
+        }
+        catch (IllegalAccessException e) {
+            throw e;
+        }
+    }
+
+    protected static Class<? extends Driver> loadDriver(final Ruby runtime, final String name)
+        throws ClassCastException {
+        @SuppressWarnings("unchecked")
+        Class<? extends Driver> klass = runtime.getJavaSupport().loadJavaClassVerbose(name);
+        if ( ! Driver.class.isAssignableFrom(klass) ) {
+            throw new ClassCastException(klass + " is not assignable from " + Driver.class);
+        }
+        return klass;
+    }
+
+    public Connection connect(final String url, final String user, final String pass)
+        throws SQLException {
+
+        final Properties properties = (Properties) this.properties.clone();
+        if ( user != null ) properties.setProperty("user", user);
+        if ( pass != null ) properties.setProperty("password", pass);
+
+        return getDriverInstance().connect(url, properties);
+    }
+
+    public static String buildURL(final Object url, final Map<?, ?> options) {
+        if ( options == null || options.isEmpty() ) {
+            return url.toString();
+        }
+
+        final StringBuilder urlWithOptions = new StringBuilder();
+
+        final String urlStr = url.toString();
+        if ( urlStr.indexOf('?') == -1 ) {
+            urlWithOptions.append(urlStr).append('?');
+        }
+        else {
+            urlWithOptions.append(urlStr).append('&');
+        }
+
+        boolean first = true;
+        for ( Map.Entry entry : options.entrySet() ) {
+            if ( ! first ) urlWithOptions.append('&');
+            urlWithOptions.append(entry.getKey()).append('=').append(entry.getValue());
+            first = false;
+        }
+
+        return urlWithOptions.toString();
+    }
+
+}