JDBI からProcore データのデータアクセスオブジェクトを作成
JDBI は、Fluent スタイルとSQL オブジェクトスタイルという2つの異なるスタイルAPI を公開する、Java 用のSQL コンビニエンスライブラリです。CData JDBC Driver for API は、Java アプリケーションとリアルタイムProcore のデータ のデータ連携を実現します。これらの技術を組み合わせることによって、Procore のデータ へのシンプルなコードアクセスが可能になります。ここでは、基本的なDAO(Data Access Object )とそれに付随するProcore のデータ の読み書きのためのコードの作成について説明します。
Procore Companies Entity のDAO を作成
以下のインターフェースは、実装されるSQL ステートメントごとに単一のメソッドを作成するためのSQL オブジェクトの正しい動作を宣言します。
public interface MyCompaniesDAO {
//request specific data from Procore (String type is used for simplicity)
@SqlQuery("SELECT Name FROM Companies WHERE IsActive = :isActive")
String findNameByIsActive(@Bind("isActive") String isActive);
/*
* close with no args is used to close the connection
*/
void close();
}
Procore への接続を開く
必要な接続プロパティを収集し、Procore に接続するための適切なJDBC URL を作成します。
まず、Profile 接続プロパティにProcore プロファイルのディスク上の場所を設定します(例:C:\profiles\Procore.apip)。次に、ProfileSettings 接続プロパティにProcore の接続文字列を設定します(以下を参照)。
Procore API プロファイル設定
Procore に認証し、自分のデータに接続したり、他のユーザーが自分のデータに接続できるようにするには、OAuth 標準を使用できます。
まず、Procore にOAuth アプリケーションを登録します。Developer Account にログインし、Create New App に移動することで登録できます。アプリを登録するために必要なすべてのステップに従います。まずSandbox Manifest の新しいバージョンを作成し、Production に昇格させてProduction Credentials を取得します。OAuth アプリケーションにはclient id とclient secret が割り当てられます。
以下の接続プロパティを設定すると、接続の準備が整います:
- AuthScheme:OAuth に設定します。
- InitiateOAuth:GETANDREFRESH に設定します。InitiateOAuth を使用してOAuthAccessToken を取得するプロセスを管理できます。
- OAuthClientId:アプリ設定で指定されているclient_id を設定します。
- OAuthClientSecret:アプリ設定で指定されているclient_secret を設定します。
- CallbackURL:アプリ設定で指定されているRedirect URI を設定します。
ビルトイン接続文字列デザイナー
JDBC URL の構成については、Procore JDBC Driver に組み込まれている接続文字列デザイナーを使用してください。JAR ファイルのダブルクリック、またはコマンドラインからJAR ファイルを実行します。
java -jar cdata.jdbc.api.jar
接続プロパティを入力し、接続文字列をクリップボードにコピーします。
Procore の接続文字列は、通常次のようになります。
jdbc:api:Profile=C:\profiles\Procore.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\Procore.apip;Authscheme=OAuth;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;");
MyCompaniesDAO dao = dbi.open(MyCompaniesDAO.class);
//do stuff with the DAO
dao.close();
Procore データについて
Procore への接続を開いた状態で以前定義したメソッドを呼び出すだけで、Procore のCompanies エンティティからデータを取得できます。
//disply the result of our 'find' method
String name = dao.findNameByIsActive("true");
System.out.println(name);
JDBI ライブラリはJDBC 接続を処理できるため、CData JDBC Driver for API と統合することで、SQL Object API for API を簡単に作成できます。今すぐ無料トライアルをダウンロードし、Java アプリケーションでリアルタイムProcore を操作しましょう。