JDBI からNetSuite データのデータアクセスオブジェクトを作成

加藤龍彦
デジタルマーケティング

JDBI でNetSuite のデータ用のSQL オブジェクトAPIを作成する方法を概説します。

JDBI は、Fluent スタイルとSQL オブジェクトスタイルという2つの異なるスタイルAPI を公開する、Java 用のSQL コンビニエンスライブラリです。CData JDBC Driver for NetSuite は、Java アプリケーションとリアルタイムNetSuite のデータのデータ連携を実現します。これらの技術を組み合わせることによって、NetSuite のデータへのシンプルなコードアクセスが可能になります。ここでは、基本的なDAO（Data Access Object ）とそれに付随するNetSuite のデータの読み書きのためのコードの作成について説明します。

NetSuite SalesOrder Entity のDAO を作成

以下のインターフェースは、実装されるSQL ステートメントごとに単一のメソッドを作成するためのSQL オブジェクトの正しい動作を宣言します。

public interface MySalesOrderDAO {
  //insert new data into NetSuite
  @SqlUpdate("INSERT INTO SalesOrder (Class_Name, SalesOrderTotal) values (:class_Name, :salesOrderTotal)")
  void insert(@Bind("class_Name") String class_Name, @Bind("salesOrderTotal") String salesOrderTotal);

  //request specific data from NetSuite (String type is used for simplicity)
  @SqlQuery("SELECT SalesOrderTotal FROM SalesOrder WHERE Class_Name = :class_Name")
  String findSalesOrderTotalByClass_Name(@Bind("class_Name") String class_Name);

  /*
   * close with no args is used to close the connection
   */
  void close();
}

NetSuite への接続を開く

必要な接続プロパティを収集し、NetSuite に接続するための適切なJDBC URL を作成します。

NetSuiteへの接続

NetSuite では、2種類のAPI でデータにアクセスできます。どちらのAPI を使用するかは、Schema 接続プロパティで以下のいずれかを選択して指定してください。

SuiteTalk は、NetSuite との通信に使用されるSOAP ベースの従来から提供されているサービスです。幅広いエンティティをサポートし、INSERT / UPDATE / DELETE の操作も対応しています。ただし、SuiteQL API と比べるとデータの取得速度が劣ります。また、サーバーサイドでのJOIN に対応していないため、これらの処理はCData 製品がクライアントサイドで実行します。
SuiteQL は、より新しいAPI です。JOIN、GROUP BY、集計、カラムフィルタリングをサーバーサイドで処理できるため、SuiteTalk よりもはるかに高速にデータを取得できます。ただし、NetSuite データへのアクセスは読み取り専用となります。

データの取得のみが目的でしたらSuiteQL をお勧めします。データの取得と変更の両方が必要な場合は、SuiteTalk をお選びください。

NetSuite への認証

CData 製品では、以下の認証方式がご利用いただけます。

トークンベース認証（TBA）はOAuth1.0に似た仕組みです。2020.2以降のSuiteTalk とSuiteQL の両方で利用できます。
OAuth 2.0 認証（OAuth 2.0 認可コードグラントフロー）は、SuiteQL でのみご利用いただけます。
OAuth JWT 認証は、OAuth2.0 クライアント認証フローの一つで、クライアント認証情報を含むJWT を使用してNetSuite データへのアクセスを要求します。

トークンベース認証（OAuth1.0）

トークンベース認証（TBA）は、基本的にOAuth 1.0 の仕組みです。この認証方式はSuiteTalk とSuiteQL の両方でサポートされています。管理者権限をお持ちの方がNetSuite UI 内でOAuthClientId、OAuthClientSecret、OAuthAccessToken、OAuthAccessTokenSecret を直接作成することで設定できます。 NetSuite UI でのトークン作成手順については、ヘルプドキュメントの「はじめに」セクションをご参照ください。

アクセストークンを作成したら、以下の接続プロパティを設定して接続してみましょう。

AuthScheme = Token
AccountId = 接続先のアカウント
OAuthClientId = アプリケーション作成時に表示されるコンシューマーキー
OAuthClientSecret = アプリケーション作成時に表示されるコンシューマーシークレット
OAuthAccessToken = アクセストークン作成時のトークンID
OAuthAccessTokenSecret = アクセストークン作成時のトークンシークレット

その他の認証方法については、ヘルプドキュメントの「はじめに」をご確認ください。

ビルトイン接続文字列デザイナー

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

java -jar cdata.jdbc.netsuite.jar

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

Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)

NetSuite の接続文字列は、通常次のようになります。

jdbc:netsuite:AccountId=XABC123456;Schema=SuiteTalk;AuthScheme=Token;OAuthClientId=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;OAuthAccessToken=MyOAuthAccessToken;OAuthAccessTokenSecret=MyOAuthAccessTokenSecret;

構成済みのJDBC URL を使用して、DAO インターフェースのインスタンスを取得します。以下に示す特定のメソッドはインスタンスにバインドされたハンドルを開くため、ハンドルとバインドされたJDBC 接続を開放するには、インスタンスを明示的に閉じる必要があります。

DBI dbi = new DBI("jdbc:netsuite:AccountId=XABC123456;Schema=SuiteTalk;AuthScheme=Token;OAuthClientId=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;OAuthAccessToken=MyOAuthAccessToken;OAuthAccessTokenSecret=MyOAuthAccessTokenSecret;");
MySalesOrderDAO dao = dbi.open(MySalesOrderDAO.class);

//do stuff with the DAO

dao.close();

NetSuite データについて

NetSuite への接続を開いた状態で以前定義したメソッドを呼び出すだけで、NetSuite のSalesOrder エンティティからデータを取得できます。

//disply the result of our 'find' method
String salesOrderTotal = dao.findSalesOrderTotalByClass_Name("Furniture : Office");
System.out.println(salesOrderTotal);

NetSuite データの書き方

以前定義した方法を使用すれば、NetSuite にデータを書き込むことも簡単になります。

//add a new entry to the SalesOrder entity
dao.insert(newClass_Name, newSalesOrderTotal);

JDBI ライブラリはJDBC 接続を処理できるため、CData JDBC Driver for NetSuite と統合することで、SQL Object API for NetSuite を簡単に作成できます。今すぐ無料トライアルをダウンロードし、Java アプリケーションでリアルタイムNetSuite を操作しましょう。