Mule アプリケーションからHubDB データにアクセス：CData JDBC Driver

こんにちは！ドライバー周りのヘルプドキュメントを担当している古川です。

CData JDBC Driver for HubDB はHubDB データをMule アプリケーションと連携することで、読み、書き、更新、削除といった機能をおなじみのSQL クエリを使って実現します。JDBC ドライバーを使えば、HubDB データをバックアップ、変換、レポート作成、分析するMule アプリケーションをユーザーは簡単に作成できます。

本記事では、Mule プロジェクト内でCData JDBC Driver for HubDB を使用して、HubDB データのWeb インターフェースを作成する方法を紹介します。作成したアプリケーションを使えば、HTTP 経由でHubDB データをリクエストして、JSON 形式で結果を取得できます。まったく同様の手順で、すべてのCData JDBC ドライバで240 を超えるデータソースのWeb インターフェースを作成できます。手順は以下のとおりです。

1. Anypoint Studio で新しいMule プロジェクトを作る。
2. Message Flow にHTTP コネクタを追加する。
3. HTTP コネクタのアドレスを設定する。
4. HTTP コネクタの追加後、Database Select コネクタを同じフローに追加する。
5. データベースへの新しい接続を作成し（または既存の接続を編集し）、プロパティを設定する。
   • 接続を「Generic Connection」に設定
   • Required Libraries セクションでCData JDBC ドライバのJAR ファイルを指定する(例：cdata.jdbc.hubdb.jar)。
   • HubDB の接続文字列にURL を指定

     HubDBデータソースへの接続には、パブリックHubSpotアプリケーションを使用したOAuth認証とプライベートアプリケーショントークンを使用した認証の2つの方法があります。

     カスタムOAuthアプリを使用する

     すべてのOAuthフローでAuthSchemeを"OAuth"に設定する必要があります。特定の認証ニーズ（デスクトップアプリケーション、Webアプリケーション、ヘッドレスマシン）に必要な接続プロパティについては、ヘルプドキュメントを確認してください。

     アプリケーションを登録し、OAuthクライアント認証情報を取得するには、以下の手順を実行してください。

     1. HubSpotアプリ開発者アカウントにログインします。
        • アプリ開発者アカウントである必要があります。標準のHubSpotアカウントではパブリックアプリを作成できません。
     2. 開発者アカウントのホームページで、アプリタブをクリックします。
     3. アプリを作成をクリックします。
     4. アプリ情報タブで、ユーザーが接続する際に表示される値を入力し、必要に応じて変更します。これらの値には、パブリックアプリケーション名、アプリケーションロゴ、アプリケーションの説明が含まれます。
     5. 認証タブで、「リダイレクトURL」ボックスにコールバックURLを入力します。
        • デスクトップアプリケーションを作成する場合は、http://localhost:33333のようなローカルにアクセス可能なURLに設定します。
        • Webアプリケーションを作成する場合は、ユーザーがアプリケーションを承認した際にリダイレクトされる信頼できるURLに設定します。
     6. アプリを作成をクリックします。HubSpotがアプリケーションとそれに関連する認証情報を生成します。
     7. 認証タブで、クライアントIDとクライアントシークレットを確認します。これらは後でドライバーを設定する際に使用します。

     8. スコープの下で、アプリケーションの意図する機能に必要なスコープを選択します。

        テーブルにアクセスするには、最低限以下のスコープが必要です：

        • hubdb
        • oauth
        • crm.objects.owners.read
     9. 変更を保存をクリックします。
     10. 統合に必要な機能にアクセスできる本番ポータルにアプリケーションをインストールします。
         • 「インストールURL（OAuth）」の下で、完全なURLをコピーをクリックして、アプリケーションのインストールURLをコピーします。
         • コピーしたリンクをブラウザで開きます。アプリケーションをインストールする標準アカウントを選択します。
         • アプリを接続をクリックします。結果のタブは閉じて構いません。

     プライベートアプリを使用する

     HubSpotプライベートアプリケーショントークンを使用して接続するには、AuthSchemeプロパティを"PrivateApp"に設定します。

     以下の手順に従ってプライベートアプリケーショントークンを生成できます：

     1. HubDBアカウントで、メインナビゲーションバーの設定アイコン（歯車）をクリックします。
     2. 左サイドバーメニューで、統合 > プライベートアプリに移動します。
     3. プライベートアプリを作成をクリックします。
     4. 基本情報タブで、アプリケーションの詳細（名前、ロゴ、説明）を設定します。
     5. スコープタブで、プライベートアプリケーションがアクセスできるようにしたい各スコープに対して読み取りまたは書き込みを選択します。
     6. テーブルにアクセスするには、最低限hubdbとcrm.objects.owners.readが必要です。
     7. アプリケーションの設定が完了したら、右上のアプリを作成をクリックします。
     8. アプリケーションのアクセストークンに関する情報を確認し、作成を続行をクリックし、その後トークンを表示をクリックします。
     9. コピーをクリックして、プライベートアプリケーショントークンをコピーします。

     接続するには、PrivateAppTokenを取得したプライベートアプリケーショントークンに設定します。

     組み込みの接続文字列デザイナ

     JDBC 用のURL の作成にサポートが必要な場合は、HubDB JDBC Driver に組み込まれた接続文字列デザイナを使用できます。JAR ファイルをダブルクリックするか、コマンドラインからJAR ファイルを実行してください。

     java -jar cdata.jdbc.hubdb.jar

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

   • Driver クラス名をcdata.jdbc.hubdb.HubDBDriver に指定します。
   • 「接続テスト」をクリックします。
6. SQL Query Text をHubDB データをリクエストするためのSQL クエリに設定します。例えば、SELECT PartitionKey, Name FROM NorthwindProducts WHERE Id = '1'。
7. Transform Message コンポーネントをフローに追加します。
8. Output スクリプトを次のように設定して、ペイロードをJSON に変換します。

   %dw 2.0
   output application/json
   ---
   payload
           

9. HubDB データを閲覧するには、HTTP コネクタ用に設定したアドレスに移動します（デフォルトでは、localhost:8081）：http://localhost:8081。Web ブラウザおよびJSON エンドポイントを使用可能な他のツール内で、HubDB データをJSON として利用できます。

これで、カスタムアプリケーションおよび他のさまざまなBI、帳票、ETL ツールからHubDB データを（JSON データとして）扱うための簡易なWeb インターフェースを作成できました。Mule アプリケーションからお好みのデータソースにアクセスできる、JDBC Driver for HubDB の30日の無償評価版のダウンロードはこちらから。