ISAPI フィルター <isapiFilters>

[アーティクル]
03/03/2010

概要
互換性
セットアップ
方法
構成
サンプルコード

※本ページに挿入されている画像をクリックすると、画像全体が別ウィンドウで表示されます。

概要

<isapiFilters> 要素を使用すると、インターネットインフォメーションサービス (IIS) 7.0 サーバー上で ISAPI フィルターを管理できます。Web サーバーの機能を拡張する場合に ISAPI フィルターを追加できます。たとえば、HTTP 要求についての情報をキャプチャし、その情報をデータベースに保存する ISAPI フィルターなどがあります。

注 : IIS 7.0 では ISAPI フィルターをサポートしていますが、ISAPI フィルターを使用する代わりにモジュールを使用して Web サーバー機能を拡張することをお勧めします。

<isapiFilters> 要素には 1 つまたは複数の <filter> 要素が格納されていますが、これらの各要素では、サーバーまたは Web サイトに対して有効化された ISAPI フィルターが定義されます。また、<remove> 要素が格納されており、これを使用して構成階層構造のより上位から継承した特定の ISAPI フィルターを削除できます。さらに、<isapiFilters> 要素には、<clear> 要素が格納されており、これにより、構成階層構造のより上位から継承したすべての ISAPI フィルターを削除できます。

互換性

	IIS 7.0	IIS 6.0
注意	`<isapiFilters>` は IIS 7.0 で新たに導入された要素です。	`<isapiFilters>` 要素は、IIS 6.0 のメタベースプロパティ FilterEnableCache および FilterPath に代わるものです。

セットアップ

<isapiFilters> 要素を使用するには、IIS 7.0 サーバー上に ISAPI フィルターモジュールをインストールする必要があります。それには、次の手順を実行します。

Windows Server 2008

タスクバーで [スタート] ボタンをクリックし、[管理ツール] をポイントして [サーバーマネージャー] をクリックします。
[サーバーマネージャー] ウィンドウのツリー表示で、[役割] を展開して [Web サーバー (IIS)] をクリックします。
[Web サーバー (IIS)] ウィンドウで、[役割サービス] セクションまでスクロールして [役割サービスの追加] をクリックします。
役割サービスの追加ウィザードの [役割サービスの選択] ページで、[ISAPI フィルター] を選択して、[次へ] をクリックします。
[インストールオプションの確認] ページで [インストール] をクリックします。
[結果] ページで [閉じる] をクリックします。

Windows Vista

タスクバーで [スタート] ボタンをクリックし、[コントロールパネル] をクリックします。
コントロールパネルで、[プログラムと機能]、[Windows の機能の有効化または無効化] の順にクリックします。
[Windows の機能] ダイアログボックスで、[Internet Information Services]、[World Wide Web サービス]、[アプリケーション開発機能] の順に展開します。
[ISAPI フィルター] を選択して、[OK] をクリックします。

方法

ISAPI フィルターを追加する方法

タスクバーで [スタート] ボタンをクリックし、[管理ツール] をポイントして [インターネットインフォメーションサービス (IIS) マネージャー] をクリックします。
[接続] ウィンドウで、ページ出力のキャッシュを構成する接続、サイト、アプリケーション、またはディレクトリに移動します。
[ホーム] ウィンドウで [ISAPI フィルター] をダブルクリックします。
[操作] ウィンドウで [追加] をクリックします。
[ISAPI フィルターの追加] ダイアログボックスの [フィルター名] テキストボックスで、わかりやすい ISAPI フィルターの名前を入力します。
[実行可能ファイル] ボックスで、ISAPI フィルターファイルの場所のファイルシステムパスを入力するか、または、[...] ボタンをクリックして ISAPI フィルターファイルのあるフォルダーに移動し、[OK] をクリックします。

構成

ISAPI フィルターは、サーバーレベルとサイトレベルで追加できます。ISAPI フィルターをサーバーレベルで追加すると、フィルターにより、サーバーに対して行われたすべての要求が先に取得されます。ISAPI フィルターを特定のサイトに追加すると、フィルターにより、そのサイトに対して行われたすべての要求が先に取得されます。

サーバーレベルでの <isapiFilters> 要素の構成は ApplicationHost.config ファイルで、サイトレベルでの構成は該当する Web.config ファイルで、それぞれ設定できます。

属性

なし。

子要素

要素	説明
`clear`	オプションの要素。 ISAPI フィルターコレクションから ISAPI フィルターに対するすべての参照を削除します。
`filter`	オプションの要素。 ISAPI フィルターコレクションに ISAPI フィルターを追加します。
`remove`	オプションの要素。 ISAPI フィルターコレクションから 1 つの ISAPI フィルターに対する参照を削除します。

構成サンプル

次の構成例を Web.config ファイルに追加すると、SalesQueryIsapi という ISAPI フィルターが Web サイトまたはアプリケーションに追加されます。サンプルでは、name 属性と enabled 属性を使用して、ISAPI フィルターに名前を付け、有効にしています。また、enableCache 属性を使用して HTTP.sys キャッシュを無効にし、path 属性を使用して ISAPI DLL の場所を指定しています。

<configuration>

   <system.webServer>
      <isapiFilters>
         <filter 
            name="SalesFilter" 
            enabled="true" 
            enableCache="false" 
            path="C:\Inetpub\filters\SalesFilter.dll" />
      </isapiFilters>
   </system.webServer>
</configuration>

サンプルコード

次の例では、サーバー上で SalesQueryIsapi という ISAPI フィルターを構成します。各サンプルでは、name プロパティを使用して ISAPI フィルターに名前を指定し、enableCache プロパティで HTTP.sys キャッシュを無効にし、path プロパティで ISAPI DLL の場所を指定しています。

AppCmd.exe

appcmd.exe set config -section:system.webServer/isapiFilters /+"[name='SalesQueryIsapi',path='c:\Inetpub\www.contoso.com\filters\SalesQueryIsapi.dll',enabled='True',enableCache='True']" /commit:apphost

C#

using System;
using System.Text;
using Microsoft.Web.Administration;

internal static class Sample
{
   private static void Main()
   {
      using (ServerManager serverManager = new ServerManager())
      {
         Configuration config = serverManager.GetApplicationHostConfiguration();
         ConfigurationSection isapiFiltersSection = config.GetSection("system.webServer/isapiFilters");
         ConfigurationElementCollection isapiFiltersCollection = isapiFiltersSection.GetCollection();

         ConfigurationElement filterElement = isapiFiltersCollection.CreateElement("filter");
         filterElement["name"] = @"SalesQueryIsapi";
         filterElement["path"] = @"c:\Inetpub\www.contoso.com\filters\SalesQueryIsapi.dll";
         filterElement["enabled"] = true;
         filterElement["enableCache"] = true;
         isapiFiltersCollection.Add(filterElement);

         serverManager.CommitChanges();
      }
   }
}

VB.NET

Imports System
Imports System.Text
Imports Microsoft.Web.Administration

Module Sample
   Sub Main()
      Dim serverManager As ServerManager = New ServerManager
      Dim config As Configuration = serverManager.GetApplicationHostConfiguration
      Dim isapiFiltersSection As ConfigurationSection = config.GetSection("system.webServer/isapiFilters")
      Dim isapiFiltersCollection As ConfigurationElementCollection = isapiFiltersSection.GetCollection
      Dim filterElement As ConfigurationElement = isapiFiltersCollection.CreateElement("filter")
      filterElement("name") = "SalesQueryIsapi"
      filterElement("path") = "c:\Inetpub\www.contoso.com\filters\SalesQueryIsapi.dll"
      filterElement("enabled") = True
      filterElement("enableCache") = True
      isapiFiltersCollection.Add(filterElement)
      serverManager.CommitChanges()
   End Sub
End Module

JavaScript

var adminManager = new ActiveXObject('Microsoft.ApplicationHost.WritableAdminManager');
adminManager.CommitPath = "MACHINE/WEBROOT/APPHOST";
var isapiFiltersSection = adminManager.GetAdminSection("system.webServer/isapiFilters", "MACHINE/WEBROOT/APPHOST");
var isapiFiltersCollection = isapiFiltersSection.Collection;

var filterElement = isapiFiltersCollection.CreateNewElement("filter");
filterElement.Properties.Item("name").Value = "SalesQueryIsapi";
filterElement.Properties.Item("path").Value = "c:\\Inetpub\\www.contoso.com\\filters\\SalesQueryIsapi.dll";
filterElement.Properties.Item("enabled").Value = true;
filterElement.Properties.Item("enableCache").Value = true;
isapiFiltersCollection.AddElement(filterElement);

adminManager.CommitChanges();

VBScript

Set adminManager = createObject("Microsoft.ApplicationHost.WritableAdminManager")
adminManager.CommitPath = "MACHINE/WEBROOT/APPHOST"
Set isapiFiltersSection = adminManager.GetAdminSection("system.webServer/isapiFilters", "MACHINE/WEBROOT/APPHOST")
Set isapiFiltersCollection = isapiFiltersSection.Collection

Set filterElement = isapiFiltersCollection.CreateNewElement("filter")
filterElement.Properties.Item("name").Value = "SalesQueryIsapi"
filterElement.Properties.Item("path").Value = "c:\\Inetpub\\www.contoso.com\\filters\\SalesQueryIsapi.dll"
filterElement.Properties.Item("enabled").Value = True
filterElement.Properties.Item("enableCache").Value = True
isapiFiltersCollection.AddElement filterElement

adminManager.CommitChanges()