Support for the Data Service Specification

Add a first basic implementation of the DataSourceFactory

Author: Christoph Läubrich

pom.xml

@@ -161,8 +161,9 @@
           <instructions>
             <Bundle-SymbolicName>org.xerial.sqlite-jdbc;singleton:=true</Bundle-SymbolicName>
             <Import-Package>
-              *;resolution:=optional
+              *
             </Import-Package>
+            <Bundle-Activator>org.sqlite.osgi.SQLiteActivator</Bundle-Activator>
           </instructions>
         </configuration>
       </plugin>
@@ -339,5 +340,18 @@
       <version>3.12.4</version>
       <scope>test</scope>
     </dependency>
+    <!-- dependencies related to OSGi support -->
+	<dependency>
+	    <groupId>org.osgi</groupId>
+	    <artifactId>org.osgi.service.jdbc</artifactId>
+	    <version>1.0.1</version>
+	    <scope>provided</scope>
+	</dependency>
+	<dependency>
+	    <groupId>org.osgi</groupId>
+	    <artifactId>org.osgi.framework</artifactId>
+	    <version>1.10.0</version>
+	    <scope>provided</scope>
+	</dependency>
   </dependencies>
 </project>

src/main/java/org/sqlite/osgi/SQLiteActivator.java

@@ -0,0 +1,23 @@
+package org.sqlite.osgi;
+
+import java.util.Hashtable;
+import org.osgi.framework.BundleActivator;
+import org.osgi.framework.BundleContext;
+import org.osgi.service.jdbc.DataSourceFactory;
+import org.sqlite.JDBC;
+import org.sqlite.SQLiteJDBCLoader;
+
+public class SQLiteActivator implements BundleActivator {
+
+    @Override
+    public void start(BundleContext context) throws Exception {
+        Hashtable<String, Object> properties = new Hashtable<>();
+        properties.put(DataSourceFactory.OSGI_JDBC_DRIVER_CLASS, JDBC.class.getName());
+        properties.put(DataSourceFactory.OSGI_JDBC_DRIVER_NAME, "SQLite JDBC driver");
+        properties.put(DataSourceFactory.OSGI_JDBC_DRIVER_VERSION, SQLiteJDBCLoader.getVersion());
+        context.registerService(DataSourceFactory.class, new SQLiteDataSourceFactory(), properties);
+    }
+
+    @Override
+    public void stop(BundleContext context) throws Exception {}
+}

src/main/java/org/sqlite/osgi/SQLiteDataSourceFactory.java

@@ -0,0 +1,99 @@
+package org.sqlite.osgi;
+
+import java.sql.Driver;
+import java.sql.SQLException;
+import java.util.Properties;
+import java.util.function.Consumer;
+import javax.sql.ConnectionPoolDataSource;
+import javax.sql.DataSource;
+import javax.sql.XADataSource;
+import org.osgi.service.jdbc.DataSourceFactory;
+import org.sqlite.JDBC;
+import org.sqlite.SQLiteConfig;
+import org.sqlite.SQLiteDataSource;
+import org.sqlite.javax.SQLiteConnectionPoolDataSource;
+
+public class SQLiteDataSourceFactory implements DataSourceFactory {
+
+    @Override
+    public DataSource createDataSource(Properties props) throws SQLException {
+        SQLiteDataSource dataSource = new SQLiteDataSource(getConfig(props));
+        setBasicDataSourceProperties(props, dataSource);
+        return dataSource;
+    }
+
+    @Override
+    public ConnectionPoolDataSource createConnectionPoolDataSource(Properties props)
+            throws SQLException {
+
+        SQLiteConnectionPoolDataSource poolDataSource =
+                new SQLiteConnectionPoolDataSource(getConfig(props));
+        setBasicDataSourceProperties(props, poolDataSource);
+        return poolDataSource;
+    }
+
+    @Override
+    public XADataSource createXADataSource(Properties props) throws SQLException {
+        throw new SQLException("XADataSource is not supported by SQLite");
+    }
+
+    @Override
+    public Driver createDriver(Properties props) throws SQLException {
+        return new JDBC();
+    }
+
+    /**
+     * Method to transfer a property to a setter method
+     *
+     * @param props
+     * @param key
+     * @param consumer
+     */
+    private static void setStandardProperty(
+            Properties props, String key, Consumer<String> consumer) {
+        String value = props.getProperty(key);
+        if (value != null) {
+            consumer.accept(value);
+        }
+    }
+
+    /**
+     * Set basic properties common to {@link SQLiteDataSource}s
+     *
+     * @param props
+     * @param dataSource
+     */
+    private static void setBasicDataSourceProperties(
+            Properties props, SQLiteDataSource dataSource) {
+        if (props != null) {
+            setStandardProperty(
+                    props, DataSourceFactory.JDBC_DATABASE_NAME, dataSource::setDatabaseName);
+            setStandardProperty(props, DataSourceFactory.JDBC_URL, dataSource::setUrl);
+        }
+    }
+
+    /**
+     * converts user supplied properties into an internal {@link SQLiteConfig} object
+     *
+     * @param userProperties the user properties, might be <code>null</code>
+     * @return a {@link SQLiteConfig} config object reflecting the given user properties
+     */
+    private static SQLiteConfig getConfig(Properties userProperties) {
+        SQLiteConfig config;
+        if (userProperties == null) {
+            config = new SQLiteConfig();
+        } else {
+            Properties properties = new Properties(userProperties);
+            setStandardProperty(
+                    userProperties,
+                    DataSourceFactory.JDBC_USER,
+                    v -> properties.setProperty("user", v));
+            setStandardProperty(
+                    userProperties,
+                    DataSourceFactory.JDBC_PASSWORD,
+                    v -> properties.setProperty("pass", v));
+            config = new SQLiteConfig(properties);
+        }
+        return config;
+    }
+}