OperationContractAttribute Classe

Definição

public ref class OperationContractAttribute sealed : Attribute

[System.AttributeUsage(System.AttributeTargets.Method)]
public sealed class OperationContractAttribute : Attribute

[<System.AttributeUsage(System.AttributeTargets.Method)>]
type OperationContractAttribute = class
    inherit Attribute

Public NotInheritable Class OperationContractAttribute
Inherits Attribute

Herança

Object

Attribute

OperationContractAttribute

Atributos

AttributeUsageAttribute

Exemplos

O exemplo de código a seguir mostra um contrato de serviço simples com uma operação.

using System;
using System.Collections.Generic;
using System.Net.Security;
using System.ServiceModel;
using System.Text;

namespace Microsoft.WCF.Documentation
{
  [ServiceContract(Namespace="Microsoft.WCF.Documentation")]
  public interface ISampleService{
    // This operation specifies an explicit protection level requirement.
    [OperationContract(ProtectionLevel=ProtectionLevel.EncryptAndSign)]
    string SampleMethod(string msg);
  }

  class SampleService : ISampleService
  {
  #region ISampleService Members

  public string  SampleMethod(string msg)
  {
    Console.WriteLine("Called with: {0}", msg);
      return "The service greets you: " + msg;
  }

  #endregion
  }
}

Imports System.Net.Security
Imports System.ServiceModel
Imports System.Text

Namespace Microsoft.WCF.Documentation
  <ServiceContract(Namespace:="Microsoft.WCF.Documentation")> _
  Public Interface ISampleService
    ' This operation specifies an explicit protection level requirement.
    <OperationContract(ProtectionLevel:=ProtectionLevel.EncryptAndSign)> _
    Function SampleMethod(ByVal msg As String) As String
  End Interface

  Friend Class SampleService
      Implements ISampleService
  #Region "ISampleService Members"

  Public Function SampleMethod(ByVal msg As String) As String Implements ISampleService.SampleMethod
    Console.WriteLine("Called with: {0}", msg)
       Return "The service greets you: " & msg
  End Function

  #End Region
  End Class
End Namespace

O exemplo a seguir é um serviço que implementa um contrato de serviço implícito que especifica três operações. Duas das operações são operações bidirecionais, que retornam mensagens de resposta subjacentes ao chamador, independentemente do valor retornado. A terceira operação recebe uma chamada, uma mensagem de entrada subjacente, mas não retorna nenhuma mensagem de resposta subjacente.

[ServiceContractAttribute]  
public class OneAndTwoWay  
{  
  // The client waits until a response message appears.  
  [OperationContractAttribute]  
  public int MethodOne (int x, out int y)  
  {  
    y = 34;  
    return 0;  
  }  

  // The client waits until an empty response message appears.  
  [OperationContractAttribute]  
  public void MethodTwo (int x)  
  {  
    return;  
  }  

  // The client returns as soon as an outbound message  
  // is dispatched to the service; no response  
  // message is generated or sent from the service.  
  [OperationContractAttribute(IsOneWay=true)]  
  public void MethodThree (int x)  
  {  
    return;  
  }  
}  

Comentários

Aplique o OperationContractAttribute método a um método para indicar que o método implementa uma operação de serviço como parte de um contrato de serviço (especificado por um ServiceContractAttribute atributo).

Use as OperationContractAttribute propriedades para controlar a estrutura da operação e os valores expressos em metadados:

• A Action propriedade especifica a ação que identifica exclusivamente essa operação. O WCF envia mensagens de solicitação para métodos com base em sua ação.

• A AsyncPattern propriedade indica que a operação é implementada ou pode ser chamada de forma assíncrona usando um par de métodos Begin/End.

• A HasProtectionLevel propriedade indica se a ProtectionLevel propriedade foi definida explicitamente.

• A IsOneWay propriedade indica que a operação consiste apenas em uma única mensagem de entrada. A operação não tem nenhuma mensagem de saída associada.

• A IsInitiating propriedade especifica se essa operação pode ser a operação inicial em uma sessão.

• A IsTerminating propriedade especifica se o WCF tenta encerrar a sessão atual após a conclusão da operação.

• A ProtectionLevel propriedade especifica a segurança no nível da mensagem que uma operação requer em tempo de execução.

• A ReplyAction propriedade especifica a ação da mensagem de resposta para a operação.

O OperationContractAttribute atributo declara que um método é uma operação em um contrato de serviço. Somente os métodos atribuídos com os OperationContractAttribute são expostos como operações de serviço. Um contrato de serviço sem métodos marcados com as OperationContractAttribute operações não expõe.

A AsyncPattern propriedade indica que um par de Begin<methodName> métodos e End<methodName> um par formam uma única operação implementada de forma assíncrona (seja no cliente ou no serviço). A capacidade de um serviço de implementar operações de forma assíncrona é um detalhe de implementação de serviço e não é exposta em metadados (como WSDL (Linguagem de Descrição de Serviços Web)).

Da mesma forma, os clientes podem optar por invocar operações de forma assíncrona independente de como o método de serviço é implementado. Chamar operações de serviço de forma assíncrona no cliente é recomendado quando um método de serviço leva algum tempo, mas deve retornar informações diretamente ao cliente. Para obter detalhes, consulte AsyncPattern.

A IsOneWay propriedade indica que um método não retorna nenhum valor, incluindo uma mensagem de resposta subjacente vazia. Esse tipo de método é útil para notificações ou comunicação no estilo de evento. Métodos desse tipo não podem retornar uma mensagem de resposta, portanto, a declaração do método deve retornar void.

As Action propriedades e ReplyAction as propriedades podem ser usadas não apenas para modificar a ação padrão das mensagens SOAP, mas também para criar manipuladores para mensagens não reconhecidas ou para desabilitar a adição de ações para programação de mensagens diretas. Use a IsInitiating propriedade para impedir que os clientes chamem uma determinada operação de serviço antes de outras operações. Use a IsTerminating propriedade para que o WCF feche o canal depois que os clientes chamarem uma operação de serviço específica. Para obter mais informações, consulte Como usar sessões.

A ProtectionLevel propriedade permite que você especifique no contrato de operação se as mensagens de operação são assinadas, criptografadas ou assinadas e criptografadas. Se uma associação não puder fornecer o nível de segurança exigido pelo contrato, uma exceção será lançada em tempo de execução. Para obter mais informações, consulte ProtectionLevel e noções básicas sobre o nível de proteção.

Construtores

Propriedades

Métodos

Implantações explícitas de interface

Aplica-se a