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

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

ApprovalMax UserProfiles Entity のDAO を作成

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

public interface MyUserProfilesDAO {
  //request specific data from ApprovalMax (String type is used for simplicity)
  @SqlQuery("SELECT Email FROM UserProfiles WHERE CompanyId = :companyId")
  String findEmailByCompanyId(@Bind("companyId") String companyId);

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

ApprovalMax への接続を開く

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

まず、Profile 接続プロパティをディスク上の ApprovalMax プロファイルの場所に設定します（例：C:\profiles\ApprovalMax.apip）。次に、ProfileSettings 接続プロパティを ApprovalMax の接続文字列に設定します（以下を参照）。

ApprovalMax API プロファイル設定

ApprovalMax Public API では、OAuth 2.0 の認可コードフローで認証を行います。自分のデータに接続するだけでなく、他のユーザーが各自のデータに接続できるようにすることも可能です。

まず、ApprovalMax に OAuth アプリケーションを登録する必要があります。ApprovalMax Developer Portal（https://developer.approvalmax.com/applications）にサインインし、新しいアプリケーションを作成します。OAuth アプリケーションには Client ID と Client Secret が割り当てられます。また、Redirect URI（Callback URL）を少なくとも1つ登録しておく必要があります。

Public API を利用するには、ApprovalMax の Premium サブスクリプション（または有効なトライアル）が必要です。

以下の接続プロパティを設定すると、接続できるようになります。

• AuthScheme：OAuth に設定します。
• InitiateOAuth：GETANDREFRESH に設定します。InitiateOAuth を使うと、OAuthAccessToken を取得するプロセスを管理できます。
• OAuthClientId：ApprovalMax Developer Portal のアプリケーション設定に表示される Client ID に設定します。
• OAuthClientSecret：ApprovalMax Developer Portal のアプリケーション設定に表示される Client Secret に設定します。
• CallbackURL：アプリケーション設定で登録した Redirect URI に設定します。
• Scope：（オプション）デフォルトの OAuth スコープを上書きします。デフォルト値の openid offline_access https://www.approvalmax.com/scopes/public_api/read は、このプロファイルのすべてのテーブルへの読み取り専用アクセスを許可し、リフレッシュトークンを有効にします。スコープを絞り込む際は、最小権限の原則に従ってください。

OAuth の Authorization URL は https://identity.approvalmax.com/connect/authorize、Token URL は https://identity.approvalmax.com/connect/token です。グラントタイプは authorization_code と refresh_token の両方に対応しています。

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

JDBC URL の構成については、ApprovalMax JDBC Driver に組み込まれている接続文字列デザイナーを使用してください。JAR ファイルのダブルクリック、またはコマンドラインからJAR ファイルを実行します。

java -jar cdata.jdbc.api.jar

接続プロパティを入力し、接続文字列をクリップボードにコピーします。

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

jdbc:api:Profile=C:\profiles\ApprovalMax.apip;AuthScheme=OAuth;InitiateOAuth=GETANDREFRESH;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\ApprovalMax.apip;AuthScheme=OAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackURL=your_callback_url;");
MyUserProfilesDAO dao = dbi.open(MyUserProfilesDAO.class);

//do stuff with the DAO

dao.close();

ApprovalMax データについて

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

//disply the result of our 'find' method
String email = dao.findEmailByCompanyId("00000000-0000-0000-0000-000000000000");
System.out.println(email);

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