IEndpointBehavior インターフェイス

定義

名前空間:

System.ServiceModel.Description

アセンブリ:

System.ServiceModel.Primitives.dll

パッケージ:

System.ServiceModel.Primitives v6.2.0

Source:

IEndpointBehavior.cs

サービスまたはクライアント アプリケーションでエンドポイントのランタイム動作を拡張するために使用できるメソッドを実装します。

public interface class IEndpointBehavior

public interface IEndpointBehavior

type IEndpointBehavior = interface

Public Interface IEndpointBehavior

派生

System.ServiceModel.CallbackBehaviorAttribute

System.ServiceModel.Description.CallbackDebugBehavior

System.ServiceModel.Description.ClientCredentials

System.ServiceModel.Description.ClientViaBehavior

System.ServiceModel.Description.DispatcherSynchronizationBehavior

System.ServiceModel.Description.MustUnderstandBehavior

System.ServiceModel.Description.SynchronousReceiveBehavior

System.ServiceModel.Description.TransactedBatchingBehavior

System.ServiceModel.Description.WebHttpBehavior

System.ServiceModel.Discovery.EndpointDiscoveryBehavior

System.ServiceModel.Routing.SoapProcessingBehavior

例

サービス アプリケーションで System.ServiceModel.Dispatcher.IDispatchMessageInspector オブジェクトを追加するエンドポイント動作の実装を次のコード例に示します。 この場合、EndpointBehaviorMessageInspector クラスは、受信および送信メッセージを調べるための System.ServiceModel.Dispatcher.IDispatchMessageInspector、動作が適用されるすべてのエンドポイントの検査システムにインスペクター クラスを挿入するための IEndpointBehavior インターフェイス、およびアプリケーション構成ファイルを使用してメッセージ インスペクターの動作ができるようにするための System.ServiceModel.Configuration.BehaviorExtensionElement を実装します。

最初にメッセージ インスペクターを実装します。

// IDispatchMessageInspector Members

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

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

メッセージ インスペクターを ApplyDispatchBehavior プロパティに追加する DispatchRuntime.MessageInspectors メソッドの使用法を次のコード例に示します。

// IEndpointBehavior Members
public void AddBindingParameters(ServiceEndpoint serviceEndpoint, System.ServiceModel.Channels.BindingParameterCollection bindingParameters)
{
  return;
}

public void ApplyClientBehavior(ServiceEndpoint serviceEndpoint, ClientRuntime behavior)
{
  behavior.MessageInspectors.Add(new EndpointBehaviorMessageInspector());
}

public void ApplyDispatchBehavior(ServiceEndpoint serviceEndpoint, EndpointDispatcher endpointDispatcher)
{
  endpointDispatcher.DispatchRuntime.MessageInspectors.Add(new EndpointBehaviorMessageInspector());
}

public void Validate(ServiceEndpoint serviceEndpoint)
{
  return;
}

構成ファイルからメッセージ インスペクター動作を使用できるようにするための System.ServiceModel.Configuration.BehaviorExtensionElement の実装を次のコード例に示します。

// BehaviorExtensionElement members
public override Type BehaviorType
{
  get { return typeof(EndpointBehaviorMessageInspector); }
}

protected override object CreateBehavior()
{
  return new EndpointBehaviorMessageInspector();
}

最後に、前の例を構成から使用できるようにする方法を次の構成ファイルに示します。

<configuration>
  <system.serviceModel>
    <services>
      <service 
        name="Microsoft.WCF.Documentation.SampleService"
        behaviorConfiguration="metadataSupport"
      >
        <host>
          <baseAddresses>
            <add baseAddress="http://localhost:8080/ServiceMetadata" />
          </baseAddresses>
        </host>
        <endpoint
          address="/SampleService"
          binding="wsHttpBinding"
          behaviorConfiguration="withMessageInspector" 
          contract="Microsoft.WCF.Documentation.ISampleService"
        />
        <endpoint
           address="mex"
           binding="mexHttpBinding"
           contract="IMetadataExchange"
        />
      </service>
    </services>
    <behaviors>
      <serviceBehaviors>
      <behavior name="metadataSupport">
        <serviceMetadata httpGetEnabled="true" httpGetUrl=""/>
      </behavior>
      </serviceBehaviors>
      <endpointBehaviors>
        <behavior name="withMessageInspector">
          <endpointMessageInspector />
        </behavior>
      </endpointBehaviors>
    </behaviors>
    <extensions>
      <behaviorExtensions>
        <add 
          name="endpointMessageInspector"
          type="Microsoft.WCF.Documentation.EndpointBehaviorMessageInspector, HostApplication, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null"
        />
      </behaviorExtensions>
    </extensions>
  </system.serviceModel>
</configuration>

注釈

クライアントまたはサービス アプリケーションのいずれかで、エンドポイント全体にわたる実行の一部の側面をアプリケーション レベルで変更、確認、または拡張するには、IEndpointBehavior インターフェイスを実装します。

• AddBindingParameters メソッドを使用して、実行時にカスタム データを渡して、バインディングがカスタム動作をサポートできるようにします。

• ApplyClientBehavior メソッドを使用して、クライアント アプリケーションでエンドポイントを変更または確認したり、エンドポイントに拡張機能を挿入したりできます。

• ApplyDispatchBehavior メソッドを使用して、サービス アプリケーションでエンドポイント全体にわたる実行を変更または確認し、エンドポイント全体にわたる実行に拡張機能を挿入できます。

• Validate メソッドを使用して、ServiceEndpoint が特定の要件を満たしていることを確認します。 このメソッドを使用して、エンドポイントで特定の構成設定が有効になっているかどうか、エンドポイントが特定の機能をサポートしているかどうかなどの要件を確認できます。

IEndpointBehavior オブジェクトはこれらのメソッドのいずれかを使用できますが、多くの場合、重要なのは 1 つだけです。このような場合、未使用のメソッドは アクションを実行せず、 を返すことができます。

注意

すべての IEndpointBehavior メソッドは ServiceEndpoint オブジェクトをパラメーターとして渡します。 このパラメーターは、検査にのみ使用されます。ServiceEndpoint オブジェクトを変更した場合、実行の動作は未定義になります。

IEndpointBehavior オブジェクトは通常、サービス アプリケーションの System.ServiceModel.Dispatcher.DispatchRuntime、System.ServiceModel.Dispatcher.DispatchOperation、System.ServiceModel.Dispatcher.EndpointDispatcher、System.ServiceModel.Dispatcher.ChannelDispatcher の各オブジェクト、および、クライアント アプリケーションの System.ServiceModel.Dispatcher.ClientRuntime と System.ServiceModel.Dispatcher.ClientOperation のさまざまなプロパティにアクセスするために使用します。 また、ClientRuntime.CallbackDispatchRuntime プロパティと DispatchRuntime.CallbackClientRuntime プロパティをそれぞれ使用して、双方向クライアントと双方向サービスのプロパティにアクセスすることもできます。

使用できるさまざまなプロパティとカスタマイズの詳細については、「 Extending ServiceHost and the Service Model Layer」を参照してください。

カスタマイズが決定され (必要に応じてカスタマイズ インターフェイスが実装されます) IEndpointBehavior 、 がカスタマイズの適切なスコープであることが決定されたら、エンドポイントの動作を実装 IEndpointBehavior してランタイムに追加することで、カスタマイズを Windows Communication Foundation (WCF) ランタイムに挿入する必要があります。

ランタイムに動作を追加するには、2 つの方法があります。

• サービス ホスト (サービス アプリケーションの場合) またはチャネル ファクトリ (クライアント アプリケーションの場合) を開く前に、プログラムを使用して、Behaviors プロパティにエンドポイントのカスタム動作を追加します。

• アプリケーション構成ファイルを使用して動作を構成します。 詳細については、「behaviorExtensions>」を参照してください<。

想定されているサービス カスタマイズ タスクを実行するには、IEndpointBehavior メソッドが ServiceEndpoint.Behaviors で呼び出されるときに行われるサービス ランタイムの構築の前に、ICommunicationObject.Open オブジェクトを System.ServiceModel.ServiceHost プロパティに追加しておく必要があります。 クライアント カスタマイズ タスクを実行するには、IEndpointBehavior で ServiceEndpoint.Behaviors メソッドまたは ChannelFactory<TChannel>.CreateChannel メソッドを呼び出す前に、ICommunicationObject.Open オブジェクトを ChannelFactory<TChannel> プロパティに追加しておく必要があります。

メソッド

AddBindingParameters(ServiceEndpoint, BindingParameterCollection)	実行時にバインディングにデータを渡して、バインディングがカスタム動作をサポートできるようにするために実装します。
ApplyClientBehavior(ServiceEndpoint, ClientRuntime)	エンドポイント全体にわたってクライアントの変更または拡張を実装します。
ApplyDispatchBehavior(ServiceEndpoint, EndpointDispatcher)	エンドポイント全体にわたってサービスの変更または拡張を実装します。
Validate(ServiceEndpoint)	エンドポイントが指定した基準を満たしていることを確認するために実装します。