IServiceBehavior インターフェイス

リファレンス

定義

名前空間:: System.ServiceModel.Description

アセンブリ:: System.ServiceModel.dll

重要

一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。

ServiceHostBase などの、サービス全体にわたるカスタム拡張機能を変更または挿入するための機構を提供します。

public interface class IServiceBehavior

public interface IServiceBehavior

type IServiceBehavior = interface

Public Interface IServiceBehavior

派生: System.ServiceModel.Activation.AspNetCompatibilityRequirementsAttribute

System.ServiceModel.Activities.Description.BufferedReceiveServiceBehavior

System.ServiceModel.Activities.Description.EtwTrackingBehavior

System.ServiceModel.Activities.Description.SqlWorkflowInstanceStoreBehavior

System.ServiceModel.Activities.Description.WorkflowIdleBehavior

その他…

例

構成ファイルで指定されたサービスの動作を使用してカスタムエラーハンドラーをサービスアプリケーションに挿入する方法を次のコード例に示します。この例では、エラーハンドラーがすべての例外をキャッチし、それらを GreetingFault SOAP カスタムエラーに変換してからクライアントに返します。

次の IServiceBehavior 実装は、バインディングパラメーターオブジェクトは追加せず、カスタムの System.ServiceModel.Dispatcher.IErrorHandler オブジェクトを各 ChannelDispatcher.ErrorHandlers プロパティに追加します。さらに、サービスの動作が適用され、System.ServiceModel.FaultContractAttribute 型の GreetingFault を持つサービスの各操作を検証します。

// This behavior modifies no binding parameters.
#region IServiceBehavior Members
public void AddBindingParameters(
  ServiceDescription description,
  ServiceHostBase serviceHostBase,
  System.Collections.ObjectModel.Collection<ServiceEndpoint> endpoints,
  System.ServiceModel.Channels.BindingParameterCollection parameters
)
{
  return;
}

// This behavior is an IErrorHandler implementation and
// must be applied to each ChannelDispatcher.
public void ApplyDispatchBehavior(ServiceDescription description, ServiceHostBase serviceHostBase)
{
  Console.WriteLine("The EnforceGreetingFaultBehavior has been applied.");
  foreach(ChannelDispatcher chanDisp in serviceHostBase.ChannelDispatchers)
  {
    chanDisp.ErrorHandlers.Add(this);
  }
}

// This behavior requires that the contract have a SOAP fault with a detail type of GreetingFault.
public void Validate(ServiceDescription description, ServiceHostBase serviceHostBase)
{
  Console.WriteLine("Validate is called.");
  foreach (ServiceEndpoint se in description.Endpoints)
  {
    // Must not examine any metadata endpoint.
    if (se.Contract.Name.Equals("IMetadataExchange")
      && se.Contract.Namespace.Equals("http://schemas.microsoft.com/2006/04/mex"))
      continue;
    foreach (OperationDescription opDesc in se.Contract.Operations)
    {
      if (opDesc.Faults.Count == 0)
        throw new InvalidOperationException(String.Format(
          "EnforceGreetingFaultBehavior requires a "
          + "FaultContractAttribute(typeof(GreetingFault)) in each operation contract.  "
          + "The \"{0}\" operation contains no FaultContractAttribute.",
          opDesc.Name)
        );
      bool gfExists = false;
      foreach (FaultDescription fault in opDesc.Faults)
      {
        if (fault.DetailType.Equals(typeof(GreetingFault)))
        {
          gfExists = true;
          continue;
        }
      }
      if (gfExists == false)
      {
        throw new InvalidOperationException(
"EnforceGreetingFaultBehavior requires a FaultContractAttribute(typeof(GreetingFault)) in an operation contract."
        );
      }
    }
  }
}
#endregion

' This behavior modifies no binding parameters.
#Region "IServiceBehavior Members"
Public Sub AddBindingParameters(ByVal description As ServiceDescription, ByVal serviceHostBase As ServiceHostBase, ByVal endpoints As System.Collections.ObjectModel.Collection(Of ServiceEndpoint), ByVal parameters As System.ServiceModel.Channels.BindingParameterCollection) Implements IServiceBehavior.AddBindingParameters
  Return
End Sub

' This behavior is an IErrorHandler implementation and 
' must be applied to each ChannelDispatcher.
Public Sub ApplyDispatchBehavior(ByVal description As ServiceDescription, ByVal serviceHostBase As ServiceHostBase) Implements IServiceBehavior.ApplyDispatchBehavior
  Console.WriteLine("The EnforceGreetingFaultBehavior has been applied.")
  For Each chanDisp As ChannelDispatcher In serviceHostBase.ChannelDispatchers
    chanDisp.ErrorHandlers.Add(Me)
  Next chanDisp
End Sub

' This behavior requires that the contract have a SOAP fault with a detail type of GreetingFault.
Public Sub Validate(ByVal description As ServiceDescription, ByVal serviceHostBase As ServiceHostBase) Implements IServiceBehavior.Validate
  Console.WriteLine("Validate is called.")
  For Each se As ServiceEndpoint In description.Endpoints
    ' Must not examine any metadata endpoint.
    If se.Contract.Name.Equals("IMetadataExchange") AndAlso se.Contract.Namespace.Equals("http://schemas.microsoft.com/2006/04/mex") Then
      Continue For
    End If
    For Each opDesc As OperationDescription In se.Contract.Operations
      If opDesc.Faults.Count = 0 Then
        Throw New InvalidOperationException(String.Format("EnforceGreetingFaultBehavior requires a " & "FaultContractAttribute(typeof(GreetingFault)) in each operation contract.  " & "The ""{0}"" operation contains no FaultContractAttribute.", opDesc.Name))
      End If
      Dim gfExists As Boolean = False
      For Each fault As FaultDescription In opDesc.Faults
        If fault.DetailType.Equals(GetType(GreetingFault)) Then
          gfExists = True
          Continue For
        End If
      Next fault
      If gfExists = False Then
        Throw New InvalidOperationException("EnforceGreetingFaultBehavior requires a FaultContractAttribute(typeof(GreetingFault)) in an operation contract.")
      End If
    Next opDesc
  Next se
End Sub
#End Region

この例では、動作クラスは、System.ServiceModel.Configuration.BehaviorExtensionElement も実装します。これで、次のコード例で示すように、サービス動作をアプリケーション構成ファイルで使用するよう挿入できます。

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

注釈

サービス全体にわたる実行の一部の側面を、アプリケーションレベルで変更、確認、または拡張するには、IServiceBehavior を実装します。

ApplyDispatchBehavior メソッドを使用して、ランタイムプロパティの値を変更し、エラーハンドラー、メッセージインターセプター、パラメーターインターセプター、セキュリティ拡張などのカスタム拡張オブジェクトを挿入できるようにします。
Validate Windows Communication Foundation (WCF) が実行中のサービスを構築する前に、メソッドを使用して説明を調べて、正しく実行できることを確認します。
AddBindingParameters メソッドを使用して、バインド要素にサービスのカスタム情報を渡し、バインド要素がサービスを正しくサポートできるようにします。

IServiceBehavior オブジェクトは、これらのメソッドをどれでも使用できますが、通常は、重要なメソッドは 1 つだけです。この場合、使用されないメソッドは、値なしで戻ることができます。

Note

すべての IServiceBehavior メソッドは System.ServiceModel.Description.ServiceDescription オブジェクトおよび System.ServiceModel.ServiceHostBase オブジェクトをパラメーターとして渡します。 ServiceDescription パラメーターは、検査にのみ使用されます。これらのオブジェクトを変更した場合、実行の動作は未定義になります。

想定されているカスタマイズタスクを実行するには、サービスランタイムの構築の前に、IServiceBehavior オブジェクトを Behaviors プロパティに追加しておく必要があります。これには 3 つの方法があります。

Behaviors メソッドが ICommunicationObject.Open オブジェクトで呼び出される前に、プログラムを使用して、System.ServiceModel.ServiceHost プロパティにサービスのカスタム動作を追加します。
IServiceBehavior を実装するカスタム属性を作成し、それを使用して、変更するサービスクラスをマークします。オブジェクトが ServiceHost 構築されると、WCF はリフレクションを使用してサービスの種類の属性を検出します。これらの属性のいずれかが IServiceBehavior を実装している場合、ServiceDescription の動作コレクションに追加されます。
System.ServiceModel.Configuration.BehaviorExtensionElement クラスを拡張して、アプリケーションまたはコンピューターの構成ファイルで動作を指定できるようにします。詳細については、「使用例」を参照してください。

WCF のサービス動作の例としてはServiceBehaviorAttribute、属性、、 System.ServiceModel.Description.ServiceThrottlingBehavior System.ServiceModel.Description.ServiceDebugBehavior 、およびの動作がありますSystem.ServiceModel.Description.ServiceMetadataBehavior。

メソッド

AddBindingParameters(ServiceDescription, ServiceHostBase, Collection<ServiceEndpoint>, BindingParameterCollection)	コントラクトの実装をサポートするカスタムデータをバインド要素に渡せるようにします。
ApplyDispatchBehavior(ServiceDescription, ServiceHostBase)	ランタイムプロパティの値を変更したり、エラーハンドラー、メッセージインターセプター、パラメーターインターセプター、セキュリティ拡張などのカスタム拡張オブジェクトを挿入したりできるようにします。
Validate(ServiceDescription, ServiceHostBase)	サービスホストおよびサービスの説明を検査して、サービスを正常に実行できることを確認できるようにします。

適用対象

次の方法で共有

IServiceBehavior インターフェイス

定義

例

注釈

メソッド

適用対象

その他のリソース