IContractBehavior Interface

Definição

Namespace:

System.ServiceModel.Description

Assembly:

System.ServiceModel.Primitives.dll

Assembly:

System.ServiceModel.dll

Implementa métodos que podem ser usados para estender o comportamento de tempo de execução de um contrato em um serviço ou aplicativo cliente.

public interface class IContractBehavior

public interface IContractBehavior

type IContractBehavior = interface

Public Interface IContractBehavior

Derivado

System.ServiceModel.Activities.Description.WorkflowContractBehaviorAttribute

System.ServiceModel.DeliveryRequirementsAttribute

System.ServiceModel.Description.ServiceMetadataContractBehavior

System.ServiceModel.Security.WSTrustServiceContract

System.ServiceModel.Web.JavascriptCallbackBehaviorAttribute

Exemplos

O exemplo de código a seguir pressupõe uma implementação personalizada IInstanceProvider chamada ObjectProviderBehavior que fornece um comportamento "singleton". Ele sempre retorna a mesma instância de serviço e não a recicla.

Para inserir a personalização do provedor de instância, o exemplo mostra como implementar um atributo personalizado (SingletonBehaviorAttribute) que implementa para inserir o provedor de instância de IContractBehavior serviço personalizado. Ele também implementa IContractBehaviorAttribute, o que associa seu uso ao ISampleService contrato.

public class SingletonBehaviorAttribute : Attribute, IContractBehaviorAttribute, IContractBehavior
{

  #region IContractBehaviorAttribute Members

  public Type TargetContract
  {
    get { return typeof(ISampleService); }
  }

  #endregion

  #region IContractBehavior Members

  public void AddBindingParameters(ContractDescription description, ServiceEndpoint endpoint, System.ServiceModel.Channels.BindingParameterCollection parameters)
  {
    return;
  }

  public void ApplyClientBehavior(ContractDescription description, ServiceEndpoint endpoint, ClientRuntime clientRuntime)
  {
    return;
  }

  public void ApplyDispatchBehavior(ContractDescription description, ServiceEndpoint endpoint, DispatchRuntime dispatch)
  {
    dispatch.InstanceProvider = new ObjectProviderBehavior("Custom ObjectProviderBehavior constructor.");
  }

  public void Validate(ContractDescription description, ServiceEndpoint endpoint)
  {
    return;
  }

  #endregion
}

Public Class SingletonBehaviorAttribute
    Inherits Attribute
    Implements IContractBehaviorAttribute, IContractBehavior

  #Region "IContractBehaviorAttribute Members"

  Public ReadOnly Property TargetContract() As Type Implements IContractBehaviorAttribute.TargetContract
    Get
        Return GetType(ISampleService)
    End Get
  End Property

  #End Region

  #Region "IContractBehavior Members"

  Public Sub AddBindingParameters(ByVal description As ContractDescription, ByVal endpoint As ServiceEndpoint, ByVal parameters As System.ServiceModel.Channels.BindingParameterCollection) Implements IContractBehavior.AddBindingParameters
    Return
  End Sub

  Public Sub ApplyClientBehavior(ByVal description As ContractDescription, ByVal endpoint As ServiceEndpoint, ByVal clientRuntime As ClientRuntime) Implements IContractBehavior.ApplyClientBehavior
    Return
  End Sub

  Public Sub ApplyDispatchBehavior(ByVal description As ContractDescription, ByVal endpoint As ServiceEndpoint, ByVal dispatch As DispatchRuntime) Implements IContractBehavior.ApplyDispatchBehavior
    dispatch.InstanceProvider = New ObjectProviderBehavior("Custom ObjectProviderBehavior constructor.")
  End Sub

  Public Sub Validate(ByVal description As ContractDescription, ByVal endpoint As ServiceEndpoint) Implements IContractBehavior.Validate
    Return
  End Sub

  #End Region
End Class

Comentários

Implemente a IContractBehavior interface para modificar, examinar ou estender algum aspecto da execução em todo o contrato no nível do aplicativo. Ao contrário dos IServiceBehavior objetos e IEndpointBehavior objetos, IContractBehavior os objetos não podem ser adicionados ao runtime usando um arquivo de configuração de aplicativo; eles só podem ser adicionados programaticamente ou usando um atributo.

Para obter mais informações sobre como escolher entre comportamentos de serviço, ponto de extremidade e contrato, consulte Configurar e estender o runtime com comportamentos.

• Use o AddBindingParameters método para fornecer elementos de associação com dados personalizados para dar suporte ao comportamento.

• Use o ApplyClientBehavior método para modificar, examinar ou inserir extensões em um contrato em um aplicativo cliente.

• Use o ApplyDispatchBehavior método para modificar, examinar ou inserir extensões em um contrato em um aplicativo de serviço.

• Use o Validate método para garantir que um contrato possa dar suporte a um recurso específico.

IContractBehavior os objetos podem usar qualquer um desses métodos, mas geralmente apenas um é importante; nesses casos, os métodos não utilizados podem retornar sem nenhum valor.

Observação

Todos os IContractBehavior métodos passam System.ServiceModel.Description.ContractDescription e System.ServiceModel.Description.ServiceEndpoint são parâmetros. Esses parâmetros são para exame; se você modificar os objetos, o comportamento de execução será indefinido.

IContractBehavior os tipos podem ser usados no serviço ou no cliente ou em ambos. Para executar uma tarefa de personalização no serviço, o IContractBehavior objeto deve ser adicionado à Behaviors propriedade antes da construção do runtime de serviço, que ocorre quando o ICommunicationObject.Open método é chamado no System.ServiceModel.ServiceHost objeto. Há duas maneiras de fazer isso.

O primeiro método é adicionar programaticamente o comportamento do contrato personalizado à Behaviors propriedade antes do ponto em que o ICommunicationObject.Open método é chamado no System.ServiceModel.ServiceHost objeto. Quando aplicado dessa forma, o comportamento é aplicado a todas as mensagens que fluem por meio desse contrato em qualquer ponto de extremidade.

Observação

O comportamento é aplicado a todos os contratos do mesmo tipo. Por exemplo, se você adicionar programaticamente o mesmo tipo de contrato a mais de um ponto de extremidade, o comportamento modificará todos os pontos de extremidade que se referem ao mesmo objeto de contrato.

O segundo método é criar um atributo personalizado que implementa IContractBehavior e aplica-o a:

• Uma interface de contrato. Nesse caso, o comportamento é aplicado a todos os contratos desse tipo em qualquer ponto de extremidade.

• Uma classe de serviço. Nesse caso, o comportamento é aplicado a todos os pontos de extremidade, independentemente do contrato.

• Uma classe de retorno de chamada. Nesse caso, o comportamento é aplicado ao ponto de extremidade do cliente duplex.

O comportamento da segunda abordagem varia ligeiramente se o atributo personalizado também implementa System.ServiceModel.Description.IContractBehaviorAttribute. Nesse caso, o comportamento é o seguinte:

• Uma interface de contrato. Nesse caso, o comportamento é aplicado a todos os contratos desse tipo em qualquer ponto de extremidade e Windows Communication Foundation (WCF) ignora o valor da IContractBehaviorAttribute.TargetContract propriedade.

• Uma classe de serviço. Nesse caso, o comportamento é aplicado somente aos pontos de extremidade do contrato do qual é o valor da IContractBehaviorAttribute.TargetContract propriedade.

• Uma classe de retorno de chamada. Nesse caso, o comportamento é aplicado ao ponto de extremidade do cliente duplex e o WCF ignora o valor da IContractBehaviorAttribute.TargetContract propriedade.

Para executar a tarefa de personalização no cliente para o qual se destina, o IContractBehavior objeto deve ser adicionado à Behaviors propriedade antes da construção do runtime do cliente, que ocorre quando ChannelFactory<TChannel>.CreateChannel é chamado. Há duas maneiras de fazer isso:

• Adicione programaticamente o comportamento do contrato personalizado à Behaviors propriedade antes do ponto em que a ChannelFactory<TChannel>.CreateChannel origem é chamada.

• Crie um atributo personalizado que também implemente IContractBehavior.

Para obter mais informações sobre como adicionar IContractBehavior tipos programaticamente ao cliente ou ao aplicativo de serviço, consulte Configurar e estender o runtime com comportamentos.

Métodos

AddBindingParameters(ContractDescription, ServiceEndpoint, BindingParameterCollection)	Configura quaisquer elementos de associação para dar suporte ao comportamento de contrato.
ApplyClientBehavior(ContractDescription, ServiceEndpoint, ClientRuntime)	Implementa uma modificação ou extensão do cliente em todo um contrato.
ApplyDispatchBehavior(ContractDescription, ServiceEndpoint, DispatchRuntime)	Implementa uma modificação ou extensão do cliente em todo um contrato.
Validate(ContractDescription, ServiceEndpoint)	Implemente para confirmar que o contrato e o ponto de extremidade são compatíveis com o comportamento de contrato.