JDBI からPaymo データのデータアクセスオブジェクトを作成
JDBI は、Fluent スタイルとSQL オブジェクトスタイルという2つの異なるスタイルAPI を公開する、Java 用のSQL コンビニエンスライブラリです。CData JDBC Driver for API は、Java アプリケーションとリアルタイムPaymo のデータ のデータ連携を実現します。これらの技術を組み合わせることによって、Paymo のデータ へのシンプルなコードアクセスが可能になります。ここでは、基本的なDAO(Data Access Object )とそれに付随するPaymo のデータ の読み書きのためのコードの作成について説明します。
Paymo ClientContacts Entity のDAO を作成
以下のインターフェースは、実装されるSQL ステートメントごとに単一のメソッドを作成するためのSQL オブジェクトの正しい動作を宣言します。
public interface MyClientContactsDAO {
//request specific data from Paymo (String type is used for simplicity)
@SqlQuery("SELECT Name FROM ClientContacts WHERE ClientId = :clientId")
String findNameByClientId(@Bind("clientId") String clientId);
/*
* close with no args is used to close the connection
*/
void close();
}
Paymo への接続を開く
必要な接続プロパティを収集し、Paymo に接続するための適切なJDBC URL を作成します。
まず、Profile 接続プロパティをディスク上の Paymo プロファイルの場所に設定します(例:C:\profiles\Paymo.apip)。次に、ProfileSettings 接続プロパティを Paymo の接続文字列に設定します(以下を参照)。
Paymo API プロファイル設定
Paymo アカウントにログインし、My Settings > Integrations > API Keys に移動して、Generate New Key を選択し、API キーを作成します。
ビルトイン接続文字列デザイナー
JDBC URL の構成については、Paymo JDBC Driver に組み込まれている接続文字列デザイナーを使用してください。JAR ファイルのダブルクリック、またはコマンドラインからJAR ファイルを実行します。
java -jar cdata.jdbc.api.jar
接続プロパティを入力し、接続文字列をクリップボードにコピーします。
Paymo の接続文字列は、通常次のようになります。
jdbc:api:Profile=C:\profiles\Paymo.apip;ProfileSettings='APIKey=your_api_key';
構成済みのJDBC URL を使用して、DAO インターフェースのインスタンスを取得します。以下に示す特定のメソッドはインスタンスにバインドされたハンドルを開くため、ハンドルとバインドされたJDBC 接続を開放するには、インスタンスを明示的に閉じる必要があります。
DBI dbi = new DBI("jdbc:api:Profile=C:\profiles\Paymo.apip;ProfileSettings='APIKey=your_api_key';");
MyClientContactsDAO dao = dbi.open(MyClientContactsDAO.class);
//do stuff with the DAO
dao.close();
Paymo データについて
Paymo への接続を開いた状態で以前定義したメソッドを呼び出すだけで、Paymo のClientContacts エンティティからデータを取得できます。
//disply the result of our 'find' method
String name = dao.findNameByClientId("12345");
System.out.println(name);
JDBI ライブラリはJDBC 接続を処理できるため、CData JDBC Driver for API と統合することで、SQL Object API for API を簡単に作成できます。今すぐ無料トライアルをダウンロードし、Java アプリケーションでリアルタイムPaymo を操作しましょう。