JDBI からClio データのデータアクセスオブジェクトを作成
JDBI は、Fluent スタイルとSQL オブジェクトスタイルという2つの異なるスタイルAPI を公開する、Java 用のSQL コンビニエンスライブラリです。CData JDBC Driver for API は、Java アプリケーションとリアルタイムClio のデータ のデータ連携を実現します。これらの技術を組み合わせることによって、Clio のデータ へのシンプルなコードアクセスが可能になります。ここでは、基本的なDAO(Data Access Object )とそれに付随するClio のデータ の読み書きのためのコードの作成について説明します。
Clio Bills Entity のDAO を作成
以下のインターフェースは、実装されるSQL ステートメントごとに単一のメソッドを作成するためのSQL オブジェクトの正しい動作を宣言します。
public interface MyBillsDAO {
//request specific data from Clio (String type is used for simplicity)
@SqlQuery("SELECT Total FROM Bills WHERE State = :state")
String findTotalByState(@Bind("state") String state);
/*
* close with no args is used to close the connection
*/
void close();
}
Clio への接続を開く
必要な接続プロパティを収集し、Clio に接続するための適切なJDBC URL を作成します。
まず、Profile 接続プロパティをディスク上のClio プロファイルの場所に設定します(例:C:\profiles\Clio.apip)。次に、ProfileSettings 接続プロパティをClio の接続文字列に設定します(以下を参照)。
Clio API プロファイル設定
Clio はOAuth ベースの認証を使用します。
まず、Clio でOAuth アプリケーションを登録します。Developer アカウントにログインし、Add ボタンをクリックして登録できます。ここでアプリケーションの詳細とスコープを入力します。これらの詳細は、Clio ユーザーがアプリケーションの認可を求められたときに表示されます。OAuth アプリケーションにはclient id(キー)とclient secret(シークレット)が割り当てられます。また、ProfileSettings 接続プロパティでRegion を設定します。
以下の接続プロパティを設定すると、接続できるようになります。
- AuthScheme:OAuth に設定します。
- InitiateOAuth:GETANDREFRESH に設定します。InitiateOAuth を使用して、OAuthAccessToken を取得するプロセスを管理できます。
- OAuthClientId:アプリ設定で指定されたclient_id に設定します。
- OAuthClientSecret:アプリ設定で指定されたclient_secret に設定します。
- CallbackURL:アプリ設定で指定されたRedirect URI に設定します。
- Region:ProfileSettings でClio の地理的リージョンに設定します。デフォルトはapp.clio.com です。
ビルトイン接続文字列デザイナー
JDBC URL の構成については、Clio JDBC Driver に組み込まれている接続文字列デザイナーを使用してください。JAR ファイルのダブルクリック、またはコマンドラインからJAR ファイルを実行します。
java -jar cdata.jdbc.api.jar
接続プロパティを入力し、接続文字列をクリップボードにコピーします。
Clio の接続文字列は、通常次のようになります。
jdbc:api:Profile=C:\profiles\Clio.apip;ProfileSettings='Region=your_region';Authscheme=OAuth;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;
構成済みのJDBC URL を使用して、DAO インターフェースのインスタンスを取得します。以下に示す特定のメソッドはインスタンスにバインドされたハンドルを開くため、ハンドルとバインドされたJDBC 接続を開放するには、インスタンスを明示的に閉じる必要があります。
DBI dbi = new DBI("jdbc:api:Profile=C:\profiles\Clio.apip;ProfileSettings='Region=your_region';Authscheme=OAuth;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;");
MyBillsDAO dao = dbi.open(MyBillsDAO.class);
//do stuff with the DAO
dao.close();
Clio データについて
Clio への接続を開いた状態で以前定義したメソッドを呼び出すだけで、Clio のBills エンティティからデータを取得できます。
//disply the result of our 'find' method
String total = dao.findTotalByState("awaiting_payment");
System.out.println(total);
JDBI ライブラリはJDBC 接続を処理できるため、CData JDBC Driver for API と統合することで、SQL Object API for API を簡単に作成できます。今すぐ無料トライアルをダウンロードし、Java アプリケーションでリアルタイムClio を操作しましょう。