BaseAddressPrefixFilterElement Class

Reference

Definition

Namespace:: System.ServiceModel.Configuration

Assembly:: System.ServiceModel.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Represents a configuration element that specifies a pass through filter, which provides a mechanism to pick the appropriate IIS bindings when hosting a Windows Communication Foundation (WCF) application in IIS. This class cannot be inherited.

public ref class BaseAddressPrefixFilterElement sealed : System::Configuration::ConfigurationElement

public sealed class BaseAddressPrefixFilterElement : System.Configuration.ConfigurationElement

type BaseAddressPrefixFilterElement = class
    inherit ConfigurationElement

Public NotInheritable Class BaseAddressPrefixFilterElement
Inherits ConfigurationElement

Inheritance: Object

ConfigurationElement
BaseAddressPrefixFilterElement

Remarks

A prefix filter provider a mechanism for a service to bind to a specific URI. It enables you to host multiple applications with different base addresses for the same scheme on the same site.

IIS websites are containers for virtual applications which contain virtual directories. The application in a site can be accessed through one or more IIS binding. IIS bindings provide two pieces of information: binding protocol and binding information. Binding protocol (for example, HTTP) defines the scheme over which communication occurs, and binding information (for example, IPAddress, Port, Hostheader) contains data used to access the site.

IIS supports specifying multiple IIS bindings per site, which results in multiple base addresses per scheme. Since a WCF service hosted under a site allows binding to only one base address per scheme, you can use the prefix filter feature to pick the required base address of the hosted service. The incoming base addresses, supplied by IIS, are filtered based on the optional prefix list filter.

For example, your site can contain the following base addresses

http://testl.fabrikam.com/Service.svc  
http://test2.fabrikam.com/Service.svc

You can use the following configuration file to specify a prefix filter at the appdomain level.

<system.serviceModel>  
  <serviceHostingEnvironment>  
     <baseAddressPrefixFilters>  
        <add prefix="net.tcp://test1.fabrikam.com:8000"/>  
        <add prefix="http://test2.fabrikam.com:9000"/>  
    </baseAddressPrefixFilters>  
  </serviceHostingEnvironment>  
</system.serviceModel>

In this example, net.tcp://test1.fabrikam.com:8000 and http://test2.fabrikam.com:9000 are the only base addresses for their respective schemes which are allowed to be passed through.

By default, when prefix is not specified, all addresses are passed through. Specifying the prefix will result in only the matching base address for that scheme to be passed through.

Note

The filter does not support any wildcards. In addition, the baseAddresses supplied by IIS may have addresses bound to other schemes not present in the baseAddressPrefixFilters list. These addresses are not filtered out.

Constructors

BaseAddressPrefixFilterElement()	Initializes a new instance of the BaseAddressPrefixFilterElement class.
BaseAddressPrefixFilterElement(Uri)	Initializes a new instance of the BaseAddressPrefixFilterElement class with a specific URI.

Properties

CurrentConfiguration	Gets a reference to the top-level Configuration instance that represents the configuration hierarchy that the current ConfigurationElement instance belongs to. (Inherited from ConfigurationElement)
ElementInformation	Gets an ElementInformation object that contains the non-customizable information and functionality of the ConfigurationElement object. (Inherited from ConfigurationElement)
ElementProperty	Gets the ConfigurationElementProperty object that represents the ConfigurationElement object itself. (Inherited from ConfigurationElement)
EvaluationContext	Gets the ContextInformation object for the ConfigurationElement object. (Inherited from ConfigurationElement)
HasContext	Gets a value that indicates whether the CurrentConfiguration property is `null`. (Inherited from ConfigurationElement)
Item[ConfigurationProperty]	Gets or sets a property or attribute of this configuration element. (Inherited from ConfigurationElement)
Item[String]	Gets or sets a property, attribute, or child element of this configuration element. (Inherited from ConfigurationElement)
LockAllAttributesExcept	Gets the collection of locked attributes. (Inherited from ConfigurationElement)
LockAllElementsExcept	Gets the collection of locked elements. (Inherited from ConfigurationElement)
LockAttributes	Gets the collection of locked attributes. (Inherited from ConfigurationElement)
LockElements	Gets the collection of locked elements. (Inherited from ConfigurationElement)
LockItem	Gets or sets a value indicating whether the element is locked. (Inherited from ConfigurationElement)
Prefix	Gets or sets a prefix that is used to match a part of a base address.
Properties	Gets the collection of properties. (Inherited from ConfigurationElement)

Methods

DeserializeElement(XmlReader, Boolean)	Reads XML from the configuration file. (Inherited from ConfigurationElement)
Equals(Object)	Compares the current ConfigurationElement instance to the specified object. (Inherited from ConfigurationElement)
GetHashCode()	Gets a unique value representing the current ConfigurationElement instance. (Inherited from ConfigurationElement)
GetTransformedAssemblyString(String)	Returns the transformed version of the specified assembly name. (Inherited from ConfigurationElement)
GetTransformedTypeString(String)	Returns the transformed version of the specified type name. (Inherited from ConfigurationElement)
GetType()	Gets the Type of the current instance. (Inherited from Object)
Init()	Sets the ConfigurationElement object to its initial state. (Inherited from ConfigurationElement)
InitializeDefault()	Used to initialize a default set of values for the ConfigurationElement object. (Inherited from ConfigurationElement)
IsModified()	Indicates whether this configuration element has been modified since it was last saved or loaded, when implemented in a derived class. (Inherited from ConfigurationElement)
IsReadOnly()	Gets a value indicating whether the ConfigurationElement object is read-only. (Inherited from ConfigurationElement)
ListErrors(IList)	Adds the invalid-property errors in this ConfigurationElement object, and in all subelements, to the passed list. (Inherited from ConfigurationElement)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
OnDeserializeUnrecognizedAttribute(String, String)	Gets a value indicating whether an unknown attribute is encountered during deserialization. (Inherited from ConfigurationElement)
OnDeserializeUnrecognizedElement(String, XmlReader)	Gets a value indicating whether an unknown element is encountered during deserialization. (Inherited from ConfigurationElement)
OnRequiredPropertyNotFound(String)	Throws an exception when a required property is not found. (Inherited from ConfigurationElement)
PostDeserialize()	Called after deserialization. (Inherited from ConfigurationElement)
PreSerialize(XmlWriter)	Called before serialization. (Inherited from ConfigurationElement)
Reset(ConfigurationElement)	Resets the internal state of the ConfigurationElement object, including the locks and the properties collections. (Inherited from ConfigurationElement)
ResetModified()	Resets the value of the IsModified() method to `false` when implemented in a derived class. (Inherited from ConfigurationElement)
SerializeElement(XmlWriter, Boolean)	Writes the contents of this configuration element to the configuration file when implemented in a derived class. (Inherited from ConfigurationElement)
SerializeToXmlElement(XmlWriter, String)	Writes the outer tags of this configuration element to the configuration file when implemented in a derived class. (Inherited from ConfigurationElement)
SetPropertyValue(ConfigurationProperty, Object, Boolean)	Sets a property to the specified value. (Inherited from ConfigurationElement)
SetReadOnly()	Sets the IsReadOnly() property for the ConfigurationElement object and all subelements. (Inherited from ConfigurationElement)
ToString()	Returns a string that represents the current object. (Inherited from Object)
Unmerge(ConfigurationElement, ConfigurationElement, ConfigurationSaveMode)	Modifies the ConfigurationElement object to remove all values that should not be saved. (Inherited from ConfigurationElement)

Applies to