IDispatchMessageInspector Interface

Définition

Espace de noms:

System.ServiceModel.Dispatcher

Assembly:

System.ServiceModel.Primitives.dll

Assembly:

System.ServiceModel.dll

Définit les méthodes qui activent l'inspection ou la modification personnalisée de messages d'application entrants et sortants dans les applications de service.

public interface class IDispatchMessageInspector

public interface IDispatchMessageInspector

type IDispatchMessageInspector = interface

Public Interface IDispatchMessageInspector

Exemples

L'exemple de code suivant illustre un IDispatchMessageInspector de base qui écrit une chaîne à la console lorsqu'il est appelé.

#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

L’exemple de code suivant montre l’implémentation d’un IServiceBehavior élément qui ajoute la Inspector IDispatchMessageInspector DispatchRuntime.MessageInspectors collection.

#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

L’exemple de code suivant montre l’utilisation d’un fichier de configuration d’application pour charger le comportement du service qui insère le Inspector IDispatchMessageInspector.

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

Remarques

Implémentez IDispatchMessageInspector pour inspecter ou modifier des messages d'application entrants ou sortants, soit avant de distribuer un message de demande à une opération, soit avant de retourner un message de réponse à un appelant. Il existe un grand nombre de scénarios qui requièrent l'interception des messages avant d'appeler l'opération à laquelle ils sont destinés. Par exemple, vous pouvez enregistrer des messages d’application entrants ou exécuter une fonctionnalité basée sur un en-tête de message.

En général, les inspecteurs de message sont insérés par un comportement de service (System.ServiceModel.Description.IServiceBehavior), un comportement de point de terminaison (System.ServiceModel.Description.IEndpointBehavior) ou un comportement de contrat (System.ServiceModel.Description.IContractBehavior). Le comportement ajoute ensuite l'inspecteur de message à la collection DispatchRuntime.MessageInspectors. Pour plus d’informations sur l’extension du runtime à l’aide de comportements, consultez Extension de ServiceHost et de la couche de modèle de service.

• La méthode AfterReceiveRequest active le comportement personnalisé après la réception du message mais avant sa distribution à l'opération prévue.

• La méthode BeforeSendReply active le comportement personnalisé une fois que l'opération retourne mais avant que la réponse soit envoyée.

Notes

Les objets IDispatchMessageInspector sont toujours appelés au même moment au cours de la distribution du message, que l'opération soit unidirectionnelle ou demande/réponse.

Méthodes

AfterReceiveRequest(Message, IClientChannel, InstanceContext)	Appelé après la réception d'un message mais avant que le message soit distribué à l'opération prévue.
BeforeSendReply(Message, Object)	Appelé après le retour de l'opération mais avant que le message de réponse soit envoyé.