IErrorHandler Interface

Définition

Espace de noms:

System.ServiceModel.Dispatcher

Assembly:

System.ServiceModel.dll

Permet à un implémenteur de contrôler le message d'erreur retourné à l'appelant et exécute éventuellement un traitement d'erreur personnalisé comme l'enregistrement dans le journal.

public interface class IErrorHandler

public interface IErrorHandler

type IErrorHandler = interface

Public Interface IErrorHandler

Exemples

L'exemple de code suivant présente un service qui implémente IErrorHandler qui retourne uniquement FaultException<TDetail> de type GreetingFault lorsqu'une méthode de service lève une exception managée.

#region IErrorHandler Members
public bool HandleError(Exception error)
{
  Console.WriteLine("HandleError called.");
  // Returning true indicates you performed your behavior.
  return true;
}

// This is a trivial implementation that converts Exception to FaultException<GreetingFault>.
public void ProvideFault(
  Exception error,
  MessageVersion ver,
  ref Message msg
)
{
  Console.WriteLine("ProvideFault called. Converting Exception to GreetingFault....");
  FaultException<GreetingFault> fe
    = new FaultException<GreetingFault>(new GreetingFault(error.Message));
  MessageFault fault = fe.CreateMessageFault();
  msg = Message.CreateMessage(
    ver,
    fault,
    "http://microsoft.wcf.documentation/ISampleService/SampleMethodGreetingFaultFault"
  );
}
#endregion

#Region "IErrorHandler Members"
Public Function HandleError(ByVal [error] As Exception) As Boolean Implements IErrorHandler.HandleError
  Console.WriteLine("HandleError called.")
  ' Returning true indicates you performed your behavior.
  Return True
End Function

' This is a trivial implementation that converts Exception to FaultException<GreetingFault>.
Public Sub ProvideFault(ByVal [error] As Exception, ByVal ver As MessageVersion, ByRef msg As Message) Implements IErrorHandler.ProvideFault
  Console.WriteLine("ProvideFault called. Converting Exception to GreetingFault....")
  Dim fe As New FaultException(Of GreetingFault)(New GreetingFault([error].Message))
  Dim fault As MessageFault = fe.CreateMessageFault()
  msg = Message.CreateMessage(ver, fault, "http://microsoft.wcf.documentation/ISampleService/SampleMethodGreetingFaultFault")
End Sub
#End Region

L'exemple de code suivant indique comment utiliser un comportement de service pour ajouter l'implémentation IErrorHandler à la propriété ErrorHandlers.

// 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)
      {
        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

L'exemple de code suivant indique comment configurer le service pour charger le comportement de service à l'aide d'un fichier de configuration de l'application. Pour plus d'informations sur la façon d'exposer un comportement de service dans un fichier de configuration, consultez IServiceBehavior.

<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

Pour contrôler explicitement le comportement de l’application lorsqu’une exception est levée, implémentez l’interface IErrorHandler et ajoutez-la à la ChannelDispatcherpropriété .ErrorHandlers IErrorHandler vous permet de contrôler explicitement l'erreur SOAP générée, de décider de la retourner ou non au client et d'exécuter les tâches associées, comme l'enregistrement dans le journal. Les gestionnaires d'erreurs sont appelés dans l'ordre dans lequel ils sont ajoutés à la propriété ErrorHandlers.

Implémentez la méthode ProvideFault pour contrôler le message d'erreur retourné au client.

Implémentez la méthode HandleError pour contrôler les comportements lié à l'erreur, y compris l'enregistrement des erreurs, la garantie d'un échec rapide, l'arrêt de l'application, et ainsi de suite.

Notes

De nombreux éléments pouvant effectuer un appel à la méthode HandleError, aucune garantie sur le thread d'appel de la méthode ne peut être apportée. Ne vous attendez pas à ce que la méthode HandleError soit appelée sur le thread des opérations.

Toutes les implémentations ProvideFault sont appelées en premier, avant d'envoyer un message de réponse. Lorsque toutes les implémentations ProvideFault ont été appelées et retournent, et si fault n'a pas la valeur null, elle est renvoyée au client selon les termes du contrat d'opération. Si fault a la valeur null une fois que toutes les implémentations ont été appelées, le message de réponse est contrôlé par la valeur de propriété ServiceBehaviorAttribute.IncludeExceptionDetailInFaults.

Notes

Les exceptions peuvent se produire une fois que toutes les implémentations ProvideFault ont été appelées et qu'un message de réponse est transmis au canal. Si une exception de canal se produit (par exemple, une difficulté à sérialiser le message), IErrorHandler les objets sont avertis. Dans ce cas, vous devez toujours vous assurer que votre environnement de développement intercepte et affiche ces exceptions pour vous ou utilise le suivi pour découvrir le problème. Pour plus d’informations sur le suivi, consultez Utilisation du suivi pour résoudre les problèmes liés à votre application.

Une fois que le message de réponse a été envoyé, toutes les implémentations HandleError sont appelées dans le même ordre.

En général, une implémentation IErrorHandler est ajoutée à la propriété ErrorHandlers sur le service (et sur le client dans le cas de communication duplex).

Vous pouvez ajouter le IErrorHandler à l'exécution en implémentant un comportement (objet System.ServiceModel.Description.IServiceBehavior, System.ServiceModel.Description.IEndpointBehavior, System.ServiceModel.Description.IContractBehaviorou System.ServiceModel.Description.IOperationBehavior ) et utiliser le comportement par programme, à partir d'un fichier de configuration ou avec un attribut personnalisé pour attacher votre IErrorHandler.

Pour plus d’informations sur l’utilisation de comportements pour modifier le runtime, consultez Configuration et extension du runtime avec des comportements.

Méthodes

HandleError(Exception)	Active le traitement relatifs aux erreurs et retourne une valeur qui indique si le répartiteur abandonne la session et le contexte de l'instance dans certains cas.
ProvideFault(Exception, MessageVersion, Message)	Active la création d'un FaultException<TDetail> personnalisé retourné d'une exception au cours d'une méthode de service.