add Element for httpModules (ASP.NET Settings Schema)

  • Article

Adds an httpModules element to an application.

<configuration> Element
  system.web Element (ASP.NET Settings Schema)
    httpModules Element (ASP.NET Settings Schema)
      add Element for httpModules (ASP.NET Settings Schema)

<add name="ModuleName"
   type=".NET Class, Assembly [,Version=version number]
      [,Culture=culture] [,PublicKeyToken=token]"/>

Attributes and Elements

The following sections describe attributes, child elements, and parent elements.

Attributes

Attribute

Description

name

Required attribute.

Provides a friendly name for the module, which lets you associate an event handler for module events within the global.asax file.

type

Required attribute.

Specifies a comma-separated class/assembly combination consisting of version, culture, and public key tokens. ASP.NET searches for the assembly DLL first in the private \bin directory for the appliction, and then in the system assembly cache.

Child Elements

None.

Parent Elements

Element

Description

configuration

Specifies the root element in every configuration file that is used by the common language runtime and the .NET Framework applications.

system.web

Specifies the root element for the ASP.NET configuration section.

httpModules

Configures the HTTP modules that are within an application.

Remarks

The add directives are processed in top-down, sequential order. If two or more add subtags specify the same verb/path combination, the final add overrides all others.

Default Configuration

The following default add element is configured in the Machine.config file in the .NET Framework version 1.1.

<add name="OutputCache" type="System.Web.Caching.OutputCacheModule"/>
<add name="Session" type="System.Web.SessionState.SessionStateModule"/>
<add name="WindowsAuthentication" type="System.Web.Security.WindowsAuthenticationModule"/>
<add name="FormsAuthentication" type="System.Web.Security.FormsAuthenticationModule"/>
<add name="PassportAuthentication" type="System.Web.Security.PassportAuthenticationModule"/>
<add name="UrlAuthorization" type="System.Web.Security.UrlAuthorizationModule"/>
<add name="FileAuthorization" type="System.Web.Security.FileAuthorizationModule"/>
<add name="ErrorHandlerModule" type="System.Web.Mobile.ErrorHandlerModule, System.Web.Mobile, 
     Version=1.0.5000.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a"/>

The following default add element is configured in the Machine.config file in the .NET Framework version 1.0.

<add name="OutputCache" type="System.Web.Caching.OutputCacheModule" />
<add name="Session" type="System.Web.SessionState.SessionStateModule" />
<add name="WindowsAuthentication" type="System.Web.Security.WindowsAuthenticationModule" />
<add name="FormsAuthentication" type="System.Web.Security.FormsAuthenticationModule" />
<add name="PassportAuthentication" type="System.Web.Security.PassportAuthenticationModule" />
<add name="UrlAuthorization" type="System.Web.Security.UrlAuthorizationModule" />
<add name="FileAuthorization" type="System.Web.Security.FileAuthorizationModule" />

The following default add element is configured in the root Web.config file in the .NET Framework version 2.0.

<add name="OutputCache" type="System.Web.Caching.OutputCacheModule" />
<add name="Session" type="System.Web.SessionState.SessionStateModule" />
<add name="WindowsAuthentication" type="System.Web.Security.WindowsAuthenticationModule" />
<add name="FormsAuthentication" type="System.Web.Security.FormsAuthenticationModule" />
<add name="PassportAuthentication" type="System.Web.Security.PassportAuthenticationModule" />
<add name="RoleManager" type="System.Web.Security.RoleManagerModule" />
<add name="UrlAuthorization" type="System.Web.Security.UrlAuthorizationModule" />
<add name="FileAuthorization" type="System.Web.Security.FileAuthorizationModule" />
<add name="AnonymousIdentification" type="System.Web.Security.AnonymousIdentificationModule" />
<add name="Profile" type="System.Web.Profile.ProfileModule" />

Example

The following code example demonstrates how to add an httpModules element to an application.

<configuration>
   <system.web>
      <httpModules>
         <add name="OutputCache"
              type="System.Web.Caching.OutputCacheModule, System.Web,
                    Version=1.0.2800.0, Culture=neutral,
                    PublicKeyToken=b03f5f7f11d50a3a"/>
      </httpModules>
   <system.web>
</configuration>

Element Information

Configuration section handler

System.Web.Configuration.HttpModulesSection

Configuration member

SystemWebSectionGroup.HttpModules

Configurable locations

Machine.config

Root-level Web.config

Application-level Web.config

Virtual or physical directory–level Web.config

Requirements

Microsoft Internet Information Services (IIS) version 5.0, 5.1, or 6.0

The .NET Framework version 1.0, 1.1, or 2.0

Microsoft Visual Studio 2003 or Visual Studio 2005

See Also

Tasks

How to: Lock ASP.NET Configuration Settings

Reference

httpModules Element (ASP.NET Settings Schema)

system.web Element (ASP.NET Settings Schema)

<configuration> Element

clear Element for httpModules (ASP.NET Settings Schema)

remove Element for httpModules (ASP.NET Settings Schema)

System.Configuration

System.Web.Configuration

Concepts

ASP.NET Configuration Overview

ASP.NET Web Server Controls and Browser Capabilities

Securing ASP.NET Configuration

ASP.NET Configuration Scenarios

Other Resources

ASP.NET Configuration Files

ASP.NET Configuration Settings

General Configuration Settings (ASP.NET)

ASP.NET Configuration API