Entity Framework 6 からHCL Domino のデータに連携

Entity Framework はobject-relational mapping フレームワークで、データをオブジェクトとして扱うために使われます。Visual Studio のADO.NET Entity Data Model ウィザードを実行するとEntity Model を作成できますが、このモデルファーストアプローチでは、データソースに変更があった場合やエンティティ操作をより制御したい場合は不都合があります。この記事では、CData ADO.NET Provider を使いコードファーストアプローチでHCL Domino にアクセスします。

1. Visual Studio を起動し、新しいWindows Form アプリケーションを作成します。ここでは、.NET 4.5 のC# プロジェクトを使います。
2. Visual Studio の ［パッケージ マネージャー コンソール］から'Install-Package EntityFramework' コマンドを実行し、最新のEntity Framework をインストールします。
3. プロジェクトのApp.config ファイルを修正して、HCL Domino Entity Framework 6 アセンブリおよびコネクションストリングへの参照を追加します。

   Domino への接続

   それでは、Domino のデータに接続していきましょう。接続するには、以下のプロパティを設定してください。

   • URL：Domino データベースをホスティングしているサーバーのホスト名またはIP アドレス。Domino データベースをホスティングしているサーバーのポートを含めます。例：http://sampleserver:1234/
   • DatabaseScope：Domino Web UI でのスコープ名。CData 製品は、指定されたスコープに適合するスキーマのフォームとビューを公開します。Domino Admin UI で、サイドバーのScopes メニューを選択してください。このプロパティを既存のスコープ名に設定します

   Domino での認証

   続いて、認証方法を設定しましょう。Domino では、ログインクレデンシャル（OAuthPassword）またはMicrosoft Entra ID（AzureAD）のいずれかによる認証をサポートしています。

   ログインクレデンシャル

   ログインクレデンシャルで認証するには、以下のプロパティを設定してください：

   • AuthScheme：OAuthPassword
   • User：認証するDomino ユーザーのユーザー名
   • Password：認証するDomino ユーザーに関連付けられたパスワード

   ドライバーがログインクレデンシャルを使用して、自動的にOAuth トークン交換を実行します。

   Microsoft Entra ID（Azure AD）

   この認証方法は、Azure Active Directory をIdP として使用してJWT トークンを取得します。Azure Active Directory にカスタムのアプリケーションを作成し、それをIdP として設定する必要があります。詳しい手順については、ヘルプドキュメントの指示に従ってください。その後、以下のプロパティを設定します。

   • AuthScheme：AzureAD
   • InitiateOAuth：これをGETANDREFRESH に設定します。InitiateOAuth を使用すると、OAuth 交換の繰り返しやOAuthAccessToken の手動設定を避けることができます
   • OAuthClientId：カスタムAzure AD アプリケーションの作成時に取得したクライアントID
   • OAuthClientSecret：カスタムAzure AD アプリケーションの作成時に取得したクライアントシークレット
   • CallbackURL：カスタムAzure AD アプリケーションの登録時に指定されたリダイレクトURI。例えば、https://localhost:33333
   • AzureTenant：データにアクセスするために使用されるMicrosoft Online テナント。companyname.microsoft.com 形式の値またはテナントID のいずれかを指定してください

   テナントID は、Azure ポータルのAzure Active Directory > プロパティページに表示されているディレクトリID と同じです。

   
   <configuration>
      ... <connectionStrings>
       <add name="DominoContext" connectionString="Offline=False;URL=http://dominoserver:3002/;DatabaseScope=names;TableTypes=Tables;AuthScheme=OAuthPassword;User=MyUser;Password=MyPassword;" providerName="System.Data.CData.Domino" />
     </connectionStrings>
     <entityFramework>
       <providers>
          ... <provider invariantName="System.Data.CData.Domino" type="System.Data.CData.Domino.DominoProviderServices, System.Data.CData.Domino.Entities.EF6" />
       </providers>
     <entityFramework>
   </configuration>
   </code>
   

4. インストールディレクトリの［lib］ > 4.0 サブフォルダにあるSystem.Data.CData.Domino.Entities.EF6.dll を設定し、プロジェクトを作成してEntity Framework 6 を使うためのセットアップを完了します。
5. この時点でプロジェクトを作成し、すべてが正しく動作していることを確認してください。これで、Entity Framework を使ってコーディングを開始できます。
6. プロジェクトに新しい.cs ファイルを追加し、そこにクラスを追加します。これがデータベースのコンテキストとなり、DbContext クラスを拡張します。この例では、クラス名はDominoContext です。以下のサンプルコードは、OnModelCreating メソッドをオーバーライドして次の変更を加えます：
   • PluralizingTableNameConvention をModelBuilder Conventions から削除。
   • MigrationHistory テーブルへのリクエストを削除。

   
   using System.Data.Entity;
   using System.Data.Entity.Infrastructure;
   using System.Data.Entity.ModelConfiguration.Conventions;
   class DominoContext :DbContext {
   	public DominoContext() { }
   	protected override void OnModelCreating(DbModelBuilder modelBuilder) {  // To remove the requests to the Migration History table
   		Database.SetInitializer<DominoContext>(null); // To remove the plural names modelBuilder.Conventions.Remove<PluralizingTableNameConvention>();
   	}
   }
   

7. もう一つ.cs ファイルを作成し、ファイル名を呼び出そうとしているHCL Domino のエンティティ、例えばByName にします。このファイルでは、エンティティとエンティティ設定の両方を定義します。以下に例を示します。

   
   using System.Data.Entity.ModelConfiguration;
   using System.ComponentModel.DataAnnotations.Schema;
   public class ByName {
   	[DatabaseGeneratedAttribute(DatabaseGeneratedOption.Identity)]
   	public System.String Id { get; set; }
   	public System.String Name { get; set; }
   }
   public class ByNameMap :EntityTypeConfiguration<ByName> {
   	public ByNameMap() {
   		this.ToTable("ByName");
   		this.HasKey(ByName => ByName.Id);
   		this.Property(ByName => ByName.Name);
   	}
   }
   

8. エンティティの作成が済んだので、コンテキストクラスにエンティティを追加します：

   
   public DbSet<ByName> ByName { set; get; }
   

9. コンテキストとエンティティの作成が完了したら、別クラスでデータをクエリできます。例：

   DominoContext context = new DominoContext();
   context.Configuration.UseDatabaseNullSemantics = true;
   var query = from line in context.ByName select line;