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

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

Harvest Invoices Entity のDAO を作成

以下のインターフェースは、実装されるSQL ステートメントごとに単一のメソッドを作成するためのSQL オブジェクトの正しい動作を宣言します。

public interface MyInvoicesDAO {
  //request specific data from Harvest (String type is used for simplicity)
  @SqlQuery("SELECT ClientName FROM Invoices WHERE State = :state")
  String findClientNameByState(@Bind("state") String state);

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

Harvest への接続を開く

必要な接続プロパティを収集し、Harvest に接続するための適切なJDBC URL を作成します。

まず、Profile 接続プロパティをディスク上のHarvest プロファイルの場所に設定します（例：C:\profiles\Harvest.apip）。次に、ProfileSettings 接続プロパティをHarvest の接続文字列に設定します（以下を参照）。

Harvest API プロファイル設定

Harvest に認証するには、トークン認証またはOAuth 標準のいずれかを使用できます。自分のデータに接続するにはBasic 認証を使用します。他のユーザーが自分のデータに接続できるようにするにはOAuth を使用します。

トークン認証の使用

トークン認証を使用するには、ProfileSettings 接続プロパティでAPIKey にHarvest パーソナルアクセストークンを設定します。APIKey に加えて、ProfileSettings でAccountId を設定して接続します。

OAuth 認証の使用

まず、Harvest でOAuth2 アプリケーションを登録します。アプリケーションはHarvest ID の「Developers」セクションから作成できます。

以下の接続プロパティを設定すると、接続できるようになります。

• ProfileSettings：ProfileSettings でAccountId を設定します。
• AuthScheme：OAuth に設定します。
• OAuthClientId：アプリ設定で指定したclient ID に設定します。
• OAuthClientSecret：アプリ設定で指定したclient secret に設定します。
• CallbackURL：アプリ設定で指定したRedirect URI に設定します。
• InitiateOAuth：GETANDREFRESH に設定します。InitiateOAuth を使用して、ドライバーがOAuthAccessToken を取得および更新する方法を管理できます。

ビルトイン接続文字列デザイナー

JDBC URL の構成については、Harvest JDBC Driver に組み込まれている接続文字列デザイナーを使用してください。JAR ファイルのダブルクリック、またはコマンドラインからJAR ファイルを実行します。

java -jar cdata.jdbc.api.jar

接続プロパティを入力し、接続文字列をクリップボードにコピーします。

Harvest の接続文字列は、通常次のようになります。

jdbc:api:Profile=C:\profiles\Harvest.apip;ProfileSettings='APIKey=my_personal_key;AccountId=_your_account_id';

構成済みのJDBC URL を使用して、DAO インターフェースのインスタンスを取得します。以下に示す特定のメソッドはインスタンスにバインドされたハンドルを開くため、ハンドルとバインドされたJDBC 接続を開放するには、インスタンスを明示的に閉じる必要があります。

DBI dbi = new DBI("jdbc:api:Profile=C:\profiles\Harvest.apip;ProfileSettings='APIKey=my_personal_key;AccountId=_your_account_id';");
MyInvoicesDAO dao = dbi.open(MyInvoicesDAO.class);

//do stuff with the DAO

dao.close();

Harvest データについて

Harvest への接続を開いた状態で以前定義したメソッドを呼び出すだけで、Harvest のInvoices エンティティからデータを取得できます。

//disply the result of our 'find' method
String clientName = dao.findClientNameByState("open");
System.out.println(clientName);

JDBI ライブラリはJDBC 接続を処理できるため、CData JDBC Driver for API と統合することで、SQL Object API for API を簡単に作成できます。今すぐ無料トライアルをダウンロードし、Java アプリケーションでリアルタイムHarvest を操作しましょう。