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