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