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

加藤龍彦
デジタルマーケティング

JDBI でTypeform のデータ用のSQL オブジェクトAPIを作成する方法を概説します。

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

Typeform Tags Entity のDAO を作成

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

public interface MyTagsDAO {
  //request specific data from Typeform (String type is used for simplicity)
  @SqlQuery("SELECT Title FROM Tags WHERE SettingsIsPublic = :settingsIsPublic")
  String findTitleBySettingsIsPublic(@Bind("settingsIsPublic") String settingsIsPublic);

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

Typeform への接続を開く

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

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

TypeForm API プロファイル設定

TypeForm への認証にはOAuth 標準を使用します。

TypeForm に認証するには、まずTypeForm でOAuth アプリケーションを登録および設定する必要があります：https://admin.typeform.com/account#/section/tokens。アプリにはclient ID とclient secret が割り当てられ、接続文字列で設定できます。OAuth アプリケーションの設定の詳細については、https://developer.typeform.com/get-started/ をご参照ください。

使用シナリオによって異なるリダイレクトURI が必要です：

CData デスクトップアプリケーション：CData デスクトップアプリケーション（Sync、API Server、ArcESB）は/src/oauthCallback.rst でOAuth トークンを受け入れます。ホストとポートはアプリケーションが使用するデフォルトポートと同じです。例えば、http://localhost:8019/ でCData Sync にアクセスする場合、リダイレクトURI はhttp://localhost:8019/src/oauthCallback.rst になります。
CData クラウドアプリケーション：CData クラウドアプリケーションはデスクトップ版と同様です。https://1.2.3.4/ でConnect AI にアクセスする場合、リダイレクトはhttps://1.2.3.4/src/oauthCallback.rst を使用します。
デスクトップアプリケーション：デスクトップアプリケーションを使用する場合、URI はhttps://localhost:33333 を推奨します。
Web アプリケーション：ドライバーを使用してWeb アプリケーションを開発する場合、https://my-website.com/oauth のような独自のURI を使用します。

以下の接続プロパティを設定すると、接続の準備が整います：

AuthScheme：OAuth に設定します。
InitiateOAuth：GETANDREFRESH に設定します。InitiateOAuth を使用してOAuthAccessToken を取得するプロセスを管理できます。
OAuthClientId：アプリ設定で指定されているClient Id を設定します。
OAuthClientSecret：アプリ設定で指定されているClient Secret を設定します。
CallbackURL：アプリ設定で指定したRedirect URI を設定します。

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

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

java -jar cdata.jdbc.api.jar

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

Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)

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

jdbc:api:Profile=C:\profiles\TypeForm.apip;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\TypeForm.apip;Authscheme=OAuth;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;");
MyTagsDAO dao = dbi.open(MyTagsDAO.class);

//do stuff with the DAO

dao.close();

Typeform データについて

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

//disply the result of our 'find' method
String title = dao.findTitleBySettingsIsPublic("true");
System.out.println(title);

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

はじめる準備はできましたか？

API Driver で Typeform のライブデータに接続

Typeform に接続お問い合わせ