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

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

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

BambooHR Employees Entity のDAO を作成

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

public interface MyEmployeesDAO {
  //request specific data from BambooHR (String type is used for simplicity)
  @SqlQuery("SELECT DisplayName FROM Employees WHERE Department = :department")
  String findDisplayNameByDepartment(@Bind("department") String department);

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

BambooHR への接続を開く

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

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

BambooHR API プロファイル設定

BambooHR に認証するには、API キーを提供する必要があります。API キーを生成するには、ログインして任意のページの右上隅にある自分の名前をクリックし、ユーザーコンテキストメニューにアクセスします。十分な権限がある場合、そのメニューに「API Keys」オプションが表示され、新しいAPI キーを作成できるページに移動できます。また、BambooHR アカウントのドメイン名にあるDomain を設定します。例えば、BambooHR アカウントがacmeinc.bamboohr.com の場合、Domain は「acmeinc」となります。ProfileSettings プロパティにAPI KeyDomain の両方を設定して接続します。

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

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

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

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

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

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

//do stuff with the DAO

dao.close();

BambooHR データについて

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

//disply the result of our 'find' method
String displayName = dao.findDisplayNameByDepartment("Sales");
System.out.println(displayName);

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

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

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

BambooHR に接続 お問い合わせ