IServiceBehavior Schnittstelle

Definition

Stellt einen Mechanismus bereit, um benutzerdefinierte Erweiterungen für einen gesamten Dienst zu ändern oder einzufügen, einschließlich ServiceHostBase.Provides a mechanism to modify or insert custom extensions across an entire service, including the ServiceHostBase.

public interface class IServiceBehavior
public interface IServiceBehavior
type IServiceBehavior = interface
Public Interface IServiceBehavior
Abgeleitet

Beispiele

Im folgenden Codebeispiel wird veranschaulicht, wie ein in einer Anwendungskonfigurationsdatei angegebenes Dienstverhalten verwendet wird, um einen benutzerdefinierten Fehlerhandler in eine Dienstanwendung einzufügen.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 diesem Beispiel fängt der Fehlerhandler alle Ausnahmen ab und wandelt sie in einen benutzerdefinierten GreetingFault-SOAP-Fehler um, der dann an den Client zurückgegeben wird.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.

Mit der folgenden IServiceBehavior-Implementierung werden keine Bindungsparameterobjekte hinzugefügt, wird das benutzerdefinierte System.ServiceModel.Dispatcher.IErrorHandler-Objekte jeder ChannelDispatcher.ErrorHandlers-Eigenschaft hinzugefügt und überprüft, dass jeder Vorgang des Diensts, auf den das Dienstverhalten angewendet wird, über ein System.ServiceModel.FaultContractAttribute des Typs GreetingFault verfügt.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.

// This behavior modifies no binding parameters.
#region IServiceBehavior Members
public void AddBindingParameters(
  ServiceDescription description, 
  ServiceHostBase serviceHostBase, 
  System.Collections.ObjectModel.Collection<ServiceEndpoint> endpoints, 
  System.ServiceModel.Channels.BindingParameterCollection parameters
)
{
  return;
}

// This behavior is an IErrorHandler implementation and 
// must be applied to each ChannelDispatcher.
public void ApplyDispatchBehavior(ServiceDescription description, ServiceHostBase serviceHostBase)
{
  Console.WriteLine("The EnforceGreetingFaultBehavior has been applied.");
  foreach(ChannelDispatcher chanDisp in serviceHostBase.ChannelDispatchers)
  {
    chanDisp.ErrorHandlers.Add(this);      
  }
}

// This behavior requires that the contract have a SOAP fault with a detail type of GreetingFault.
public void Validate(ServiceDescription description, ServiceHostBase serviceHostBase)
{
  Console.WriteLine("Validate is called.");
  foreach (ServiceEndpoint se in description.Endpoints)
  {
    // Must not examine any metadata endpoint.
    if (se.Contract.Name.Equals("IMetadataExchange")
      && se.Contract.Namespace.Equals("http://schemas.microsoft.com/2006/04/mex"))
      continue;
    foreach (OperationDescription opDesc in se.Contract.Operations)
    {
      if (opDesc.Faults.Count == 0)
        throw new InvalidOperationException(String.Format(
          "EnforceGreetingFaultBehavior requires a "  
          + "FaultContractAttribute(typeof(GreetingFault)) in each operation contract.  "
          + "The \"{0}\" operation contains no FaultContractAttribute.",
          opDesc.Name)
        );
      bool gfExists = false;
      foreach (FaultDescription fault in opDesc.Faults)
      {
        if (fault.DetailType.Equals(typeof(GreetingFault)))
        {
          gfExists = true;
          continue;
        }
      }
      if (gfExists == false)
      {
        throw new InvalidOperationException(
"EnforceGreetingFaultBehavior requires a FaultContractAttribute(typeof(GreetingFault)) in an operation contract."
        );
      }
    }
  }
}
#endregion
' This behavior modifies no binding parameters.
#Region "IServiceBehavior Members"
Public Sub AddBindingParameters(ByVal description As ServiceDescription, ByVal serviceHostBase As ServiceHostBase, ByVal endpoints As System.Collections.ObjectModel.Collection(Of ServiceEndpoint), ByVal parameters As System.ServiceModel.Channels.BindingParameterCollection) Implements IServiceBehavior.AddBindingParameters
  Return
End Sub

' This behavior is an IErrorHandler implementation and 
' must be applied to each ChannelDispatcher.
Public Sub ApplyDispatchBehavior(ByVal description As ServiceDescription, ByVal serviceHostBase As ServiceHostBase) Implements IServiceBehavior.ApplyDispatchBehavior
  Console.WriteLine("The EnforceGreetingFaultBehavior has been applied.")
  For Each chanDisp As ChannelDispatcher In serviceHostBase.ChannelDispatchers
    chanDisp.ErrorHandlers.Add(Me)
  Next chanDisp
End Sub

' This behavior requires that the contract have a SOAP fault with a detail type of GreetingFault.
Public Sub Validate(ByVal description As ServiceDescription, ByVal serviceHostBase As ServiceHostBase) Implements IServiceBehavior.Validate
  Console.WriteLine("Validate is called.")
  For Each se As ServiceEndpoint In description.Endpoints
    ' Must not examine any metadata endpoint.
    If se.Contract.Name.Equals("IMetadataExchange") AndAlso se.Contract.Namespace.Equals("http://schemas.microsoft.com/2006/04/mex") Then
      Continue For
    End If
    For Each opDesc As OperationDescription In se.Contract.Operations
      If opDesc.Faults.Count = 0 Then
        Throw New InvalidOperationException(String.Format("EnforceGreetingFaultBehavior requires a " & "FaultContractAttribute(typeof(GreetingFault)) in each operation contract.  " & "The ""{0}"" operation contains no FaultContractAttribute.", opDesc.Name))
      End If
      Dim gfExists As Boolean = False
      For Each fault As FaultDescription In opDesc.Faults
        If fault.DetailType.Equals(GetType(GreetingFault)) Then
          gfExists = True
          Continue For
        End If
      Next fault
      If gfExists = False Then
        Throw New InvalidOperationException("EnforceGreetingFaultBehavior requires a FaultContractAttribute(typeof(GreetingFault)) in an operation contract.")
      End If
    Next opDesc
  Next se
End Sub
#End Region

In diesem Beispiel implementiert die Verhaltensklasse auch System.ServiceModel.Configuration.BehaviorExtensionElement, wodurch das Dienstverhalten mithilfe einer Anwendungskonfigurationsdatei eingefügt werden kann, wie folgendes Codebeispiel zeigt.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>

Hinweise

Implementiert IServiceBehavior, um Aspekte der dienstweiten Ausführung auf Anwendungsebene zu ändern, zu überprüfen oder zu erweitern:Implement IServiceBehavior to modify, examine, or extend some aspect of service-wide execution at the application level:

  • Verwenden Sie die ApplyDispatchBehavior-Methode zum Ändern von Eigenschaftenwerten zur Laufzeit oder zum Einfügen von benutzerdefinierten Erweiterungsobjekten, wie Fehlerhandler, Nachrichten- oder Parameterinterceptoren, Sicherheitserweiterungen und anderen benutzerdefinierten Erweiterungsobjekten.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.

  • Verwenden Sie Validate die-Methode, um die Beschreibung zu untersuchen, bevor Windows Communication Foundation (WCF) den ausführenden Dienst erstellt, um zu bestätigen, dass er ordnungsgemäß ausgeführtUse the Validate method to examine the description before Windows Communication Foundation (WCF) constructs the executing service to confirm that it can execute properly.

  • Verwenden Sie die AddBindingParameters-Methode, um benutzerdefinierte Informationen zum Dienst an ein Bindungselement zu übergeben, damit der Dienst korrekt unterstützt werden kann.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-Objekte können jede dieser Methoden nutzen, jedoch ist häufig nur eine Methode von Bedeutung; in einem solchen Fall geben die nicht verwendeten Methoden keinen Wert zurück.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.

Hinweis

Alle IServiceBehavior-Methoden übergeben System.ServiceModel.Description.ServiceDescription-Objekte und System.ServiceModel.ServiceHostBase-Objekte als Parameter.All of the IServiceBehavior methods pass System.ServiceModel.Description.ServiceDescription and System.ServiceModel.ServiceHostBase objects as a parameters. Der ServiceDescription-Parameter dient nur zur Prüfung; wenn Sie diese Objekte ändern, ist das Ausführungsverhalten nicht definiert.The ServiceDescription parameter is for examination only; if you modify these objects the execution behavior is undefined.

Um eine Anpassungsaufgabe auszuführen, muss das entsprechende IServiceBehavior-Objekt der Behaviors-Eigenschaft vor der Erstellung der Dienstlaufzeit hinzugefügt werden.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. Hierfür gibt es drei Möglichkeiten:There are three ways to do this:

Beispiele für Dienst Verhaltensweisen in WCF ServiceBehaviorAttribute sind das System.ServiceModel.Description.ServiceDebugBehavior - System.ServiceModel.Description.ServiceThrottlingBehaviorAttribut, das- System.ServiceModel.Description.ServiceMetadataBehavior Attribut, das-und das-Verhalten.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.

Methoden

AddBindingParameters(ServiceDescription, ServiceHostBase, Collection<ServiceEndpoint>, BindingParameterCollection)

Bietet die Möglichkeit, benutzerdefinierte Daten an Bindungselemente zu übergeben, um die Vertragsimplementierung zu unterstützen.Provides the ability to pass custom data to binding elements to support the contract implementation.

ApplyDispatchBehavior(ServiceDescription, ServiceHostBase)

Stellt die Funktion zum Ausführen von Eigenschaftswerten zur Laufzeit oder zum Einfügen von benutzerdefinierten Erweiterungsobjekten, wie Fehlerhandler, Nachrichten- oder Parameterinterceptoren, Sicherheitserweiterungen und anderen benutzerdefinierten Erweiterungsobjekten, bereit.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(ServiceDescription, ServiceHostBase)

Stellt die Funktion zur Verfügung, mit der der Diensthost und die Dienstbeschreibung geprüft werden können, um sicherzustellen, dass der Dienst erfolgreich ausgeführt wird.Provides the ability to inspect the service host and the service description to confirm that the service can run successfully.

Gilt für: