IServiceBehavior Интерфейс

Ссылка

Определение

Пространство имен:: System.ServiceModel.Description

Сборка:: System.ServiceModel.dll

Важно!

Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.

Предоставляет механизм для изменения или вставки настраиваемых расширений в целые службы, включая 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

Подробнее…

Примеры

В следующем образце кода показано использование расширений функциональности службы, заданных в файле конфигурации, для вставки настраиваемого обработчика ошибок в приложение службы. В данном примере обработчик ошибок выполняет перехват всех исключений и преобразование их в настраиваемые ошибки SOAP GreetingFault, которые затем возвращаются клиенту.

Следующая реализация 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>

Можно использовать метод ApplyDispatchBehavior для изменения значений свойства времени выполнения или для вставки объектов настраиваемых расширений, например, обработчиков ошибок, перехватчиков параметров или сообщений, а также других объектов настраиваемых расширений.
Validate Используйте метод для проверки описания, прежде чем Windows Communication Foundation (WCF) создает службу выполнения, чтобы убедиться, что она может выполняться правильно.
Метод AddBindingParameters используется для передачи в элемент привязки настраиваемых сведений для службы, чтобы обеспечить ее работу.

Объекты IServiceBehavior могут использовать любые из этих методов, но часто важен только один; в таких случаях неиспользуемые методы могут не возвращать никакого значения.

Примечание

Все методы IServiceBehavior передают в качестве параметра объекты System.ServiceModel.Description.ServiceDescription и System.ServiceModel.ServiceHostBase. Этот параметр используется только для проверки; при изменении объекта ServiceDescription, расширение функциональности выполнения не определено.

Чтобы выполнить настройку задачи, для которой предназначен этот параметр, необходимо добавить объект IServiceBehavior в свойство Behaviors перед построением среды выполнения службы. Это можно сделать тремя способами:

Программно добавить пользовательское расширение функциональности настраиваемой службы в свойство 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 Интерфейс

Определение

Примеры

Комментарии

Методы

Применяется к

Қосымша ресурстар