各製品の資料を入手。
詳細はこちら →
製品をチェック
JDBI からZoho Books データ のデータアクセスオブジェクトを作成
JDBI でZoho Books のデータ 用のSQL オブジェクトAPIを作成する方法を概説します。
最終更新日：2022-05-25
この記事で実現できるZoho Books 連携のシナリオ
こんにちは！ウェブ担当の加藤です。マーケ関連のデータ分析や整備もやっています。
JDBI は、Fluent スタイルとSQL オブジェクトスタイルという2つの異なるスタイルAPI を公開する、Java 用のSQL コンビニエンスライブラリです。CData JDBC Driver for ZohoBooks は、Java アプリケーションとリアルタイムZoho Books のデータ のデータ連携を実現します。これらの技術を組み合わせることによって、Zoho Books のデータ へのシンプルなコードアクセスが可能になります。ここでは、基本的なDAO（Data Access Object ）とそれに付随するZoho Books のデータ の読み書きのためのコードの作成について説明します。
Zoho Books INVOICES Entity のDAO を作成
以下のインターフェースは、実装されるSQL ステートメントごとに単一のメソッドを作成するためのSQL オブジェクトの正しい動作を宣言します。
public interface MyINVOICESDAO {
//request specific data from Zoho Books (String type is used for simplicity)
@SqlQuery("SELECT InvoiceNumber FROM INVOICES WHERE CustomerName = :customerName")
String findInvoiceNumberByCustomerName(@Bind("customerName") String customerName);
/*
* close with no args is used to close the connection
*/
void close();
}
Zoho Books への接続を開く
必要な接続プロパティを収集し、Zoho Books に接続するための適切なJDBC URL を作成します。
Zoho Books 接続プロパティの取得・設定方法
以下の接続プロパティを使用して、取得されるZoho Books データを正確に絞り込むことができます。
- Region：サーバーURL のトップレベルドメイン（TLD）。アカウントが米国以外のドメインにある場合は、リージョンを適宜変更してください。
- OrganizationId（オプション）：接続先の特定のZoho Books 組織に関連付けられたID。
- Organization Id の値が接続文字列で指定されていない場合、ドライバーは利用可能なすべての組織を自動的に取得し、最初のOrganization Id をデフォルトとして選択します。
Zoho Books への認証
Zoho Books はOAuth 認証標準を使用します。詳しくは、ヘルプドキュメントの「はじめに」セクションを参照してください。
ビルトイン接続文字列デザイナー
JDBC URL の構成については、Zoho Books JDBC Driver に組み込まれている接続文字列デザイナーを使用してください。JAR ファイルのダブルクリック、またはコマンドラインからJAR ファイルを実行します。
java -jar cdata.jdbc.zohobooks.jar
接続プロパティを入力し、接続文字列をクリップボードにコピーします。
Zoho Books の接続文字列は、通常次のようになります。
jdbc:zohobooks:OAuthClientId=MyOAuthClientId;OAuthClientSecret=myOAuthClientSecret;CallbackURL=https://localhost:33333;OrganizationId=MyOrganizationId;InitiateOAuth=GETANDREFRESH
構成済みのJDBC URL を使用して、DAO インターフェースのインスタンスを取得します。以下に示す特定のメソッドはインスタンスにバインドされたハンドルを開くため、ハンドルとバインドされたJDBC 接続を開放するには、インスタンスを明示的に閉じる必要があります。
DBI dbi = new DBI("jdbc:zohobooks:OAuthClientId=MyOAuthClientId;OAuthClientSecret=myOAuthClientSecret;CallbackURL=https://localhost:33333;OrganizationId=MyOrganizationId;InitiateOAuth=GETANDREFRESH");
MyINVOICESDAO dao = dbi.open(MyINVOICESDAO.class);
//do stuff with the DAO
dao.close();
Zoho Books データ について
Zoho Books への接続を開いた状態で以前定義したメソッドを呼び出すだけで、Zoho Books のINVOICES エンティティからデータを取得できます。
//disply the result of our 'find' method
String invoiceNumber = dao.findInvoiceNumberByCustomerName("NewTech Industries");
System.out.println(invoiceNumber);
JDBI ライブラリはJDBC 接続を処理できるため、CData JDBC Driver for ZohoBooks と統合することで、SQL Object API for ZohoBooks を簡単に作成できます。今すぐ無料トライアルをダウンロードし、Java アプリケーションでリアルタイムZoho Books を操作しましょう。
関連コンテンツ
