Ready to get started?

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

Download Now

JDBI からXero Data のデータアクセスオブジェクトを作成

JDBI でXero data 用のSQL オブジェクトAPIを作成する方法を概説します。

JDBI は、Fluent スタイルとSQL オブジェクトスタイルという2つの異なるスタイルAPI を公開する、Java 用のSQL コンビニエンスライブラリです。CData JDBC Driver for Xero は、Java アプリケーションとリアルタイムXero data のデータ連携を実現します。これらの技術を組み合わせることによって、Xero data へのシンプルなコードアクセスが可能になります。ここでは、基本的なDAO(Data Access Object )とそれに付随するXero data の読み書きのためのコードの作成について説明します。

Xero Items Entity のDAO を作成

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 MyItemsDAO { //insert new data into Xero @SqlUpdate("INSERT INTO Items (Name, QuantityOnHand) values (:name, :quantityOnHand)") void insert(@Bind("name") String name, @Bind("quantityOnHand") String quantityOnHand); //request specific data from Xero (String type is used for simplicity) @SqlQuery("SELECT QuantityOnHand FROM Items WHERE Name = :name") String findQuantityOnHandByName(@Bind("name") String name); /* * close with no args is used to close the connection */ void close(); }

Xero への接続を開く

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

To connect, set the Schema connection property in addition to any authentication values. Xero offers authentication for private applications, public applications, and partner applications. You will need to set the XeroAppAuthentication property to PUBLIC, PRIVATE, or PARTNER, depending on the type of application configured. To connect from a private application, you will additionally need to set the OAuthAccessToken, OAuthClientId, OAuthClientSecret, CertificateStoreType, CertificateStore, and CertificateStorePassword.

To connect from a public or partner application, you can use the embedded OAuthClientId, OAuthClientSecret, and CallbackURL, or you can register an app to obtain your own OAuth values.

See the "Getting Started" chapter of the help documentation for a guide to authenticating to Xero.


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

java -jar cdata.jdbc.xero.jar

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

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


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:xero:InitiateOAuth=GETANDREFRESH"); MyItemsDAO dao =; //do stuff with the DAO dao.close();

Xero Data について

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

//disply the result of our 'find' method String quantityOnHand = dao.findQuantityOnHandByName("Golf balls - white single"); System.out.println(quantityOnHand);

Xero Data の書き方

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

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

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