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

加藤龍彦
加藤龍彦
デジタルマーケティング
JDBI でTimeCamp のデータ 用のSQL オブジェクトAPIを作成する方法を概説します。

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

TimeCamp GroupUsers Entity のDAO を作成

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


public interface MyGroupUsersDAO {
  //request specific data from TimeCamp (String type is used for simplicity)
  @SqlQuery("SELECT Email FROM GroupUsers WHERE GroupId = :groupId")
  String findEmailByGroupId(@Bind("groupId") String groupId);

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

TimeCamp への接続を開く

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

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

TimeCamp API プロファイル設定

TimeCamp ではトークンベースの認証を使用します。API トークンは以下の手順で取得できます。

  1. https://app.timecamp.com で TimeCamp アカウントにログインします。
  2. 画面右上のプロフィールアバターをクリックします。
  3. 「Profile Settings」を選択します。
  4. ページ下部に表示されている API トークンをコピーします。

API トークンを取得したら、以下の接続プロパティを設定します。

  • AuthScheme:APIKey に設定します。

ProfileSettings 接続プロパティには、以下を設定します。

  • APIKey:TimeCamp の API トークンに設定します。

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

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


java -jar cdata.jdbc.api.jar

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

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

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

jdbc:api:Profile=C:\profiles\TimeCamp.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_api_token';

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


DBI dbi = new DBI("jdbc:api:Profile=C:\profiles\TimeCamp.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_api_token';");
MyGroupUsersDAO dao = dbi.open(MyGroupUsersDAO.class);

//do stuff with the DAO

dao.close();

TimeCamp データについて

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


//disply the result of our 'find' method
String email = dao.findEmailByGroupId("12345");
System.out.println(email);

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

はじめる準備はできましたか?

API Driver で TimeCamp のライブデータに接続

TimeCamp に接続