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

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

Halo Service Desk Assets Entity のDAO を作成

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

public interface MyAssetsDAO {
  //request specific data from Halo Service Desk (String type is used for simplicity)
  @SqlQuery("SELECT InventoryNumber FROM Assets WHERE ClientId = :clientId")
  String findInventoryNumberByClientId(@Bind("clientId") String clientId);

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

Halo Service Desk への接続を開く

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

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

HaloServiceDesk API プロファイル設定

HaloServiceDesk では API キー認証を使用します。API キーは、HaloServiceDesk の「Administration」>「Integrations」>「Halo API」で確認・作成できます。

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

• AuthScheme：APIKey に設定します。
• APIKey：HaloServiceDesk アカウントの API キーに設定します。
• Domain：HaloServiceDesk インスタンスのホスト名に設定します（例：yourcompany.haloservicedesk.com）。

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

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

java -jar cdata.jdbc.api.jar

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

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

jdbc:api:Profile=C:\profiles\HaloServiceDesk.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_api_key;Domain=yourcompany.haloservicedesk.com';

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

DBI dbi = new DBI("jdbc:api:Profile=C:\profiles\HaloServiceDesk.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_api_key;Domain=yourcompany.haloservicedesk.com';");
MyAssetsDAO dao = dbi.open(MyAssetsDAO.class);

//do stuff with the DAO

dao.close();

Halo Service Desk データについて

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

//disply the result of our 'find' method
String inventoryNumber = dao.findInventoryNumberByClientId("1");
System.out.println(inventoryNumber);

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