ServiceDebugElement クラス

定義

名前空間:

System.ServiceModel.Configuration

アセンブリ:

System.ServiceModel.dll

Windows Communication Foundation (WCF) サービスのデバッグ機能とヘルプ情報機能を指定する構成要素を表します。 このクラスは継承できません。

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

継承

Object

ConfigurationElement

ServiceModelConfigurationElement

ServiceModelExtensionElement

BehaviorExtensionElement

ServiceDebugElement

例

構成ファイルを使用して、HTML ヘルプ ページ機能を有効にし、メタデータのサポートを有効にすると共に、デバッグのために SOAP エラー内の例外情報をクライアントに返す方法を次のコード例に示します。

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

注釈

プログラムで IncludeExceptionDetailInFaults プロパティを true に設定すると、デバッグ目的でクライアントへのマネージド例外情報のフローを有効にし、Web ブラウザーでサービスを閲覧するユーザー向けに HTML 情報ファイルを公開できます。

注意事項

マネージド例外情報をサービスに戻すことは、セキュリティ リスクとなり得ます。 これは、例外の詳細が、未承認のサービスが使用できる内部クライアント実装についての情報を公開するからです。

HttpHelpPageEnabled プロパティおよび HttpsHelpPageEnabled プロパティにより、サービスが HTML ブラウザーを使用して表示されるときに HTML ヘルプ ファイルを公開できます。

HttpHelpPageUrl プロパティおよび HttpsHelpPageUrl プロパティは、表示される HTML ヘルプ ページの位置を制御します。

構成ファイルを使用していずれかの ServiceDebugElement 機能を有効または無効にするには、以下を行う必要があります。

1. WCF サービスのbehaviorConfigurationサービス>要素に< 属性を追加します。 (エンドポイントの動作は要素に対して<endpoint>構成され、サービス要素ではサービス>動作が<構成されます)。

2. serviceBehaviors> セクションを<追加<または作成し、手順 1 の属性値と一致する名前の behavior> 要素をbehaviorConfiguration追加します。 (エンドポイントの動作は endpointBehaviors> 要素を<使用して構成されます。サービス動作は serviceBehaviors> 要素を<使用して構成されます。

3. 手順 2 の behavior> 要素に serviceDebug 要素を<追加し、シナリオに適したさまざまなプロパティを有効または無効にします。><

個々の例については、「使用例」のセクションを参照してください。

コンストラクター

ServiceDebugElement()

ServiceDebugElement クラスの新しいインスタンスを初期化します。

プロパティ

BehaviorType	この動作要素の型を取得します。
ConfigurationElementName	この構成要素の名前を取得します。 (継承元 ServiceModelExtensionElement)
CurrentConfiguration	現在の Configuration インスタンスが属している構成階層を表す最上位の ConfigurationElement インスタンスへの参照を取得します。 (継承元 ConfigurationElement)
ElementInformation	ElementInformation オブジェクトのカスタマイズできない情報と機能を格納する ConfigurationElement オブジェクトを取得します。 (継承元 ConfigurationElement)
ElementProperty	ConfigurationElementProperty オブジェクト自体を表す ConfigurationElement オブジェクトを取得します。 (継承元 ConfigurationElement)
EvaluationContext	ContextInformation オブジェクトの ConfigurationElement オブジェクトを取得します。 (継承元 ConfigurationElement)
HasContext	CurrentConfiguration プロパティが null であるかどうかを示す値を取得します。 (継承元 ConfigurationElement)
HttpHelpPageBinding	HTTP を利用してサービス ヘルプ ページにアクセスする場合に使用するバインディングを指定する文字列値を取得または設定します。
HttpHelpPageBindingConfiguration	HttpHelpPageBinding に指定されたバインディングに関して追加の構成情報を定義する XML セクションを指す文字列を取得または設定します。
HttpHelpPageEnabled	Windows Communication Foundation (WCF) が、HttpHelpPageUrl プロパティで指定されるアドレスに HTML ヘルプ ページを公開するかどうかを指定する値を取得または設定します。
HttpHelpPageUrl	HTML ヘルプ ファイルが公開される場所を取得または設定します。
HttpsHelpPageBinding	HTTPS を利用してサービス ヘルプ ページにアクセスする場合に使用するバインディングを指定する文字列値を取得または設定します。
HttpsHelpPageBindingConfiguration	HttpsHelpPageBinding に指定されたバインディングに関して追加の構成情報を定義する XML セクションを指す文字列を取得または設定します。
HttpsHelpPageEnabled	Windows Communication Foundation (WCF) が、HttpsHelpPageUrl プロパティで指定されるアドレスに HTTPS を介して HTML ヘルプ ファイルを返すかどうかを指定する値を取得または設定します。
HttpsHelpPageUrl	HTTPS を使用した取得のために、HTML ヘルプ ファイルが公開される場所を取得または設定します。
IncludeExceptionDetailInFaults	デバッグの目的でクライアントに返される SOAP エラーの詳細に、マネージド例外情報を含めるかどうかを指定する値を取得または設定します。
Item[ConfigurationProperty]	この構成要素のプロパティまたは属性を取得または設定します。 (継承元 ConfigurationElement)
Item[String]	この構成要素のプロパティ、属性、または子要素を取得または設定します。 (継承元 ConfigurationElement)
LockAllAttributesExcept	ロックされている属性のコレクションを取得します。 (継承元 ConfigurationElement)
LockAllElementsExcept	ロックされている要素のコレクションを取得します。 (継承元 ConfigurationElement)
LockAttributes	ロックされている属性のコレクションを取得します。 (継承元 ConfigurationElement)
LockElements	ロックされている要素のコレクションを取得します。 (継承元 ConfigurationElement)
LockItem	要素がロックされているかどうかを示す値を取得または設定します。 (継承元 ConfigurationElement)
Properties	プロパティのコレクションを取得します。 (継承元 ConfigurationElement)

メソッド

CopyFrom(ServiceModelExtensionElement)	指定された構成要素の内容をこの構成要素にコピーします。
CreateBehavior()	現在の構成設定に基づく動作拡張を作成します。 (継承元 BehaviorExtensionElement)
DeserializeElement(XmlReader, Boolean)	構成ファイルから XML を読み取ります。 (継承元 ConfigurationElement)
Equals(Object)	現在の ConfigurationElement インスタンスを、指定したオブジェクトと比較します。 (継承元 ConfigurationElement)
GetHashCode()	現在の ConfigurationElement インスタンスを表す一意の値を取得します。 (継承元 ConfigurationElement)
GetTransformedAssemblyString(String)	指定されたアセンブリ名を変換して返します。 (継承元 ConfigurationElement)
GetTransformedTypeString(String)	指定された型名を変換して返します。 (継承元 ConfigurationElement)
GetType()	現在のインスタンスの Type を取得します。 (継承元 Object)
Init()	ConfigurationElement オブジェクトを初期状態に設定します。 (継承元 ConfigurationElement)
InitializeDefault()	ConfigurationElement オブジェクトの既定の値セットを初期化するために使用します。 (継承元 ConfigurationElement)
IsModified()	この構成要素が変更されたかどうかを示す値を取得します。 (継承元 ServiceModelExtensionElement)
IsReadOnly()	ConfigurationElement オブジェクトが読み取り専用かどうかを示す値を取得します。 (継承元 ConfigurationElement)
ListErrors(IList)	この ConfigurationElement オブジェクトおよびすべてのサブ要素の無効なプロパティのエラーを、渡されたリストに追加します。 (継承元 ConfigurationElement)
MemberwiseClone()	現在の Object の簡易コピーを作成します。 (継承元 Object)
OnDeserializeUnrecognizedAttribute(String, String)	逆シリカル化中に不明な属性が発生したかどうかを示す値を取得します。 (継承元 ConfigurationElement)
OnDeserializeUnrecognizedElement(String, XmlReader)	逆シリカル化中に不明な要素が発生したかどうかを示す値を取得します。 (継承元 ConfigurationElement)
OnRequiredPropertyNotFound(String)	必要なプロパティが見つからないと例外がスローされます。 (継承元 ConfigurationElement)
PostDeserialize()	逆シリアル化後に呼び出されます。 (継承元 ConfigurationElement)
PreSerialize(XmlWriter)	シリアル化前に呼び出されます。 (継承元 ConfigurationElement)
Reset(ConfigurationElement)	この構成要素オブジェクトの内部状態 (ロックやプロパティ コレクションなど) をリセットします。 (継承元 ServiceModelExtensionElement)
ResetModified()	IsModified() メソッドの値が派生クラスに実装されたときに、false にリセットします。 (継承元 ConfigurationElement)
SerializeElement(XmlWriter, Boolean)	この構成要素の内容を構成ファイルに書き込みます。 (継承元 ServiceModelExtensionElement)
SerializeToXmlElement(XmlWriter, String)	派生クラスに実装されている場合、この構成要素の外側のタグを構成ファイルに書き込みます。 (継承元 ConfigurationElement)
SetPropertyValue(ConfigurationProperty, Object, Boolean)	プロパティを指定した値に設定します。 (継承元 ConfigurationElement)
SetPropertyValueIfNotDefaultValue<T>(String, T)	値が既定値でない場合、構成要素のプロパティ値を設定します。 (継承元 ServiceModelConfigurationElement)
SetReadOnly()	IsReadOnly() オブジェクトおよびすべてのサブ要素に ConfigurationElement プロパティを設定します。 (継承元 ConfigurationElement)
ToString()	現在のオブジェクトを表す文字列を返します。 (継承元 Object)
Unmerge(ConfigurationElement, ConfigurationElement, ConfigurationSaveMode)	保存しないすべての値を削除するには、ConfigurationElement オブジェクトを変更します。 (継承元 ConfigurationElement)

こちらもご覧ください

• <serviceDebug>