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

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

Webflow Sites Entity のDAO を作成

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

public interface MySitesDAO {
  //request specific data from Webflow (String type is used for simplicity)
  @SqlQuery("SELECT  FROM Sites WHERE Id = :id")
  String findById(@Bind("id") String id);

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

Webflow への接続を開く

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

認証

Webflow は、サイト、CMS コレクション、e コマースデータ、その他のリソースへの安全なアクセスを確保するために、OAuth 2.0 認証を使用します。この認証方式により、Webflow ワークスペースに安全に接続し、適切な認可のもとでリソースを管理できます。

OAuth 2.0 のセットアップと設定

ステップ 1：Webflow OAuth アプリケーションの作成

OAuth 認証をセットアップするには、以下のステップで進めます：

1. Webflow Developer Portal にアクセスします
2. Webflow アカウントの「Apps & Integrations」に移動します
3. 「Register an App」をクリックして新しい OAuth アプリケーションを作成します
4. アプリケーション名、説明、リダイレクト URI（CallbackURL）を設定します
5. 接続で使用する Client ID と Client Secret をコピーします

必須の接続プロパティ

• AuthScheme：OAuth に設定します（必須）
• OAuthClientId：Webflow OAuth アプリケーションの Client ID（必須）
• OAuthClientSecret：Webflow OAuth アプリケーションの Client Secret（必須）
• CallbackURL：OAuth アプリケーションで指定したリダイレクト URI（必須）
• InitiateOAuth：トークンを自動管理するには GETANDREFRESH に設定します（推奨）

必須の OAuth スコープ

Webflow API プロファイルでは、以下の OAuth スコープが必要です：

• sites:read - サイト情報および設定への読み取りアクセス
• pages:read - サイトページへの読み取りアクセス
• cms:read - CMS コレクションおよびアイテムへの読み取りアクセス
• forms:read - フォームおよびフォーム送信への読み取りアクセス
• assets:read - メディアアセットおよびフォルダーへの読み取りアクセス
• ecommerce:read - 製品、注文、在庫への読み取りアクセス
• authorized_user:read - 認可されたユーザーへの読み取りアクセス

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

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

java -jar cdata.jdbc.api.jar

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

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

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

//do stuff with the DAO

dao.close();

Webflow データについて

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

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

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