JDBI からSage X3 Cloud データのデータアクセスオブジェクトを作成
JDBI は、Fluent スタイルとSQL オブジェクトスタイルという2つの異なるスタイルAPI を公開する、Java 用のSQL コンビニエンスライブラリです。CData JDBC Driver for SageX3Cloud は、Java アプリケーションとリアルタイムSage X3 Cloud のデータ のデータ連携を実現します。これらの技術を組み合わせることによって、Sage X3 Cloud のデータ へのシンプルなコードアクセスが可能になります。ここでは、基本的なDAO(Data Access Object )とそれに付随するSage X3 Cloud のデータ の読み書きのためのコードの作成について説明します。
Sage X3 Cloud BPCUSTOMER Entity のDAO を作成
以下のインターフェースは、実装されるSQL ステートメントごとに単一のメソッドを作成するためのSQL オブジェクトの正しい動作を宣言します。
public interface MyBPCUSTOMERDAO {
//request specific data from Sage X3 Cloud (String type is used for simplicity)
@SqlQuery("SELECT BPCNAM FROM BPCUSTOMER WHERE BPCNUM = :bPCNUM")
String findBPCNAMByBPCNUM(@Bind("bPCNUM") String bPCNUM);
/*
* close with no args is used to close the connection
*/
void close();
}
Sage X3 Cloud への接続を開く
必要な接続プロパティを収集し、Sage X3 Cloud に接続するための適切なJDBC URL を作成します。
Sage X3 Cloud では OAuth 2.0 の Client Credentials フローを使用し、API へのアクセスには X-API-Key も必要です。AuthScheme を OAuth に設定し、以下の接続プロパティを指定します。
- URL:Sage X3 Cloud インスタンスのベース URL。
- OAuthAccessTokenUrl:OAuth トークンエンドポイント(例:https://your-auth-domain/oauth/token)。
- OAuthClientId:OAuth アプリケーションのクライアント ID。
- OAuthClientSecret:OAuth アプリケーションのクライアントシークレット。
- Audience:トークンリクエストで使用する API の Audience 値。
- XAPIKey:Sage X3 Cloud の管理者から提供された X-API-Key。
- Folder:Sage X3 のフォルダ名(例:SEED)。このフォルダがデフォルトのスキーマとして使用されます。
- Folders(オプション):Sage X3 フォルダのカンマ区切りリスト(例:SEED,PERF)。各フォルダが個別のスキーマとして公開されるため、Schema.Table 構文でフォルダをまたいだクエリを実行できます。
ドライバーは Client Credentials フローでアクセストークンを取得し、すべての API リクエストで X-API-Key とあわせて送信します。InitiateOAuth を GETANDREFRESH(デフォルト)に設定しておけば、トークンの取得と更新は自動で行われます。
ビルトイン接続文字列デザイナー
JDBC URL の構成については、Sage X3 Cloud JDBC Driver に組み込まれている接続文字列デザイナーを使用してください。JAR ファイルのダブルクリック、またはコマンドラインからJAR ファイルを実行します。
java -jar cdata.jdbc.sagex3cloud.jar
接続プロパティを入力し、接続文字列をクリップボードにコピーします。
Sage X3 Cloud の接続文字列は、通常次のようになります。
jdbc:sagex3cloud:AuthScheme=OAuth;URL=https://x3server/;OAuthAccessTokenUrl=https://auth-domain/oauth/token;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;Audience=https://api-audience;XAPIKey=your_api_key;Folder=SEED;
構成済みのJDBC URL を使用して、DAO インターフェースのインスタンスを取得します。以下に示す特定のメソッドはインスタンスにバインドされたハンドルを開くため、ハンドルとバインドされたJDBC 接続を開放するには、インスタンスを明示的に閉じる必要があります。
DBI dbi = new DBI("jdbc:sagex3cloud:AuthScheme=OAuth;URL=https://x3server/;OAuthAccessTokenUrl=https://auth-domain/oauth/token;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;Audience=https://api-audience;XAPIKey=your_api_key;Folder=SEED;");
MyBPCUSTOMERDAO dao = dbi.open(MyBPCUSTOMERDAO.class);
//do stuff with the DAO
dao.close();
Sage X3 Cloud データについて
Sage X3 Cloud への接続を開いた状態で以前定義したメソッドを呼び出すだけで、Sage X3 Cloud のBPCUSTOMER エンティティからデータを取得できます。
//disply the result of our 'find' method
String bPCNAM = dao.findBPCNAMByBPCNUM("MARTIN");
System.out.println(bPCNAM);
JDBI ライブラリはJDBC 接続を処理できるため、CData JDBC Driver for SageX3Cloud と統合することで、SQL Object API for SageX3Cloud を簡単に作成できます。今すぐ無料トライアルをダウンロードし、Java アプリケーションでリアルタイムSage X3 Cloud を操作しましょう。