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

Create a DAO for the Jira Assets Objects 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 MyObjectsDAO {
 //insert new data into Jira Assets
 @SqlUpdate("INSERT INTO Objects (Label, Name) values (:label, :name)")
 void insert(@Bind("label") String label, @Bind("name") String name);

 //request specific data from Jira Assets (String type is used for simplicity)
 @SqlQuery("SELECT Name FROM Objects WHERE Label = :label")
 String findNameByLabel(@Bind("label") String label);

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

Open a Connection to Jira Assets

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

Jira Assets supports connecting and authenticating via the APIToken.

To generate an API token:

1. Log in to your Atlassian account.
2. Navigate to Security < Create and manage API Token < Create API Token.

Atlassian generates and then displays the API token.

After you have generated the API token, set these parameters:

• AuthScheme: APIToken.
• User: The login of the authenticating user.
• APIToken: The API token you just generated.

You are now ready to connect and authenticate to Jira Assets.

Built-in Connection String Designer

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

java -jar cdata.jdbc.jiraassets.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 Jira Assets will typically look like the following:

jdbc:jiraassets:User=MyUser;APIToken=myApiToken;Url=https://yoursitename.atlassian.net

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:jiraassets:User=MyUser;APIToken=myApiToken;Url=https://yoursitename.atlassian.net");
MyObjectsDAO dao = dbi.open(MyObjectsDAO.class);

//do stuff with the DAO

dao.close();

Read Jira Assets Data

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

//disply the result of our 'find' method
String name = dao.findNameByLabel("SYD-1");
System.out.println(name);

Write Jira Assets Data

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

//add a new entry to the Objects entity
dao.insert(newLabel, newName);

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