IServiceBehavior Interface
TOC
Collapse the table of content
Expand the table of content

IServiceBehavior Interface

 

Provides a mechanism to modify or insert custom extensions across an entire service, including the ServiceHostBase.

Namespace:   System.ServiceModel.Description
Assembly:  System.ServiceModel (in System.ServiceModel.dll)

public interface class IServiceBehavior

NameDescription
System_CAPS_pubmethodAddBindingParameters(ServiceDescription^, ServiceHostBase^, Collection<ServiceEndpoint^>^, BindingParameterCollection^)

Provides the ability to pass custom data to binding elements to support the contract implementation.

System_CAPS_pubmethodApplyDispatchBehavior(ServiceDescription^, ServiceHostBase^)

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.

System_CAPS_pubmethodValidate(ServiceDescription^, ServiceHostBase^)

Provides the ability to inspect the service host and the service description to confirm that the service can run successfully.

Implement IServiceBehavior 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.

IServiceBehavior 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.

System_CAPS_noteNote

All of the IServiceBehavior 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 IServiceBehavior object must be added to the Behaviors property prior to the construction of the service runtime. There are three ways to do this:

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 IServiceBehavior 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.

No code example is currently available or this language may not be supported.

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.

.NET Framework
Available since 3.0
Return to top
Show:
© 2016 Microsoft