Ready to get started?

Learn more about the CData JDBC Driver for Alfresco or download a free trial:

Download Now

Create a Data Access Object for Alfresco Data using JDBI

A brief overview of creating a SQL Object API for Alfresco data in JDBI.

JDBI is a SQL convenience library for Java that exposes two different style APIs, a fluent style and a SQL object style. The CData JDBC Driver for Alfresco integrates connectivity to live Alfresco data in Java applications. By pairing these technologies, you gain simple, programmatic access to Alfresco data. This article walks through building a basic Data Access Object (DAO) and the accompanying code to read Alfresco data.

Create a DAO for the Alfresco Alfresco Entity

The interface below declares the desired behavior for the SQL object to create a single method for each SQL statement to be implemented.

public interface MyAlfrescoDAO { //request specific data from Alfresco (String type is used for simplicity) @SqlQuery("SELECT Column1 FROM Alfresco WHERE Column2 = :column2") String findColumn1ByColumn2(@Bind("column2") String column2); /* * close with no args is used to close the connection */ void close(); }

Open a Connection to Alfresco

Collect the necessary connection properties and construct the appropriate JDBC URL for connecting to Alfresco.

To connect to Alfresco, the following connection properties must be supplied: User, Password, and InstanceUrl. User and Password correspond to the login credentials that you use to access Alfresco in a web browser. InstanceUrl corresponds to the Alfresco instance you will be querying. For instance, if you expect your queries to hit https://search-demo.dev.alfresco.me/alfresco/api/-default-/public/search/versions/1/sql, you should supply search-demo.dev.alfresco.me for InstanceUrl.

Built-in Connection String Designer

For assistance in constructing the JDBC URL, use the connection string designer built into the Alfresco JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

java -jar cdata.jdbc.alfresco.jar

Fill in the connection properties and copy the connection string to the clipboard.

A connection string for Alfresco will typically look like the following:

jdbc:alfresco:User=MyUsername; Password=MyPassword; Format=Solr; InstanceUrl=api-explorer.alfresco.com;

Use the configured JDBC URL to obtain an instance of the DAO interface. The particular method shown below will open a handle bound to the instance, so the instance needs to be closed explicitly to release the handle and the bound JDBC connection.

DBI dbi = new DBI("jdbc:alfresco:User=MyUsername; Password=MyPassword; Format=Solr; InstanceUrl=api-explorer.alfresco.com;"); MyAlfrescoDAO dao = dbi.open(MyAlfrescoDAO.class); //do stuff with the DAO dao.close();

Read Alfresco Data

With the connection open to Alfresco, simply call the previously defined method to retrieve data from the Alfresco entity in Alfresco.

//disply the result of our 'find' method String column1 = dao.findColumn1ByColumn2("MyFilter"); System.out.println(column1);

Since the JDBI library is able to work with JDBC connections, you can easily produce a SQL Object API for Alfresco by integrating with the CData JDBC Driver for Alfresco. Download a free trial and work with live Alfresco data in custom Java applications today.