IServiceBehavior Interface

Référence

Définition

Espace de noms:: System.ServiceModel.Description

Assembly:: System.ServiceModel.dll

Important

Certaines informations portent sur la préversion du produit qui est susceptible d’être en grande partie modifiée avant sa publication. Microsoft exclut toute garantie, expresse ou implicite, concernant les informations fournies ici.

Fournit un mécanisme permettant de modifier ou d'insérer des extensions personnalisées sur l'intégralité d'un service, y compris ServiceHostBase.

public interface class IServiceBehavior

public interface IServiceBehavior

type IServiceBehavior = interface

Public Interface IServiceBehavior

Dérivé: System.ServiceModel.Activation.AspNetCompatibilityRequirementsAttribute

System.ServiceModel.Activities.Description.BufferedReceiveServiceBehavior

System.ServiceModel.Activities.Description.EtwTrackingBehavior

System.ServiceModel.Activities.Description.SqlWorkflowInstanceStoreBehavior

System.ServiceModel.Activities.Description.WorkflowIdleBehavior

Plus…

Exemples

L'exemple de code suivant montre l'utilisation d'un comportement de service spécifié dans un fichier de configuration pour insérer un gestionnaire d'erreurs personnalisé dans une application de service. Dans cet exemple, le gestionnaire d'erreurs intercepte toutes les exceptions et les convertit en une erreur GreetingFault SOAP personnalisée qui est ensuite retournée au client.

L'implémentation IServiceBehavior suivante n'ajoute pas d'objet de paramètre de liaison, ajoute l'objet personnalisé System.ServiceModel.Dispatcher.IErrorHandler à chaque propriété ChannelDispatcher.ErrorHandlers, confirme que chaque opération du service auquel s'applique le comportement de service, et dispose d'un System.ServiceModel.FaultContractAttribute de 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

Dans cet exemple, la classe de comportement implémente également l'System.ServiceModel.Configuration.BehaviorExtensionElement, qui permet au comportement de service d'être inséré en l'utilisant dans un fichier de configuration de l'application comme le montre l'exemple de code suivant.

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

Remarques

Implémentez IServiceBehavior pour modifier, examiner ou étendre certains aspects de l'exécution à l'échelle du service au niveau de l'application :

Utilisez la méthode ApplyDispatchBehavior pour modifier des valeurs de propriété d’exécution ou insérer des objets d’extensions personnalisées tels que les gestionnaires d’erreurs, les intercepteurs de messages ou de paramètres, les extensions de sécurité et autres objets d’extensions personnalisées.
Utilisez la Validate méthode pour examiner la description avant de construire Windows Communication Foundation (WCF) construit le service en cours d’exécution pour confirmer qu’il peut s’exécuter correctement.
Utilisez la méthode AddBindingParameters pour passer à un élément de liaison les informations personnalisées pour le service afin qu'il puisse correctement prendre en charge le service.

Les objets IServiceBehavior peuvent utiliser chacune de ces méthodes mais souvent, seule l'une d'elles est importante. Dans ce cas, les méthodes inutilisées peuvent ne retourner aucune valeur.

Notes

Toutes les méthodes IServiceBehavior passent les objets System.ServiceModel.Description.ServiceDescription et System.ServiceModel.ServiceHostBase comme paramètres. Le paramètre ServiceDescription est présenté à titre d'examen uniquement ; si vous modifiez ces objets, le comportement d'exécution n'est pas défini.

Pour effectuer la tâche de personnalisation à laquelle ils se destine, l'objet IServiceBehavior doit être ajouté à la propriété Behaviors avant la construction de l'exécution de service. Pour ce faire, deux possibilités s'offrent à vous :

Par programme, ajoutez le comportement de service personnalisé à la propriété Behaviors avant le point où la méthode ICommunicationObject.Open est appelée sur l'objet System.ServiceModel.ServiceHost.
Créez un attribut personnalisé qui implémente le IServiceBehavior et l'utilise pour marquer des classes de service qui doivent être modifiées. Lorsqu’un ServiceHost objet est construit, WCF utilise la réflexion pour découvrir les attributs sur le type de service. Si des attributs implémentent IServiceBehavior, ils sont ajoutés à la collection de comportements sur ServiceDescription.
Étendez la classe System.ServiceModel.Configuration.BehaviorExtensionElement pour prendre en charge la spécification du comportement dans une application ou un fichier de configuration d'ordinateur. Pour plus d'informations, consultez la section Exemple.

Les exemples de comportements de service dans WCF incluent l’attribut, le ServiceBehaviorAttribute System.ServiceModel.Description.ServiceThrottlingBehavior, le System.ServiceModel.Description.ServiceDebugBehavior et le System.ServiceModel.Description.ServiceMetadataBehavior comportement.

Méthodes

AddBindingParameters(ServiceDescription, ServiceHostBase, Collection<ServiceEndpoint>, BindingParameterCollection)	Fournit la possibilité de passer des données personnalisées à des éléments de liaison pour prendre en charge l’implémentation de contrat.
ApplyDispatchBehavior(ServiceDescription, ServiceHostBase)	Fournit la possibilité de modifier des valeurs de propriété d'exécution ou insérer des objets d'extensions personnalisées tels que les gestionnaires d'erreurs, les intercepteurs de messages ou de paramètres, les extensions de sécurité et autres objets d'extensions personnalisées.
Validate(ServiceDescription, ServiceHostBase)	Fournit la possibilité d'inspecter l'hôte de service et la description de service pour confirmer que le service peut correctement s'exécuter.

S’applique à

Partager via