Provides a mechanism to modify or insert custom extensions across an entire service, including the ServiceHostBase.
Assembly: System.ServiceModel (in System.ServiceModel.dll)
Thetype exposes the following members.
|AddBindingParameters||Provides the ability to pass custom data to binding elements to support the contract implementation.|
|ApplyDispatchBehavior||Provides the ability to change run-time property values or insert custom extension objects such as error handlers, message or parameter interceptors, security extensions, and other custom extension objects.|
|Validate||Provides the ability to inspect the service host and the service description to confirm that the service can run successfully.|
Implement to modify, examine, or extend some aspect of service-wide execution at the application level:
Use the ApplyDispatchBehavior method to change run-time property values or insert custom extension objects such as error handlers, message or parameter interceptors, security extensions, and other custom extension objects.
Use the Validate method to examine the description before Windows Communication Foundation (WCF) constructs the executing service to confirm that it can execute properly.
Use the AddBindingParameters method to pass to a binding element the custom information for the service so that it can support the service correctly.
objects can make use of any of these methods, but often only one is important; in such cases the unused methods can return without a value.
All of the methods pass System.ServiceModel.Description.ServiceDescription and System.ServiceModel.ServiceHostBase objects as a parameters. The ServiceDescription parameter is for examination only; if you modify these objects the execution behavior is undefined.
To perform the customization task for which it is intended, the object must be added to the Behaviors property prior to the construction of the service runtime. There are three ways to do this:
Create a custom attribute that implements and use it to mark service classes that are to be modified. When a ServiceHost object is constructed, WCF uses reflection to discover the attributes on the service type. If any attributes implement , they are added to the behaviors collection on ServiceDescription.
Extend the System.ServiceModel.Configuration.BehaviorExtensionElement class to support the specification of the behavior in an application or machine configuration file. See the Example section for more information.
Examples of service behaviors in WCF include the ServiceBehaviorAttribute attribute, the System.ServiceModel.Description.ServiceThrottlingBehavior, the System.ServiceModel.Description.ServiceDebugBehavior and the System.ServiceModel.Description.ServiceMetadataBehavior behavior.
The following code example shows the use of a service behavior specified in a configuration file to insert a custom error handler in a service application. In this example, the error handler catches all exceptions and converts them into a custom GreetingFault SOAP fault that is then returned to the client.
The following implementation adds no binding parameter objects, adds the custom System.ServiceModel.Dispatcher.IErrorHandler object to each ChannelDispatcher.ErrorHandlers property, and validates that each operation of the service to which the service behavior is applied and has a System.ServiceModel.FaultContractAttribute of type GreetingFault.
In this example, the behavior class also implements System.ServiceModel.Configuration.BehaviorExtensionElement, which enables the service behavior to be inserted by using it in an application configuration file, as the following code example demonstrates.
<configuration> <system.serviceModel> <services> <service name="Microsoft.WCF.Documentation.SampleService" behaviorConfiguration="metaAndErrors"> <host> <baseAddresses> <add baseAddress="http://localhost:8080/SampleService"/> </baseAddresses> </host> <endpoint address="" binding="wsHttpBinding" contract="Microsoft.WCF.Documentation.ISampleService" /> <endpoint address="mex" binding="mexHttpBinding" contract="IMetadataExchange" /> </service> </services> <behaviors> <serviceBehaviors> <behavior name="metaAndErrors"> <serviceDebug includeExceptionDetailInFaults="true"/> <serviceMetadata httpGetEnabled="true"/> <enforceGreetingFaults /> </behavior> </serviceBehaviors> </behaviors> <extensions> <behaviorExtensions> <add name="enforceGreetingFaults" type="Microsoft.WCF.Documentation.EnforceGreetingFaultBehavior, HostApplication, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null" /> </behaviorExtensions> </extensions> </system.serviceModel> </configuration>