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

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

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

Onfleet Administrators Entity のDAO を作成

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

public interface MyAdministratorsDAO {
  //request specific data from Onfleet (String type is used for simplicity)
  @SqlQuery("SELECT  FROM Administrators WHERE  = :")
  String findBy(@Bind("") String );

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

Onfleet への接続を開く

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

Onfleet は HTTP API キー認証を使用します。Onfleet の API Key は、リクエストの認証に使われます。API Key は、Onfleet ダッシュボードの Settings > API で生成または確認できます。

API キー認証の設定

以下の接続プロパティを設定して接続を確立してください:

  • AuthScheme:APIKey に設定します。
  • APIKey:Onfleet の API Key に設定します。

接続文字列の例:

Profile=C:\profiles\Onfleet.apip;AuthScheme=APIKey;ProfileSettings="ApiKey=your_api_key";

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

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

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

jdbc:api:Profile=C:\profiles\Onfleet.apip;AuthScheme=APIKey;ProfileSettings="ApiKey=your_api_key";

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

DBI dbi = new DBI("jdbc:api:Profile=C:\profiles\Onfleet.apip;AuthScheme=APIKey;ProfileSettings="ApiKey=your_api_key";");
MyAdministratorsDAO dao = dbi.open(MyAdministratorsDAO.class);

//do stuff with the DAO

dao.close();

Onfleet データについて

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

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

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

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

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

Onfleet に接続