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

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

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

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

   まずはOAuth アプリを作成します。https://app.secure.freee.co.jp/developers/applications にアクセスして、「新しいアプリケーションの作成」ボタンをクリックします。アプリケーション名を指定し、リダイレクトURL を設定して登録をクリックします。そうすると、クライアントシークレットとクライアントID が発行されます。

   次に、プロファイルをダウンロードしてドライバーがアクセス可能な場所に配置します。こちらからプロファイルをダウンロードして、「C:/profiles/」 などに設置してください。

   その後、Companies ビューからCompanyId を取得します。以下の接続プロパティを設定したら、接続する準備ができます。

   • AuthScheme：OAuth に設定します。
   • OAuthClientID：アプリ設定で指定されたOAuth クライアントID に設定します。
   • OAuthClientSecret：アプリ設定で指定されたOAuth クライアントシークレットに設定します。
   • CallbackURL：アプリ設定で指定したリダイレクトURI に設定します。
   • InitiateOAuth：GETANDREFRESH に設定します。InitiateOAuth を使用してOAuthAccessToken を取得するプロセスを管理できます。

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

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

   java -jar cdata.jdbc.api.jar
   

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

   

   以下のリソース定義で指定された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=freeepm.apip;ProfileSettings='CompanyId=1234567;';Authscheme=OAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;" maxActive="20" maxIdle="10" maxWait="-1" />
   

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

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

3. アプリケーションの web.xml にリソースへの参照を追加します。

   
     freee Project Management のデータ 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 との連携について

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