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

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

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

Teamgate Activities Entity のDAO を作成

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


public interface MyActivitiesDAO {
  //request specific data from Teamgate (String type is used for simplicity)
  @SqlQuery("SELECT Status FROM Activities WHERE Status = :status")
  String findStatusByStatus(@Bind("status") String status);

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

Teamgate への接続を開く

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

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

Teamgate API プロファイル設定

API キーを取得するには、Teamgate にログインして Settings > Additional Features > External Apps > New API Key Request に移動します。Auth Token は My Profile > Integrations > API Access > Auth Token から取得できます。

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

JDBC URL の構成については、Teamgate 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.)

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

jdbc:api:Profile=C:\profiles\Teamgate.apip;ProfileSettings='APIKey=your_api_key;AuthToken=your_auth_token';

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


DBI dbi = new DBI("jdbc:api:Profile=C:\profiles\Teamgate.apip;ProfileSettings='APIKey=your_api_key;AuthToken=your_auth_token';");
MyActivitiesDAO dao = dbi.open(MyActivitiesDAO.class);

//do stuff with the DAO

dao.close();

Teamgate データについて

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


//disply the result of our 'find' method
String status = dao.findStatusByStatus("Completed");
System.out.println(status);

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

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

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

Teamgate に接続