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

加藤龍彦
加藤龍彦
デジタルマーケティング
JDBI でSharePoint のデータ 用のSQL オブジェクトAPIを作成する方法を概説します。

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

SharePoint MyCustomList Entity のDAO を作成

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

public interface MyMyCustomListDAO {
  //insert new data into SharePoint
  @SqlUpdate("INSERT INTO MyCustomList (Location, Revenue) values (:location, :revenue)")
  void insert(@Bind("location") String location, @Bind("revenue") String revenue);

  //request specific data from SharePoint (String type is used for simplicity)
  @SqlQuery("SELECT Revenue FROM MyCustomList WHERE Location = :location")
  String findRevenueByLocation(@Bind("location") String location);

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

SharePoint への接続を開く

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

Microsoft SharePoint への接続

URL の設定:

Microsoft SharePoint では、2つの範囲でデータを操作できます。グローバルなMicrosoft SharePoint サイト全体を対象にするか、個々のサイトのみを対象にするかを選択できます。

グローバルなMicrosoft SharePoint サイトですべてのリストおよびドキュメントを操作したい場合は、URL 接続プロパティをサイトコレクションURL に設定しましょう。以下のような形式です。

https://teams.contoso.com

個々のサイトのリストおよびドキュメントのみを扱いたい場合は、URL 接続プロパティを個々のサイトURL に設定してください。以下のような形式です。

https://teams.contoso.com/TeamA

続いて、お使いの環境に適した認証プロパティを設定していきましょう。詳細な設定手順については、 href="/kb/help/" target="_blank">ヘルプドキュメントの「はじめに」をご参照ください。

Microsoft SharePoint Online

SharePointEdition を"SharePoint Online" に設定し、User およびPassword にはSharePoint へのログオンで使用するクレデンシャル(例:Microsoft Online Services アカウントのクレデンシャル)を設定します。

Microsoft SharePoint Online は様々なクラウドベースアーキテクチャをサポートしており、それぞれ異なる認証スキームが利用できます。

  • Microsoft Entra ID(Azure AD)
  • ADFS、Okta、OneLogin、またはPingFederate SSO ID プロバイダーを介したシングルサインオン(SSO)
  • Azure MSI
  • Azure パスワード
  • OAuthJWT
  • SharePointOAuth

Microsoft SharePoint オンプレミス

Microsoft SharePoint オンプレミスでは、多くのオンプレミス環境に対応した認証方式をサポートしています。

  • Windows(NTLM)
  • Kerberos
  • ADFS
  • 匿名アクセス

まずSharePointEdition を"SharePoint On-Premises" に設定しましょう。

Windows(NTLM)認証

これは最も一般的な認証方式です。そのため、CData 製品ではNTLM をデフォルトとして使用するよう事前設定されています。Windows のUser およびPassword を設定するだけで接続できます。

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

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

java -jar cdata.jdbc.sharepoint.jar

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

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

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

jdbc:sharepoint:User=myuseraccount;Password=mypassword;Auth Scheme=NTLM;URL=http://sharepointserver/mysite;SharePointEdition=SharePointOnPremise;

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

DBI dbi = new DBI("jdbc:sharepoint:User=myuseraccount;Password=mypassword;Auth Scheme=NTLM;URL=http://sharepointserver/mysite;SharePointEdition=SharePointOnPremise;");
MyMyCustomListDAO dao = dbi.open(MyMyCustomListDAO.class);

//do stuff with the DAO

dao.close();

SharePoint データについて

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

//disply the result of our 'find' method
String revenue = dao.findRevenueByLocation("Chapel Hill");
System.out.println(revenue);

SharePoint データの書き方

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

//add a new entry to the MyCustomList entity
dao.insert(newLocation, newRevenue);

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

はじめる準備はできましたか?

SharePoint Driver の無料トライアルをダウンロードしてお試しください:

 ダウンロード

詳細:

SharePoint Icon SharePoint JDBC Driver お問い合わせ

Java 開発者は、Web、デスクトップ、およびモバイルアプリケーションをSharePoint Server のリスト、連絡先、カレンダー、リンク、タスクなどのデータに簡単に接続できるようになります。