各製品の資料を入手。
詳細はこちら →
製品をチェック
JDBI からDocuSign データ のデータアクセスオブジェクトを作成
JDBI でDocuSign のデータ 用のSQL オブジェクトAPIを作成する方法を概説します。
最終更新日：2022-05-25
この記事で実現できるDocuSign 連携のシナリオ
こんにちは！ウェブ担当の加藤です。マーケ関連のデータ分析や整備もやっています。
JDBI は、Fluent スタイルとSQL オブジェクトスタイルという2つの異なるスタイルAPI を公開する、Java 用のSQL コンビニエンスライブラリです。CData JDBC Driver for DocuSign は、Java アプリケーションとリアルタイムDocuSign のデータ のデータ連携を実現します。これらの技術を組み合わせることによって、DocuSign のデータ へのシンプルなコードアクセスが可能になります。ここでは、基本的なDAO（Data Access Object ）とそれに付随するDocuSign のデータ の読み書きのためのコードの作成について説明します。
DocuSign Documents Entity のDAO を作成
以下のインターフェースは、実装されるSQL ステートメントごとに単一のメソッドを作成するためのSQL オブジェクトの正しい動作を宣言します。
public interface MyDocumentsDAO {
//insert new data into DocuSign
@SqlUpdate("INSERT INTO Documents (DocumentName, DocumentName) values (:documentName, :documentName)")
void insert(@Bind("documentName") String documentName, @Bind("documentName") String documentName);
//request specific data from DocuSign (String type is used for simplicity)
@SqlQuery("SELECT DocumentName FROM Documents WHERE DocumentName = :documentName")
String findDocumentNameByDocumentName(@Bind("documentName") String documentName);
/*
* close with no args is used to close the connection
*/
void close();
}
DocuSign への接続を開く
必要な接続プロパティを収集し、DocuSign に接続するための適切なJDBC URL を作成します。
DocuSign への接続には以下の接続プロパティを設定します:
- UseSandbox: UseSandbox は現在のユーザーアカウントがサンドボックスかそうでないかを示します。デフォルトはfalse です。サンドボックスアカウントがある場合はTrue に設定します。
- AccountId (optional): 認証が成功すると自動的に設定されます。 または、複数のAccount Id にアクセスできる場合は、接続文字列で手動で設定できます。アカウントId を取得するには、UserInfo ビューをクエリします。
DocuSign への認証
DocuSign はOAuth 認証標準を利用しています。OAuth を使って認証するには、アプリケーションを作成してOAuthClientId、OAuthClientSecret、およびCallbackURL 接続プロパティを取得しなければなりません。認証方法については、ヘルプドキュメントの「OAuth 認証の使用」を参照してください。
ビルトイン接続文字列デザイナー
JDBC URL の構成については、DocuSign JDBC Driver に組み込まれている接続文字列デザイナーを使用してください。JAR ファイルのダブルクリック、またはコマンドラインからJAR ファイルを実行します。
java -jar cdata.jdbc.docusign.jar
接続プロパティを入力し、接続文字列をクリップボードにコピーします。
DocuSign の接続文字列は、通常次のようになります。
jdbc:docusign:OAuthClientId=MyClientId; OAuthClientSecret=MyClientSecret; CallbackURL=http://localhost:33333; InitiateOAuth=GETANDREFRESH
構成済みのJDBC URL を使用して、DAO インターフェースのインスタンスを取得します。以下に示す特定のメソッドはインスタンスにバインドされたハンドルを開くため、ハンドルとバインドされたJDBC 接続を開放するには、インスタンスを明示的に閉じる必要があります。
DBI dbi = new DBI("jdbc:docusign:OAuthClientId=MyClientId; OAuthClientSecret=MyClientSecret;
CallbackURL=http://localhost:33333;
InitiateOAuth=GETANDREFRESH");
MyDocumentsDAO dao = dbi.open(MyDocumentsDAO.class);
//do stuff with the DAO
dao.close();
DocuSign データ について
DocuSign への接続を開いた状態で以前定義したメソッドを呼び出すだけで、DocuSign のDocuments エンティティからデータを取得できます。
//disply the result of our 'find' method
String documentName = dao.findDocumentNameByDocumentName("TPSReport");
System.out.println(documentName);
DocuSign データ の書き方
以前定義した方法を使用すれば、DocuSign にデータを書き込むことも簡単になります。
//add a new entry to the Documents entity
dao.insert(newDocumentName, newDocumentName);
JDBI ライブラリはJDBC 接続を処理できるため、CData JDBC Driver for DocuSign と統合することで、SQL Object API for DocuSign を簡単に作成できます。今すぐ無料トライアルをダウンロードし、Java アプリケーションでリアルタイムDocuSign を操作しましょう。
関連コンテンツ
