Create a Data Access Object for Bitbucket Data using 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 Bitbucket integrates connectivity to live Bitbucket data in Java applications. By pairing these technologies, you gain simple, programmatic access to Bitbucket data. This article explains how to build a basic Data Access Object (DAO) and the accompanying code to read and write Bitbucket data.

Create a DAO for the Bitbucket Issues 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 MyIssuesDAO {
 //insert new data into Bitbucket
 @SqlUpdate("INSERT INTO Issues (Id, ContentRaw) values (:id, :contentRaw)")
 void insert(@Bind("id") String id, @Bind("contentRaw") String contentRaw);

 //request specific data from Bitbucket (String type is used for simplicity)
 @SqlQuery("SELECT ContentRaw FROM Issues WHERE Id = :id")
 String findContentRawById(@Bind("id") String id);

 /*
 * close with no args is used to close the connection
 */
 void close();
}

Open a Connection to Bitbucket

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

For most queries, you must set the Workspace. The only exception to this is the Workspaces table, which does not require this property to be set, as querying it provides a list of workspace slugs that can be used to set Workspace. To query this table, you must set Schema to 'Information' and execute the query SELECT * FROM Workspaces>.

Setting Schema to 'Information' displays general information. To connect to Bitbucket, set these parameters:

• Schema: To show general information about a workspace, such as its users, repositories, and projects, set this to Information. Otherwise, set this to the schema of the repository or project you are querying. To get a full set of available schemas, query the sys_schemas table.
• Workspace: Required if you are not querying the Workspaces table. This property is not required for querying the Workspaces table, as that query only returns a list of workspace slugs that can be used to set Workspace.

Authenticating to Bitbucket

Bitbucket supports OAuth authentication only. To enable this authentication from all OAuth flows, you must create a custom OAuth application, and set AuthScheme to OAuth.

Be sure to review the Help documentation for the required connection properties for you specific authentication needs (desktop applications, web applications, and headless machines).

Creating a custom OAuth application

From your Bitbucket account:

1. Go to Settings (the gear icon) and select Workspace Settings.
2. In the Apps and Features section, select OAuth Consumers.
3. Click Add Consumer.
4. Enter a name and description for your custom application.
5. Set the callback URL:
   • For desktop applications and headless machines, use http://localhost:33333 or another port number of your choice. The URI you set here becomes the CallbackURL property.
   • For web applications, set the callback URL to a trusted redirect URL. This URL is the web location the user returns to with the token that verifies that your application has been granted access.
6. If you plan to use client credentials to authenticate, you must select This is a private consumer. In the driver, you must set AuthScheme to client.
7. Select which permissions to give your OAuth application. These determine what data you can read and write with it.
8. To save the new custom application, click Save.
9. After the application has been saved, you can select it to view its settings. The application's Key and Secret are displayed. Record these for future use. You will use the Key to set the OAuthClientId and the Secret to set the OAuthClientSecret.

Built-in Connection String Designer

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

java -jar cdata.jdbc.bitbucket.jar

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

👁 Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)

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

jdbc:bitbucket:Workspace=myworkspaceslug;Schema=Information;InitiateOAuth=GETANDREFRESH;

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:bitbucket:Workspace=myworkspaceslug;Schema=Information;InitiateOAuth=GETANDREFRESH;");
MyIssuesDAO dao = dbi.open(MyIssuesDAO.class);

//do stuff with the DAO

dao.close();

Read Bitbucket Data

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

//disply the result of our 'find' method
String contentRaw = dao.findContentRawById("1");
System.out.println(contentRaw);

Write Bitbucket Data

It is also simple to write data to Bitbucket, using the previously defined method.

//add a new entry to the Issues entity
dao.insert(newId, newContentRaw);

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