IContractBehavior Schnittstelle

  • Referenz

Definition

Namespace:
System.ServiceModel.Description
Assembly:
System.ServiceModel.Primitives.dll
Assembly:
System.ServiceModel.dll

Implementiert Methoden, die verwendet werden können, um das Laufzeitverhalten eines Vertrags in einem Dienst oder einer Clientanwendung zu erweitern.

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

Beispiele

Im folgenden Codebeispiel wird von einer benutzerdefinierten IInstanceProvider-Implementierung mit der Bezeichnung ObjectProviderBehavior ausgegangen, die ein Singletonverhalten ermöglicht; dabei wird stets die gleiche Dienstinstanz zurückgegeben und nicht wiederverwendet.

Zum Einfügen der Instanzanbieteranpassung wird in dem Beispiel die Implementierung eines benutzerdefinierten Attributs (SingletonBehaviorAttribute) veranschaulicht, das IContractBehavior implementiert, um den benutzerdefinierten Instanzanbieter des Diensts einzufügen. Es implementiert auch IContractBehaviorAttribute, wodurch dessen Verwendung an den ISampleService-Vertrag gebunden wird.

public class SingletonBehaviorAttribute : Attribute, IContractBehaviorAttribute, IContractBehavior
{

  #region IContractBehaviorAttribute Members

  public Type TargetContract
  {
    get { return typeof(ISampleService); }
  }

  #endregion

  #region IContractBehavior Members

  public void AddBindingParameters(ContractDescription description, ServiceEndpoint endpoint, System.ServiceModel.Channels.BindingParameterCollection parameters)
  {
    return;
  }

  public void ApplyClientBehavior(ContractDescription description, ServiceEndpoint endpoint, ClientRuntime clientRuntime)
  {
    return;
  }

  public void ApplyDispatchBehavior(ContractDescription description, ServiceEndpoint endpoint, DispatchRuntime dispatch)
  {
    dispatch.InstanceProvider = new ObjectProviderBehavior("Custom ObjectProviderBehavior constructor.");
  }

  public void Validate(ContractDescription description, ServiceEndpoint endpoint)
  {
    return;
  }

  #endregion
}

Public Class SingletonBehaviorAttribute
    Inherits Attribute
    Implements IContractBehaviorAttribute, IContractBehavior

  #Region "IContractBehaviorAttribute Members"

  Public ReadOnly Property TargetContract() As Type Implements IContractBehaviorAttribute.TargetContract
    Get
        Return GetType(ISampleService)
    End Get
  End Property

  #End Region

  #Region "IContractBehavior Members"

  Public Sub AddBindingParameters(ByVal description As ContractDescription, ByVal endpoint As ServiceEndpoint, ByVal parameters As System.ServiceModel.Channels.BindingParameterCollection) Implements IContractBehavior.AddBindingParameters
    Return
  End Sub

  Public Sub ApplyClientBehavior(ByVal description As ContractDescription, ByVal endpoint As ServiceEndpoint, ByVal clientRuntime As ClientRuntime) Implements IContractBehavior.ApplyClientBehavior
    Return
  End Sub

  Public Sub ApplyDispatchBehavior(ByVal description As ContractDescription, ByVal endpoint As ServiceEndpoint, ByVal dispatch As DispatchRuntime) Implements IContractBehavior.ApplyDispatchBehavior
    dispatch.InstanceProvider = New ObjectProviderBehavior("Custom ObjectProviderBehavior constructor.")
  End Sub

  Public Sub Validate(ByVal description As ContractDescription, ByVal endpoint As ServiceEndpoint) Implements IContractBehavior.Validate
    Return
  End Sub

  #End Region
End Class

Hinweise

Implementiert die IContractBehavior-Schnittstelle, um Aspekte der vertragsweiten Ausführung auf Anwendungsebene zu ändern, zu überprüfen oder zu erweitern. Im Gegensatz zu IServiceBehavior-Objekten und IEndpointBehavior-Objekten können IContractBehavior-Objekte nicht über eine Anwendungskonfigurationsdatei, sondern nur programmgesteuert oder unter Verwendung eines Attributs zur Laufzeit hinzugefügt werden.

Weitere Informationen zum Auswählen zwischen Dienst-, Endpunkt- und Vertragsverhalten finden Sie unter Konfigurieren und Erweitern der Runtime mit Verhalten.

  • Verwenden Sie die AddBindingParameters-Methode, um den Bindungselementen benutzerdefinierte Daten zur Unterstützung des Verhaltens bereitzustellen.

  • Verwenden Sie die ApplyClientBehavior-Methode, um einen Vertrag in einer Clientanwendung zu ändern oder zu überprüfen oder Erweiterungen hinzuzufügen.

  • Verwenden Sie die ApplyDispatchBehavior-Methode, um einen Vertrag in einer Dienstanwendung zu ändern oder zu überprüfen oder Erweiterungen hinzuzufügen.

  • Verwenden Sie die Validate-Methode, um sicherzustellen, dass ein Vertrag ein bestimmtes Feature unterstützt.

IContractBehavior-Objekte können jede dieser Methoden nutzen, jedoch ist häufig nur eine Methode von Bedeutung; in einem solchen Fall können die nicht verwendeten Methoden ohne Wert zurückkehren.

Hinweis

Alle IContractBehavior-Methoden übergeben System.ServiceModel.Description.ContractDescription und System.ServiceModel.Description.ServiceEndpoint als Parameter. Diese Parameter sind zur Überprüfung vorgesehen; wenn Sie die Objekte ändern, ist das Ausführungsverhalten nicht definiert.

IContractBehavior Typen können entweder für den Dienst oder den Client oder beides verwendet werden. Um eine Anpassungsaufgabe im Dienst auszuführen, muss das IContractBehavior-Objekt der Behaviors-Eigenschaft vor der Erstellung der Dienstlaufzeit hinzugefügt werden, was erfolgt, wenn die ICommunicationObject.Open-Methode für das System.ServiceModel.ServiceHost -Objekt aufgerufen wird. Es gibt hierbei zwei Möglichkeiten.

Die erste Methode besteht darin, das benutzerdefinierte Vertragsverhalten der Behaviors -Eigenschaft programmgesteuert hinzuzufügen, bevor die ICommunicationObject.Open-Methode für das System.ServiceModel.ServiceHost-Objekt aufgerufen wird. In diesem Fall wird das Verhalten auf alle Meldungen angewendet, die an einem beliebigen Endpunkt durch den betreffenden Vertrag fließen.

Hinweis

Das Verhalten wird auf alle Verträge des gleichen Typs angewendet. Beispiel: Wenn Sie denselben Vertragstyp mehr als einem Endpunkt programmgesteuert hinzufügen, verändert das Verhalten alle Endpunkte, die sich auf dasselbe Vertragsmodell beziehen.

Die zweite Methode besteht darin, ein benutzerdefiniertes Attribut zu erstellen, das IContractBehavior implementiert, und es anzuwenden auf:

  • Eine Vertragsschnittstelle. In diesem Fall wird das Verhalten an jedem beliebigen Endpunkt auf alle Verträge dieses Typs angewendet.

  • Eine Dienstklasse. In diesem Fall wird das Verhalten, unabhängig vom Vertrag, auf alle Endpunkte angewendet.

  • Eine Rückrufklasse. In diesem Fall wird das Verhalten auf den Endpunkt des Duplexclients angewendet.

Das Verhalten des zweiten Ansatzes ändert sich leicht, wenn das benutzerdefinierte Attribut auch System.ServiceModel.Description.IContractBehaviorAttribute implementiert. In diesem Fall sieht das Verhalten wie folgt aus:

Um die Anpassungsaufgabe an dem Client, für den sie bestimmt ist, auszuführen, muss das IContractBehavior-Objekt der Behaviors-Eigenschaft vor der Erstellung der Clientlaufzeit hinzugefügt werden, was erfolgt, wenn ChannelFactory<TChannel>.CreateChannel aufgerufen wird. Hierfür gibt es zwei Möglichkeiten:

Weitere Informationen zum programmgesteuerten Hinzufügen IContractBehavior von Typen zu der Client- oder Dienstanwendung finden Sie unter Konfigurieren und Erweitern der Runtime mit Verhalten.

Methoden

AddBindingParameters(ContractDescription, ServiceEndpoint, BindingParameterCollection)

Konfiguriert alle Bindungselemente zur Unterstützung des Vertragsverhaltens.
ApplyClientBehavior(ContractDescription, ServiceEndpoint, ClientRuntime)

Implementiert eine Änderung oder eine Erweiterung des Clients in einem gesamten Vertrag.
ApplyDispatchBehavior(ContractDescription, ServiceEndpoint, DispatchRuntime)

Implementiert eine Änderung oder eine Erweiterung des Clients in einem gesamten Vertrag.
Validate(ContractDescription, ServiceEndpoint)

Implementieren Sie, um zu bestätigen, dass der Vertrag und der Endpunkt das Vertragsverhalten unterstützen können.

Gilt für