ServiceDebugBehavior ServiceDebugBehavior ServiceDebugBehavior ServiceDebugBehavior Class

定義

Windows Communication Foundation (WCF) サービスのデバッグ機能とヘルプ情報機能を有効にします。Enables debugging and help information features for a Windows Communication Foundation (WCF) service.

public ref class ServiceDebugBehavior : System::ServiceModel::Description::IServiceBehavior
public class ServiceDebugBehavior : System.ServiceModel.Description.IServiceBehavior
type ServiceDebugBehavior = class
    interface IServiceBehavior
Public Class ServiceDebugBehavior
Implements IServiceBehavior
継承
ServiceDebugBehaviorServiceDebugBehaviorServiceDebugBehaviorServiceDebugBehavior
実装

構成ファイルを使用して、HTML ヘルプ ページ機能を有効にし、メタデータのサポートを有効にすると共に、デバッグのために SOAP エラー内の例外情報をクライアントに返す方法を次のコード例に示します。The following code example shows how to use a configuration file to enable the HTML help page feature and return exception information inside a SOAP fault back to the client for debugging purposes, in addition to enabling metadata support. この構成ファイルは、ServiceDebugBehavior 機能のサポートを追加するための次の基本手順を示します。This configuration file shows the following basic steps to adding support for the ServiceDebugBehavior features:

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

注釈

構成ファイルまたはプログラムから ServiceDebugBehavior プロパティを使用すると、デバッグ目的でクライアントへのマネージド例外情報のフロー、および Web ブラウザーでサービスをブラウズするユーザー向けの HTML 情報ファイルの公開を有効にできます。Use the ServiceDebugBehavior properties from a configuration file or programmatically to enable the flow of managed exception information to the client for debugging purposes as well as the publication of HTML information files for users browsing the service in Web browsers.

設定、IncludeExceptionDetailInFaultsプロパティをtrueを返す管理対象の WCF に指示する SOAP の例外情報エラーをクライアントのデバッグのためです。Set the IncludeExceptionDetailInFaults property to true to instruct WCF to return managed exception information in SOAP faults to clients for debugging purposes.

注意事項

マネージド例外情報をクライアントに戻すことは、セキュリティ リスクになり得ます。これは、例外の詳細が、非承認のクライアントで使用可能な内部サービスの実装についての情報を公開するからです。Returning managed exception information to clients can be a security risk because exception details expose information about the internal service implementation that could be used by unauthorized clients. さらに、ServiceDebugBehavior プロパティをプログラムで設定することはできますが、配置するときに IncludeExceptionDetailInFaults を無効にすることを忘れがちになります。In addition, although the ServiceDebugBehavior properties can also be set programmatically, it can be easy to forget to disable IncludeExceptionDetailInFaults when deploying.

セキュリティの問題にかかわるので、以下を強くお勧めします。Because of the security issues involved, it is strongly recommended that:

  • IncludeExceptionDetailInFaults プロパティの値を true に設定するには、アプリケーション構成ファイルを使用します。You use an application configuration file to set the value of the IncludeExceptionDetailInFaults property to true.

  • これは、制御されたデバッグ シナリオの場合に限って行います。You only do so only in controlled debugging scenarios.

マネージ例外情報に関連するセキュリティの問題に関する詳細については、次を参照してください。を指定すると処理のエラー コントラクトおよびサービスのします。For more information about the security issues related to managed exception information, see Specifying and Handling Faults in Contracts and Services.

HttpHelpPageEnabled プロパティおよび HttpsHelpPageEnabled プロパティにより、サービスが HTML ブラウザーを使用して表示されるときに HTML ヘルプ ファイルを公開できます。The HttpHelpPageEnabled and HttpsHelpPageEnabled properties instruct the service to publish HTML help files when the service is viewed using an HTML browser.

HttpHelpPageUrl プロパティおよび HttpsHelpPageUrl プロパティは、表示される HTML ヘルプ ページの位置を制御します。The HttpHelpPageUrl and HttpsHelpPageUrl properties control the location of the HTML help page that is viewed.

構成ファイルを使用していずれかの ServiceDebugBehavior 機能を有効または無効にするには、以下を行う必要があります。To enable or disable one of the ServiceDebugBehavior features using a configuration file:

  1. 追加、behaviorConfiguration属性を<サービス> WCF サービスの要素。Add a behaviorConfiguration attribute to the <service> element for your WCF service. エンドポイントの動作が構成されている<エンドポイント >要素; 上のサービス動作<サービス>要素。Endpoint behaviors are configured on <endpoint> elements; service behaviors on <service> elements.

  2. 追加または作成を <serviceBehaviors> セクションし、追加、 <動作> に一致する名前の要素にbehaviorConfiguration手順 1 から属性の値。Add to or create a <serviceBehaviors> section and add a <behavior> element to that with the name that matches the behaviorConfiguration attribute value from step 1. 使用してエンドポイントの動作が構成されて、 <endpointBehaviors> 要素、サービス動作構成を使用して、 <serviceBehaviors> 要素。Endpoint behaviors are configured using an <endpointBehaviors> element; service behaviors are configured using a <serviceBehaviors> element.

  3. 追加、 <serviceDebug> 要素を<動作>手順 2 から要素と有効または無効にする適切なさまざまなプロパティシナリオ。Add a <serviceDebug> element to the <behavior> element from step 2 and enable or disable the various properties appropriate to your scenario.

個々の例については、「使用例」のセクションを参照してください。For a specific example, see the Example section.

コンストラクター

ServiceDebugBehavior() ServiceDebugBehavior() ServiceDebugBehavior() ServiceDebugBehavior()

ServiceDebugBehavior クラスの新しいインスタンスを初期化します。Initializes a new instance of the ServiceDebugBehavior class.

プロパティ

HttpHelpPageBinding HttpHelpPageBinding HttpHelpPageBinding HttpHelpPageBinding

バインディングの定義への高レベルのアクセスを取得または設定します。Gets or sets high-level access to the definition of a binding.

HttpHelpPageEnabled HttpHelpPageEnabled HttpHelpPageEnabled HttpHelpPageEnabled

Windows Communication Foundation (WCF) が、HttpHelpPageUrl プロパティで制御されるアドレスに HTML ヘルプ ページを公開するかどうかを制御する値を取得または設定します。Gets or sets a value that controls whether Windows Communication Foundation (WCF) publishes an HTML help page at the address controlled by the HttpHelpPageUrl property.

HttpHelpPageUrl HttpHelpPageUrl HttpHelpPageUrl HttpHelpPageUrl

HTML ヘルプ ファイルが公開される場所を取得または設定します。Gets or sets the location at which the HTML help file is published.

HttpsHelpPageBinding HttpsHelpPageBinding HttpsHelpPageBinding HttpsHelpPageBinding

バインディングの定義への高レベルのアクセスを取得または設定します。Gets or sets high-level access to the definition of a binding.

HttpsHelpPageEnabled HttpsHelpPageEnabled HttpsHelpPageEnabled HttpsHelpPageEnabled

Windows Communication Foundation (WCF) が、HttpsHelpPageUrl プロパティで制御されるアドレスに HTTPS を介して HTML ヘルプ ファイルを返すかどうかを指定する値を取得または設定します。Gets or sets a value that specifies whether Windows Communication Foundation (WCF) returns an HTML help file over HTTPS at the address controlled by the HttpsHelpPageUrl property.

HttpsHelpPageUrl HttpsHelpPageUrl HttpsHelpPageUrl HttpsHelpPageUrl

HTTPS を使用した取得のために、HTML ファイルが公開される場所を取得または設定します。Gets or sets the location at which an HTML file is published for retrieval using HTTPS.

IncludeExceptionDetailInFaults IncludeExceptionDetailInFaults IncludeExceptionDetailInFaults IncludeExceptionDetailInFaults

デバッグの目的でクライアントに返される SOAP エラーの詳細に、マネージド例外情報を含めるかどうかを指定する値を取得または設定します。Gets or sets a value that specifies whether to include managed exception information in the detail of SOAP faults returned to the client for debugging purposes.

明示的なインターフェイスの実装

IServiceBehavior.AddBindingParameters(ServiceDescription, ServiceHostBase, Collection<ServiceEndpoint>, BindingParameterCollection) IServiceBehavior.AddBindingParameters(ServiceDescription, ServiceHostBase, Collection<ServiceEndpoint>, BindingParameterCollection) IServiceBehavior.AddBindingParameters(ServiceDescription, ServiceHostBase, Collection<ServiceEndpoint>, BindingParameterCollection) IServiceBehavior.AddBindingParameters(ServiceDescription, ServiceHostBase, Collection<ServiceEndpoint>, BindingParameterCollection)

AddBindingParameters(ServiceDescription, ServiceHostBase, Collection<ServiceEndpoint>, BindingParameterCollection) メソッドを実装して動作をサポートします。Implements the AddBindingParameters(ServiceDescription, ServiceHostBase, Collection<ServiceEndpoint>, BindingParameterCollection) method to support the behavior.

IServiceBehavior.ApplyDispatchBehavior(ServiceDescription, ServiceHostBase) IServiceBehavior.ApplyDispatchBehavior(ServiceDescription, ServiceHostBase) IServiceBehavior.ApplyDispatchBehavior(ServiceDescription, ServiceHostBase) IServiceBehavior.ApplyDispatchBehavior(ServiceDescription, ServiceHostBase)

ApplyDispatchBehavior(ServiceDescription, ServiceHostBase) メソッドを実装して動作をサポートします。Implements the ApplyDispatchBehavior(ServiceDescription, ServiceHostBase) method to support the behavior.

IServiceBehavior.Validate(ServiceDescription, ServiceHostBase) IServiceBehavior.Validate(ServiceDescription, ServiceHostBase) IServiceBehavior.Validate(ServiceDescription, ServiceHostBase) IServiceBehavior.Validate(ServiceDescription, ServiceHostBase)

Validate(ServiceDescription, ServiceHostBase) メソッドを実装して動作をサポートします。Implements the Validate(ServiceDescription, ServiceHostBase) method to support the behavior.

メソッド

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

指定したオブジェクトが、現在のオブジェクトと等しいかどうかを判断します。Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetHashCode() GetHashCode() GetHashCode() GetHashCode()

既定のハッシュ関数として機能します。Serves as the default hash function.

(Inherited from Object)
GetType() GetType() GetType() GetType()

現在のインスタンスの Type を取得します。Gets the Type of the current instance.

(Inherited from Object)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

現在の Object の簡易コピーを作成します。Creates a shallow copy of the current Object.

(Inherited from Object)
ToString() ToString() ToString() ToString()

現在のオブジェクトを表す文字列を返します。Returns a string that represents the current object.

(Inherited from Object)

適用対象