ServiceDebugElement Klasse

Referenz

Definition

Namespace:: System.ServiceModel.Configuration

Assembly:: System.ServiceModel.dll

Wichtig

Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.

Stellt ein Konfigurationselement dar, das Debug- und Hilfeinformationsfunktionen für einen WCF-Dienst (Windows Communication Foundation) angibt. Diese Klasse kann nicht vererbt werden.

public ref class ServiceDebugElement sealed : System::ServiceModel::Configuration::BehaviorExtensionElement

public sealed class ServiceDebugElement : System.ServiceModel.Configuration.BehaviorExtensionElement

type ServiceDebugElement = class
    inherit BehaviorExtensionElement

Public NotInheritable Class ServiceDebugElement
Inherits BehaviorExtensionElement

Vererbung: Object

ConfigurationElement

ServiceModelExtensionElement

BehaviorExtensionElement
ServiceDebugElement

Vererbung: Object

ConfigurationElement

ServiceModelConfigurationElement

ServiceModelExtensionElement

BehaviorExtensionElement
ServiceDebugElement

Beispiele

Das folgende Codebeispiel zeigt, wie eine Konfigurationsdatei verwendet wird, um das HTML-Hilfeseitenfeature zu aktivieren und um Ausnahmeinformationen innerhalb eines SOAP-Fehlers für Debugzwecke an den Client zurückzugeben (zusätzlich zum Aktivieren der Metadatenunterstützung).

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

Hinweise

Wenn Sie die IncludeExceptionDetailInFaults-Eigenschaft programmgesteuert auf true festlegen, können Sie den Fluss einer verwalteten Ausnahmeinformation auf dem Client für Debugzwecke und die Veröffentlichung von HTML-Informationsdateien für Benutzer bereitstellen, die den Dienst in Webbrowsern durchsuchen.

Achtung

Verwaltete Ausnahmeinformationen an Dienste zurückzugeben, kann ein Sicherheitsrisiko darstellen. Das liegt darin begründet, dass Ausnahmedetails Informationen zur internen Clientimplementierung offen legen, die von nicht autorisierten Diensten verwendet werden können.

Die HttpHelpPageEnabled- und HttpsHelpPageEnabled-Eigenschaften weisen den Dienst an, HTML-Hilfedateien zu veröffentlichen, wenn der Dienst mithilfe eines HTML-Browsers angezeigt wird.

Die HttpHelpPageUrl- und die HttpsHelpPageUrl-Eigenschaft steuern die Position der angezeigten HTML-Hilfeseite.

Um eine der ServiceDebugElement-Funktionen mit einer Konfigurationsdatei zu aktivieren oder zu deaktivieren, müssen Sie Folgendes tun:

Fügen Sie dem <Dienstelement> für Ihren WCF-Dienst ein behaviorConfiguration Attribut hinzu. (Endpunktverhalten wird für <endpoint> Elemente konfiguriert, Dienstverhalten für <Dienstelemente> .)
Fügen Sie dem Abschnitt serviceBehaviors> hinzu, oder erstellen Sie einen< Abschnitt, und fügen Sie diesem ein <Behavior-Element> mit dem Namen hinzu, der dem behaviorConfiguration Attributwert aus Schritt 1 entspricht. (Endpunktverhalten wird mithilfe eines <endpointBehaviors-Elements> konfiguriert; Dienstverhalten wird mithilfe eines <serviceBehaviors-Elements> konfiguriert.
Fügen Sie dem <behavior-Element> aus Schritt 2 ein <serviceDebug-Element> hinzu, und aktivieren oder deaktivieren Sie die verschiedenen Eigenschaften, die für Ihr Szenario geeignet sind.

Ein Beispiel hierfür finden Sie im Beispielabschnitt.

Konstruktoren

ServiceDebugElement()

Initialisiert eine neue Instanz der ServiceDebugElement-Klasse.

Eigenschaften

BehaviorType	Ruft den Typ dieses Verhaltenselements ab.
ConfigurationElementName	Ruft den Namen dieses Konfigurationselements ab. (Geerbt von ServiceModelExtensionElement)
CurrentConfiguration	Ruft einen Verweis auf die Configuration-Instanz der obersten Ebene ab, die die Konfigurationshierarchie darstellt, zu der die aktuelle ConfigurationElement-Instanz gehört. (Geerbt von ConfigurationElement)
ElementInformation	Ruft ein ElementInformation-Objekt ab, das die nicht anpassbaren Informationen und Funktionen des ConfigurationElement-Objekts enthält. (Geerbt von ConfigurationElement)
ElementProperty	Ruft das ConfigurationElementProperty-Objekt ab, das das ConfigurationElement-Objekt selbst darstellt. (Geerbt von ConfigurationElement)
EvaluationContext	Ruft das ContextInformation-Objekt für das ConfigurationElement-Objekt ab. (Geerbt von ConfigurationElement)
HasContext	Ruft einen Wert ab, der angibt, ob die CurrentConfiguration-Eigenschaft `null` ist. (Geerbt von ConfigurationElement)
HttpHelpPageBinding	Ruft einen Zeichenfolgenwert ab oder legt einen Zeichenfolgenwert fest, der die zu verwendende Bindung beim Zugriff auf die Diensthilfeseite über HTTP festlegt.
HttpHelpPageBindingConfiguration	Ruft eine Zeichenfolge ab oder legt eine Zeichenfolge fest, die auf einen XML-Abschnitt verweist, der zusätzliche Konfigurationsinformationen für die in HttpHelpPageBinding angegebene Bindung definiert.
HttpHelpPageEnabled	Ruft einen Wert ab oder legt einen Wert fest, der angibt, ob Windows Communication Foundation (WCF) eine HTML-Seite an der Adresse veröffentlicht, die durch die HttpHelpPageUrl-Eigenschaft angegeben wird.
HttpHelpPageUrl	Ruft den Speicherort ab oder legt den Speicherort fest, an dem die HTML-Hilfedatei veröffentlicht wird.
HttpsHelpPageBinding	Ruft einen Zeichenfolgenwert ab oder legt einen Zeichenfolgenwert fest, der die zu verwendende Bindung beim Zugriff auf die Diensthilfeseite über HTTPS festlegt.
HttpsHelpPageBindingConfiguration	Ruft eine Zeichenfolge ab oder legt eine Zeichenfolge fest, die auf einen XML-Abschnitt verweist, der zusätzliche Konfigurationsinformationen für die in HttpsHelpPageBinding angegebene Bindung definiert.
HttpsHelpPageEnabled	Ruft einen Wert ab oder legt einen Wert fest, der angibt, ob Windows Communication Foundation (WCF) eine HTML-Hilfedatei über HTTPS an der Adresse zurückgibt, die durch die HttpsHelpPageUrl-Eigenschaft angegeben wird.
HttpsHelpPageUrl	Ruft den Speicherort ab oder legt den Speicherort fest, an dem eine HTML-Hilfedatei für den Abruf mithilfe von HTTPS veröffentlicht wird.
IncludeExceptionDetailInFaults	Ruft einen Wert ab oder legt einen Wert fest, der angibt, ob verwaltete Ausnahmeinformationen in Details der SOAP-Fehler für Debugzwecke an den Client zurückgegeben werden.
Item[ConfigurationProperty]	Ruft eine Eigenschaft oder ein Attribut dieses Konfigurationselements ab oder legt diese bzw. dieses fest. (Geerbt von ConfigurationElement)
Item[String]	Ruft eine Eigenschaft, ein Attribut oder ein untergeordnetes Element dieses Konfigurationselements ab oder legt diese(s) fest. (Geerbt von ConfigurationElement)
LockAllAttributesExcept	Ruft die Auflistung gesperrter Attribute ab. (Geerbt von ConfigurationElement)
LockAllElementsExcept	Ruft die Auflistung gesperrter Elemente ab. (Geerbt von ConfigurationElement)
LockAttributes	Ruft die Auflistung gesperrter Attribute ab. (Geerbt von ConfigurationElement)
LockElements	Ruft die Auflistung gesperrter Elemente ab. (Geerbt von ConfigurationElement)
LockItem	Ruft einen Wert ab, der angibt, ob das Element gesperrt ist, oder legt diesen fest. (Geerbt von ConfigurationElement)
Properties	Ruft die Auflistung von Eigenschaften ab. (Geerbt von ConfigurationElement)

Methoden

CopyFrom(ServiceModelExtensionElement)	Kopiert den Inhalt des angegebenen Konfigurationselements in dieses Konfigurationselement.
CreateBehavior()	Erstellt eine Verhaltenserweiterung basierend auf den aktuellen Konfigurationseinstellungen. (Geerbt von BehaviorExtensionElement)
DeserializeElement(XmlReader, Boolean)	Liest XML aus der Konfigurationsdatei. (Geerbt von ConfigurationElement)
Equals(Object)	Vergleicht die aktuelle ConfigurationElement-Instanz mit dem angegebenen Objekt. (Geerbt von ConfigurationElement)
GetHashCode()	Ruft einen eindeutigen Wert ab, der die aktuelle ConfigurationElement-Instanz darstellt. (Geerbt von ConfigurationElement)
GetTransformedAssemblyString(String)	Gibt die transformierte Version des angegebenen Assemblynamens zurück. (Geerbt von ConfigurationElement)
GetTransformedTypeString(String)	Gibt die transformierte Version des angegebenen Typnamens zurück. (Geerbt von ConfigurationElement)
GetType()	Ruft den Type der aktuellen Instanz ab. (Geerbt von Object)
Init()	Legt für das ConfigurationElement-Objekt den Ausgangszustand fest. (Geerbt von ConfigurationElement)
InitializeDefault()	Wird verwendet, um einen Standardsatz von Werten für das ConfigurationElement-Objekt zu initialisieren. (Geerbt von ConfigurationElement)
IsModified()	Ruft einen Wert ab, der angibt, ob dieses Konfigurationselement geändert wurde. (Geerbt von ServiceModelExtensionElement)
IsReadOnly()	Ruft einen Wert ab, der angibt, ob das ConfigurationElement schreibgeschützt ist. (Geerbt von ConfigurationElement)
ListErrors(IList)	Fügt die Fehler über ungültige Eigenschaften in diesem ConfigurationElement-Objekt und in allen Unterelementen der übergebenen Liste hinzu. (Geerbt von ConfigurationElement)
MemberwiseClone()	Erstellt eine flache Kopie des aktuellen Object. (Geerbt von Object)
OnDeserializeUnrecognizedAttribute(String, String)	Ruft einen Wert ab, der angibt, ob während der Deserialisierung ein unbekanntes Attribut aufgetreten ist. (Geerbt von ConfigurationElement)
OnDeserializeUnrecognizedElement(String, XmlReader)	Ruft einen Wert ab, der angibt, ob während der Deserialisierung ein unbekanntes Element aufgetreten ist. (Geerbt von ConfigurationElement)
OnRequiredPropertyNotFound(String)	Löst eine Ausnahme aus, wenn eine erforderliche Eigenschaft nicht gefunden wird. (Geerbt von ConfigurationElement)
PostDeserialize()	Wird nach der Deserialisierung aufgerufen. (Geerbt von ConfigurationElement)
PreSerialize(XmlWriter)	Wird vor der Serialisierung aufgerufen. (Geerbt von ConfigurationElement)
Reset(ConfigurationElement)	Setzt den internen Status dieses Konfigurationselementobjekts zurück, einschließlich der Sperren und der Eigenschaftenauflistungen. (Geerbt von ServiceModelExtensionElement)
ResetModified()	Setzt bei Implementierung in einer abgeleiteten Klasse den Wert der IsModified()-Methode auf `false` zurück. (Geerbt von ConfigurationElement)
SerializeElement(XmlWriter, Boolean)	Schreibt den Inhalt dieses Konfigurationselements in die Konfigurationsdatei. (Geerbt von ServiceModelExtensionElement)
SerializeToXmlElement(XmlWriter, String)	Schreibt bei Implementierung in einer abgeleiteten Klasse die äußeren Tags dieses Konfigurationselements in die Konfigurationsdatei. (Geerbt von ConfigurationElement)
SetPropertyValue(ConfigurationProperty, Object, Boolean)	Legt eine Eigenschaft auf den angegebenen Wert fest. (Geerbt von ConfigurationElement)
SetPropertyValueIfNotDefaultValue<T>(String, T)	Legt den Eigenschaftswert für das Konfigurationselement ab, wenn der Wert nicht der Standardwert ist. (Geerbt von ServiceModelConfigurationElement)
SetReadOnly()	Legt die IsReadOnly()-Eigenschaft für das ConfigurationElement-Objekt und alle Unterelemente fest. (Geerbt von ConfigurationElement)
ToString()	Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt. (Geerbt von Object)
Unmerge(ConfigurationElement, ConfigurationElement, ConfigurationSaveMode)	Ändert das ConfigurationElement-Objekt, um alle Werte zu entfernen, die nicht gespeichert werden sollen. (Geerbt von ConfigurationElement)

Gilt für:

Weitere Informationen

<serviceDebug>