IDispatchMessageInspector インターフェイス

定義

名前空間:

System.ServiceModel.Dispatcher

アセンブリ:

System.ServiceModel.Primitives.dll

パッケージ:

System.ServiceModel.Primitives v8.0.0

サービス アプリケーションの受信および送信アプリケーション メッセージのカスタム検査または変更を有効にするメソッドを定義します。

public interface class IDispatchMessageInspector

public interface IDispatchMessageInspector

type IDispatchMessageInspector = interface

Public Interface IDispatchMessageInspector

例

次のコード例は、呼び出されたときにコンソールに文字列を書き込む基本的な IDispatchMessageInspector を示しています。

#region IDispatchMessageInspector Members
public object AfterReceiveRequest(ref System.ServiceModel.Channels.Message request, IClientChannel channel, InstanceContext instanceContext)
{
  Console.WriteLine("IDispatchMessageInspector.AfterReceiveRequest called.");
  return null;
}

public void BeforeSendReply(ref System.ServiceModel.Channels.Message reply, object correlationState)
{
  Console.WriteLine("IDispatchMessageInspector.BeforeSendReply called.");
}
#endregion

#Region "IDispatchMessageInspector Members"
    Public Function AfterReceiveRequest(ByRef request As System.ServiceModel.Channels.Message, _
                       ByVal channel As IClientChannel, ByVal instanceContext As InstanceContext) _
                       As Object Implements IDispatchMessageInspector.AfterReceiveRequest
        Console.WriteLine("IDispatchMessageInspector.AfterReceiveRequest called.")
        Return Nothing
    End Function

    Public Sub BeforeSendReply(ByRef reply As System.ServiceModel.Channels.Message, ByVal correlationState As Object) _
    Implements IDispatchMessageInspector.BeforeSendReply
        Console.WriteLine("IDispatchMessageInspector.BeforeSendReply called.")
    End Sub
#End Region

次のコード例は、DispatchRuntime.MessageInspectors コレクションに InspectorIDispatchMessageInspector を追加する IServiceBehavior の実装を示しています。

#region IServiceBehavior Members
public void AddBindingParameters(
  ServiceDescription serviceDescription,
  ServiceHostBase serviceHostBase,
  System.Collections.ObjectModel.Collection<ServiceEndpoint> endpoints,
  BindingParameterCollection bindingParameters
)
{ return; }

public void ApplyDispatchBehavior(ServiceDescription serviceDescription, ServiceHostBase serviceHostBase)
{
  foreach (ChannelDispatcher chDisp in serviceHostBase.ChannelDispatchers)
  {
    foreach (EndpointDispatcher epDisp in chDisp.Endpoints)
    {
      epDisp.DispatchRuntime.MessageInspectors.Add(new Inspector());
      foreach (DispatchOperation op in epDisp.DispatchRuntime.Operations)
        op.ParameterInspectors.Add(new Inspector());
    }
  }
}

#Region "IServiceBehavior Members"
    Public Sub AddBindingParameters(ByVal serviceDescription As ServiceDescription, _
                   ByVal serviceHostBase As ServiceHostBase, ByVal endpoints As  _
                   System.Collections.ObjectModel.Collection(Of ServiceEndpoint), _
                   ByVal bindingParameters As BindingParameterCollection) Implements IServiceBehavior.AddBindingParameters
        Return
    End Sub

    Public Sub ApplyDispatchBehavior(ByVal serviceDescription As ServiceDescription, _
                                     ByVal serviceHostBase As ServiceHostBase) Implements _
                                     IServiceBehavior.ApplyDispatchBehavior
        For Each chDisp As ChannelDispatcher In serviceHostBase.ChannelDispatchers
            For Each epDisp As EndpointDispatcher In chDisp.Endpoints
                epDisp.DispatchRuntime.MessageInspectors.Add(New Inspector())
                For Each op As DispatchOperation In epDisp.DispatchRuntime.Operations
                    op.ParameterInspectors.Add(New Inspector())
                Next op
            Next epDisp
        Next chDisp
    End Sub

次のコード例は、アプリケーション構成ファイルを使用して、InspectorIDispatchMessageInspectorを挿入するサービス動作を読み込む方法を示しています。

<configuration>
  <system.serviceModel>
    <services>
      <service 
        name="Microsoft.WCF.Documentation.SampleService"
        behaviorConfiguration="metadataSupport">
        <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>
        <behavior name="metadataSupport">
          <serviceMetadata httpGetEnabled="true" httpGetUrl=""/>
          <serviceInterceptors />
        </behavior>
      </serviceBehaviors>
    </behaviors>
    <extensions>
      <behaviorExtensions>
        <add 
          name="serviceInterceptors" 
          type="Microsoft.WCF.Documentation.InspectorInserter, HostApplication, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null"
        />
      </behaviorExtensions>
    </extensions>
  </system.serviceModel>
</configuration>

注釈

要求メッセージを操作にディスパッチする前、または呼び出し元に応答メッセージを返す前に、受信または送信のアプリケーション メッセージを検査または変更する IDispatchMessageInspector を実装します。 送信先の操作を呼び出す前にメッセージをインターセプトする必要があるシナリオは多数あります。 たとえば、受信アプリケーション メッセージをログに記録したり、メッセージ ヘッダーに基づいて何らかの機能を実行したりできます。

通常、メッセージ インスペクターは、サービス動作 (System.ServiceModel.Description.IServiceBehavior)、エンドポイント動作 (System.ServiceModel.Description.IEndpointBehavior)、またはコントラクト動作 (System.ServiceModel.Description.IContractBehavior) によって挿入されます。 その後、この動作により、メッセージ インスペクターが DispatchRuntime.MessageInspectors コレクションに追加されます。 動作を使用してランタイムを拡張する方法の詳細については、「 ServiceHost の拡張とサービス モデル レイヤーのを参照してください。

• AfterReceiveRequest メソッドは、メッセージを受信した後、目的の操作にディスパッチする前にカスタム動作を有効にします。

• BeforeSendReply メソッドは、操作が戻った後、応答が送信される前にカスタム動作を有効にします。

手記

IDispatchMessageInspector オブジェクトは、操作が一方向か要求応答かに関係なく、メッセージのディスパッチ中に常に同じ時点で呼び出されます。

メソッド

AfterReceiveRequest(Message, IClientChannel, InstanceContext)	受信メッセージを受信した後、メッセージが目的の操作にディスパッチされる前に呼び出されます。
BeforeSendReply(Message, Object)	操作が返された後、応答メッセージが送信される前に呼び出されます。