ServiceDebugBehavior.IncludeExceptionDetailInFaults Propriété

Définition

Espace de noms:

System.ServiceModel.Description

Assembly:

System.ServiceModel.dll

Obtient ou définit une valeur qui spécifie si les informations sur les exceptions managées doivent être incluses dans le détail des erreurs SOAP retournées au client à des fins de débogage.

public:
 property bool IncludeExceptionDetailInFaults { bool get(); void set(bool value); };

public bool IncludeExceptionDetailInFaults { get; set; }

member this.IncludeExceptionDetailInFaults : bool with get, set

Public Property IncludeExceptionDetailInFaults As Boolean

Valeur de propriété

Boolean

truesi Windows Communication Foundation (WCF) retourne des informations d’exception managées dans les erreurs SOAP à des fins de débogage client ; sinon, false. La valeur par défaut est false.

Exemples

L'exemple de code suivant indique comment utiliser un fichier de configuration pour activer la fonctionnalité de page d'aide HTML et retourner au client des informations relatives aux exceptions dans une erreur SOAP à des fins de débogage. Ce fichier de configuration illustre les étapes de base suivantes permettant de prévoir la prise en charge des fonctionnalités ServiceDebugBehavior :

• Étant donné que le ServiceDebugBehavior type est une System.ServiceModel.Description.IServiceBehavior implémentation, l’élément <de service> qui représente le type de service a un identificateur de configuration de comportement de behaviorConfiguration="metadataAndDebug".

• Là encore, étant donné que le ServiceDebugBehavior type est une implémentation, System.ServiceModel.Description.IServiceBehavior un <élément de comportement> est ajouté à une <section serviceBehaviors> . Définissez l’attribut name de l’élément <de comportement> dont la valeur est l’identificateur de l’attribut behaviorConfiguration de l’élément <de service> . Dans ce cas, la valeur est metadataAndDebug.

• Ajoutez un <élément serviceDebug> avec les différents attributs définis sur la configuration souhaitée. Dans ce cas, les valeurs d'attribut httpHelpPageEnabled et includeExceptionDetailInFaults sont true.

<configuration>
  <system.serviceModel>
    <services>
      <!-- 
        Step 1. Add a behaviorConfiguration attribute
        in the <service> element.
      -->
      <service 
        name="Microsoft.WCF.Documentation.SampleService"
        behaviorConfiguration="metadataAndDebug">
        <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>
        <!-- 
          Step 2. Inside a <serviceBehaviors> section, add 
          a name attribute in the <behaviors> element that 
          matches the behaviorConfiguration attribute in the
          <service> element above.
        -->
        <behavior name="metadataAndDebug">
          <serviceMetadata 
            httpGetEnabled="true" 
            httpGetUrl=""
          />
          <!-- 
            Step 3. Add a <serviceDebug> element and 
            modify the various attributes that suit your 
            scenario.
          -->
          <serviceDebug 
            httpHelpPageEnabled="true" 
            includeExceptionDetailInFaults="true"
          />
        </behavior>
      </serviceBehaviors>
    </behaviors>
  </system.serviceModel>
</configuration>

Remarques

Définissez la IncludeExceptionDetailInFaults propriété pour true indiquer à WCF de retourner les informations d’exception managées au client dans les erreurs SOAP pour faciliter le débogage.

Attention

Le retour d'informations sur les exceptions managées aux clients peut constituer un problème de sécurité, car les détails d'exception exposent des informations relatives à l'implémentation de service interne que des clients non autorisés pourraient utiliser. De plus, bien que les propriétés ServiceDebugBehavior puissent également être définies par programme, il peut être facile d'oublier de désactiver IncludeExceptionDetailInFaults lors du déploiement.

Étant donné les problèmes de sécurité impliqués, il est vivement recommandé :

• d'utiliser un fichier de configuration d'application pour affecter à la propriété IncludeExceptionDetailInFaults la valeur true ;

• de ne procéder ainsi que dans des scénarios de débogage contrôlés.

Pour plus d’informations, consultez Spécification et gestion des erreurs dans les contrats et les services.