アドインのアクティブ化

[アーティクル]
08/09/2011

探索メソッドを使用して、指定したホストビューに関するアドイントークンのコレクションを取得した場合、AddInToken オブジェクトによって表されるトークンを使用することによって、コレクションからアドインをアクティブ化できます。システムで使用できるアドインを探索する方法については、「アドイン探索」を参照してください。

AddInToken オブジェクトで Activate メソッドのオーバーロードを使用する場合、次のアクティブ化オプションを指定できます。

アドインが読み込まれるアプリケーションドメイン。
アドイン用に作成されるアプリケーションドメインに付与されるセキュリティ信頼レベルまたはアクセス許可セット。
アドインをアクティブ化する外部プロセス。これはアドイン開発の拡張オプションです。

Activate メソッドはアドインのホストビューを返します。その後、ホストアプリケーションはコントラクトに定義されているようにメソッドを呼び出すことができます。ホストアプリケーションは、AddInController クラスを使用してアドインをシャットダウンすることによって、アドインの有効期間を制御できます。さらに、アドインが参照されなくなった場合に、ガベージコレクターが回収できるようにします。

アクティベーション

通常、ホストアプリケーションは、ホストおよびアドインが別々のアプリケーションドメインで実行されるようにし、アドインごとに 1 つのアプリケーションドメインが用意されます。これにより、アドインはホストおよび他のアドインの両方から分離したコンテキストで実行できます。この分離によって、競合を避け、アドインのバージョン管理が可能になります。

アドインは独自のアプリケーションドメイン内にあるため、独自の環境でテストでき、さらにパイプラインのアドイン側もテストできます。アドインアダプター、コントラクト、アドインビューパイプラインセグメントはアドインと同じアプリケーションドメインに読み込まれます。アドインに必要な他のアセンブリもアドインのアプリケーションドメインに読み込まれます。

アドインをアクティブ化する際、ホストアプリケーションは一般に Activate メソッドのオーバーロードを使用します。このオーバーロードは、指定したセキュリティレベルを受け取り、そのアドイン用にアプリケーションドメインを自動的に作成します。セキュリティレベルには AddInSecurityLevel または PermissionSet を指定できます。 Activate メソッドは、アドインのアプリケーションドメインを作成するとき、addinassemblyname.config という構成ファイルが存在すれば、それをアプリケーションドメインの構成ファイルとして設定します。

さらに細かく制御したり、アドインをプールしたりする場合には、AddInToken.Activate メソッドのオーバーロードを使用して、読み込むアドインに既存のアプリケーションドメインを指定できます。既存のアプリケーションドメインを指定すると、リソース、セキュリティコンテキスト、カルチャ情報を他のアドインと簡単に共有できます。

アドインのアプリケーションドメインに適用されるセキュリティのコンテキストを考慮する必要があります。たとえば、ホストアプリケーションは完全信頼で実行するが、アドインはもっと少ないアクセス許可で実行することが必要な場合があります。 Activate メソッドのオーバーロードを使用して、AddInSecurityLevel 列挙体でセキュリティゾーンを指定できます。これらのセキュリティゾーンには、FullTrust、Host、Intranet、または Internet があります。セキュリティゾーンに適切なアクセス許可は、アプリケーションドメインで実行中のコードにも適用されます。これらのセキュリティゾーンで使用できるアクセス許可は、既存の .NET Framework セキュリティ設定に依存しています。

セキュリティゾーンのアクセス許可を使用しない場合は、Activate メソッドのオーバーロードを使用して、独自の PermissionSet オブジェクトを用意できます。

Activate メソッドのオーバーロードを使用して、アドイン用に外部プロセスを作成するか、アドインをホストするために作成された既存の外部プロセスにアドインをアタッチできます。これらのオーバーロードは AddInProcess クラスおよび AddInEnvironment クラスを使用します。外部プロセスのアドインをアクティブ化する方法の詳細については、「方法 : さまざまな分離レベルとセキュリティレベルのアドインをアクティブにする」を参照してください。

アドインの有効期間制御

AddInController クラスには、次のアドインタスクのためのメソッドがあります。

アドインのシャットダウン。
アドインのアプリケーションドメインの取得。
将来のアクティブ化に備えたアドインのトークンの取得。
外部プロセスのアクティブ化で使用するための AddInEnvironment オブジェクトの取得。

指定したアドインのコントローラーを取得するには、GetAddInController メソッドを使用します。

Shutdown メソッドは、アドインをシャットダウンするために必要な詳細情報を処理します。詳細情報には、アドインの読み込み場所、アプリケーションドメイン、さらに場合によってはアドインが実行されている外部プロセスに関する情報が含まれます。アプリケーションドメインが自動的に作成された場合、このメソッドはそのアプリケーションドメインをアンロードします。アドインが指定のアプリケーションドメインでアクティブ化された場合、リモートコントラクトオブジェクトでの有効期間サービスはタイムアウトとなり、アプリケーションドメインはロードされたままになります。コントラクトオブジェクトが破棄されると、アドインはガベージコレクションにより再利用できるようになります。

例

次の例では、自動的に作成されるアプリケーションドメイン内でセキュリティレベルを指定してアドインをアクティブ化しています。

'Ask the user which add-in they would like to use.
Dim selectedToken As AddInToken = ChooseAddIn(tokens)
'Activate the selected AddInToken in a new
'application domain with the Internet trust level.
Dim CalcAddIn As Calculator = selectedToken.Activate(Of Calculator)(AddInSecurityLevel.Internet)
'Run the add-in using a custom method.
RunCalculator(CalcAddIn)

//Ask the user which add-in they would like to use.
AddInToken selectedToken = ChooseAddIn(tokens);

//Activate the selected AddInToken in a new
//application domain with the Internet trust level.
Calculator CalcAddIn = selectedToken.Activate<Calculator>(AddInSecurityLevel.Internet);

//Run the add-in using a custom method.
RunCalculator(CalcAddIn);