Tomcat のコネクションプールで CData JDBC Driver for ApprovalMax を構成

Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Tomcat のコネクションプールから ApprovalMax のデータ に接続。



CData JDBC Driver は、JVM 上で動作するWeb アプリケーションと連携するための標準JDBC インターフェースをサポートしています。ここでは、Tomcat のコネクションプールから ApprovalMax のデータ に接続する方法を説明します。

Tomcat のコネクションプールから ApprovalMax のデータ に接続

  1. CData JAR ファイルと CData .lic ファイルを $CATALINA_HOME/lib にコピーします。CData JAR ファイルは、インストールディレクトリの lib サブフォルダにあります。
  2. コンテキストにリソースの定義を追加します。ここで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
    

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

    組み込みの接続文字列デザイナーでJDBC URL を生成(図はSalesforce の例)

    以下のリソース定義で指定されたJDBC URL を確認できます。

    
    
    <Resource name="jdbc/api"   auth="Container" type="javax.sql.DataSource" driverClassName="cdata.jdbc.api.APIDriver" factory="org.apache.tomcat.jdbc.pool.DataSourceFactory" url="jdbc:api:Profile=C:\profiles\ApprovalMax.apip;AuthScheme=OAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackURL=your_callback_url;" maxActive="20" maxIdle="10" maxWait="-1" />
    

    特定のアプリケーションのみに ApprovalMax のデータ へのアクセスを許可するには、上記のコードをアプリケーションのMETA-INF ディレクトリにあるcontext.xml に追加します。

    共有リソースの構成の場合は、上記のコードを $CATALINA_BASE/conf にあるcontext.xml に追加します。共有リソースの構成では、すべてのアプリケーションが ApprovalMax に接続できるようになります。

  3. アプリケーションの web.xml にリソースへの参照を追加します。
    
    
      ApprovalMax のデータ JSP
      jdbc/API
      javax.sql.DataSource
      Container
    
    
  4. コネクションプールから接続を初期化します。
    
    Context initContext = new InitialContext();
    Context envContext  = (Context)initContext.lookup("java:/comp/env");
    DataSource ds = (DataSource)envContext.lookup("jdbc/API");
    Connection conn = ds.getConnection();
      

Tomcat との連携について

上記の手順では、シンプルなコネクションプーリングのシナリオで ApprovalMax のデータ に接続する方法を説明しました。その他のユースケースや詳細については、Tomcat のドキュメントに記載されている JNDI Datasource How-To を参照してください。

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

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

ApprovalMax に接続