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

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

Freshservice AgentGroups Entity のDAO を作成

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

public interface MyAgentGroupsDAO {
  //request specific data from Freshservice (String type is used for simplicity)
  @SqlQuery("SELECT Name FROM AgentGroups WHERE Name = :name")
  String findNameByName(@Bind("name") String name);

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

Freshservice への接続を開く

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

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

Freshservice API プロファイル設定

Freshservice 画面右上の Profile Settings から API キーを取得します。Domain はアカウント URL のサブドメインです。

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

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

java -jar cdata.jdbc.api.jar

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

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

jdbc:api:Profile=C:\profiles\Freshservice.apip;ProfileSettings='APIKey=your_api_key;Domain=your_subdomain';

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

DBI dbi = new DBI("jdbc:api:Profile=C:\profiles\Freshservice.apip;ProfileSettings='APIKey=your_api_key;Domain=your_subdomain';");
MyAgentGroupsDAO dao = dbi.open(MyAgentGroupsDAO.class);

//do stuff with the DAO

dao.close();

Freshservice データについて

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

//disply the result of our 'find' method
String name = dao.findNameByName("Support Team");
System.out.println(name);

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