<serviceDebug>

  • [アーティクル]

Windows Communication Foundation (WCF) サービスのデバッグおよびヘルプ情報機能を指定します。

スキーマの階層

<system.serviceModel>
  <behaviors>
    <serviceBehaviors>
      <serviceBehaviors> の <behavior>
        <serviceDebug>

構文

<serviceDebug     httpHelpPageBinding=”String”    httpHelpPageBindingConfiguration=”String”
    httpHelpPageEnabled="Boolean"
    httpHelpPageUrl="Uri"
    httpsHelpPageBinding=”String”    httpsHelpPageBindingConfiguration=”String”
    httpsHelpPageEnabled="Boolean"
    httpsHelpPageUrl="Uri"
    includeExceptionDetailInFaults="Boolean" />

属性と要素

以降のセクションでは、属性、子要素、および親要素について説明します。

属性

属性 説明

httpHelpPageBinding

HTTP を利用してサービス ヘルプ ページにアクセスする場合に使用するバインディングの種類を指定する文字列値。

System.ServiceModel.Channels.IReplyChannel をサポートする内部バインディング要素を使用したバインディングでのみサポートされます。さらに、バインディングの System.ServiceModel.Channels.MessageVersion プロパティが System.ServiceModel.Channels.MessageVersion.None である必要があります。

httpHelpPageBindingConfiguration

このバインディングの追加の構成情報を参照する httpHelpPageBinding 属性に指定されるバインディングの名前を指定する文字列。同じ名前を <bindings> セクションに定義する必要があります。

httpHelpPageEnabled

WCF が、httpHelpPageUrl 属性により指定されたアドレスに HTML ヘルプ ページを公開するかどうかを制御するブール値です。既定値は true です。

このプロパティを false に設定して、HTML ブラウザーに表示される HTML ヘルプ ページの公開を無効にできます。

HTML ヘルプ ページが、httpHelpPageUrl 属性により制御される場所に公開されるようにするには、この属性を true に設定する必要があります。さらに、次のいずれかの条件も満たす必要があります。

  • httpHelpPageUrl 属性は、HTTP プロトコル スキームをサポートする絶対アドレスです。

  • HTTP プロトコル スキームをサポートするサービスのベース アドレスがあります。

HTTP プロトコル スキームをサポートしない絶対アドレスが httpHelpPageUrl 属性に割り当てられている場合は例外がスローされますが、前の基準をどれも満たさないその他のシナリオでは、例外も HTML ヘルプ ページも表示されません。

httpHelpPageUrl

HTML ブラウザーを使用してエンドポイントを表示するときにユーザーが参照する、カスタム HTML ヘルプ ファイルの相対的または絶対的な HTTP ベースの URL を指定する URI。

この属性を使用して、HTTP/Get 要求から返されるカスタム HTML ヘルプ ファイルを HTML ブラウザーなどから利用できます。HTML ヘルプ ファイルの位置は、次のように解決されます。

  1. この属性の値が相対アドレスの場合、HTML ヘルプ ファイルの位置は、HTTP 要求をサポートするサービスのベース アドレスにこのプロパティの値を加えた値になります。

  2. この属性が絶対アドレスであり、HTTP 要求をサポートする場合は、HTML ヘルプ ファイルの位置はこのプロパティの値になります。

  3. この属性の値が絶対値であっても HTTP 要求をサポートしていない場合は、例外がスローされます。

この属性は、httpHelpPageEnabled 属性が true の場合にだけ有効です。

httpsHelpPageBinding

HTTPS を利用してサービス ヘルプ ページにアクセスする場合に使用するバインディングの種類を指定する文字列値。

System.ServiceModel.Channels.IReplyChannel をサポートする内部バインディング要素を使用したバインディングでのみサポートされます。さらに、バインディングの System.ServiceModel.Channels.MessageVersion プロパティが System.ServiceModel.Channels.MessageVersion.None である必要があります。

httpsHelpPageBindingConfiguration

このバインディングの追加の構成情報を参照する httpsHelpPageBinding 属性に指定されるバインディングの名前を指定する文字列。同じ名前を <bindings> セクションに定義する必要があります。

httpsHelpPageEnabled

WCF が、httpsHelpPageUrl 属性により指定されたアドレスに HTML ヘルプ ページを公開するかどうかを制御するブール値です。既定値は true です。

このプロパティを false に設定して、HTML ブラウザーに表示される HTML ヘルプ ページの公開を無効にできます。

HTML ヘルプ ページが、httpsHelpPageUrl 属性により制御される場所に公開されるようにするには、この属性を true に設定する必要があります。さらに、次のいずれかの条件も満たす必要があります。

  • httpsHelpPageUrl 属性は、HTTPS プロトコル スキームをサポートする絶対アドレスです。

  • HTTPS プロトコル スキームをサポートするサービスのベース アドレスがあります。

HTTPS プロトコル スキームをサポートしない絶対アドレスが httpsHelpPageUrl 属性に割り当てられている場合は例外がスローされますが、前の基準をどれも満たさないその他のシナリオでは、例外も HTML ヘルプ ページも表示されません。

httpsHelpPageUrl

HTML ブラウザーを使用してエンドポイントを表示するときにユーザーが参照する、カスタム HTML ヘルプ ファイルの相対的または絶対的な HTTPS ベースの URL を指定する URI。

この属性を使用して、HTTPS/Get 要求から返されるカスタム HTML ヘルプ ファイルを HTML ブラウザーなどから利用できます。HTML ヘルプ ファイルの場所は、次のように解決されます。

  • このプロパティの値が相対アドレスの場合、HTML ヘルプ ファイルの位置は、HTTPS 要求をサポートするサービスのベース アドレスにこのプロパティの値を加えた値になります。

  • このプロパティが絶対アドレスであり、HTTPS 要求をサポートする場合は、HTML ヘルプ ファイルの位置はこのプロパティの値になります。

  • このプロパティの値が絶対値であっても HTTPS 要求をサポートしていない場合は、例外がスローされます。

この属性は、httpHelpPageEnabled 属性が true の場合にだけ有効です。

includeExceptionDetailInFaults

デバッグの目的でクライアントに返される SOAP エラーの詳細に、マネージ例外情報を含めるかどうかを指定する値。既定値は false です。

この属性を true に設定すると、デバッグ目的でクライアントへのマネージ例外情報のフロー、および Web ブラウザーでサービスをブラウズするユーザー向けの HTML 情報ファイルの公開を有効にできます。

ms788993.Caution(ja-jp,VS.100).gif注意 :
マネージ例外情報をクライアントに返すことは、セキュリティ リスクになり得ます。これは、例外の詳細が、認証されていないクライアントによって使用可能な内部サービスの実装に関する情報を公開するためです。

子要素

なし。

親要素

要素 説明

<endpointBehaviors> の <behavior>

動作の要素を指定します。

解説

例外が FaultContractAttribute を使用して宣言されていない場合でも、includeExceptionDetailInFaults を true に設定すると、サービスでは、アプリケーション コードによってスローされる例外を返すことができます。この設定は、サーバーが予期しない例外をスローしている場合のデバッグ時に役立ちます。この属性を使用すると、不明な例外がシリアル化された形式で返されるので、例外をより詳細に調べることができます。

ms788993.Caution(ja-jp,VS.100).gif注意 :
マネージ例外情報をクライアントに戻すことは、セキュリティ リスクになり得ます。これは、例外の詳細が、非承認のクライアントで使用可能な内部サービスの実装についての情報を公開するからです。セキュリティの問題にかかわるため、この操作は制御されたデバッグ シナリオでのみ行うことを強くお勧めします。アプリケーションを配置する場合は、includeExceptionDetailInFaults を false に設定する必要があります。

マネージ例外に関連するセキュリティ問題の詳細については、「Specifying and Handling Faults in Contracts and Services」を参照してください。コード例については、「Service Debug Behavior」を参照してください。

httpsHelpPageEnabled と httpsHelpPageUrl を設定して、ヘルプ ページを有効または無効にすることもできます。各サービスは、サービスの WSDL を取得するエンドポイントなど、サービスに関する情報が含まれるヘルプ ページをオプションで公開できます。これを有効にするには、httpHelpPageEnabled プロパティを true に設定します。これにより、サービスのベース アドレスへの GET 要求に対して、ヘルプ ページを返すことができます。このアドレスは、httpHelpPageUrl 属性を設定することで変更できます。また、HTTP の代わりに HTTPS を使用すると、このアドレスをセキュリティで保護できます。

省略可能な httpHelpPageBinding 属性および httpHelpPageBinding 属性を使用すると、サービス ウェブ ページにアクセスするためのバインディングを構成できます。これらの属性が指定されていない場合、サービス ヘルプ ページへのアクセスには、適切な既定のバインディグ (HTTP の場合は HttpTransportBindingElement、HTTPS の場合は HttpsTransportBindingElement) が使用されます。これらの属性は、組み込みの WCF バインディングでは使用できないことに注意してください。System.ServiceModel.Channels.IReplyChannel をサポートする内部バインディング要素を使用したバインディングでのみサポートされます。さらに、バインディングの System.ServiceModel.Channels.MessageVersion プロパティが System.ServiceModel.Channels.MessageVersion.None である必要があります。

参照

リファレンス

ServiceDebugElement
ServiceDebugBehavior

その他のリソース

Specifying and Handling Faults in Contracts and Services
Handling Exceptions and Faults
Service Debug Behavior