sling-datasource

Created: 2014-05-19 08:41
Updated: 2016-10-13 00:33

README.md

Apache Sling DataSource Provider

This bundle enables creating and configuring JDBC DataSource in OSGi environment based on OSGi configuration. It uses Tomcat JDBC Pool as the JDBC Connection Pool provider.

  1. Supports configuring the DataSource based on OSGi config wihich rich metatype
  2. Supports deploying of JDBC Driver as independent bundles and not as fragment
  3. Exposes the DataSource stats as JMX MBean

Driver Loading

Loading of JDBC driver is tricky on OSGi env. Mostly one has to attach the Driver bundle as a fragment bundle to the code which creates the JDBC Connection.

With JDBC 4 onwards the Driver class can be loaded via Java SE Service Provider mechanism (SPM) JDBC 4.0 drivers must include the file META-INF/services/java.sql.Driver. This file contains the name of the JDBC driver's implementation of java.sql.Driver. For example, to load the JDBC driver to connect to a Apache Derby database, the META-INF/services/java.sql.Driver file would contain the following entry:

org.apache.derby.jdbc.EmbeddedDriver

Sling DataSource Provider bundles maintains a DriverRegistry which contains mapping of Driver bundle to Driver class supported by it. With this feature there is no need to wrap the Driver bundle as fragment to DataSource provider bundle

Configuration

  1. Install the current bundle
  2. Install the JDBC Driver bundle
  3. Configure the DataSource from OSGi config for PID org.apache.sling.extensions.datasource.DataSourceFactory

If Felix WebConsole is used then you can configure it via Configuration UI at http://localhost:8080/system/console/configMgr/org.apache.sling.extensions.datasource.DataSourceFactory

Usage

Once the required configuration is done the DataSource would be registered as part of the OSGi Service Registry The service is registered with service property datasource.name whose value is the name of datasource provided in OSGi config.

Following snippet demonstrates accessing the DataSource named foo via DS annotation

import javax.sql.DataSource;
import org.apache.felix.scr.annotations.Reference;

public class DSExample {
    
    @Reference(target = "(&(objectclass=javax.sql.DataSource)(datasource.name=foo))")
    private DataSource dataSource;
}
Cookies help us deliver our services. By using our services, you agree to our use of cookies Learn more