OperationContractAttribute Klas

Definitie

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

Overname

Object

Attribute

OperationContractAttribute

Kenmerken

AttributeUsageAttribute

Voorbeelden

In het volgende codevoorbeeld ziet u een eenvoudig servicecontract met één bewerking.

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

Het volgende voorbeeld is een service waarmee een impliciet servicecontract wordt geïmplementeerd waarmee drie bewerkingen worden opgegeven. Twee van de bewerkingen zijn tweerichtingsbewerkingen, die onderliggende antwoordberichten retourneren aan de aanroeper, ongeacht wat de retourwaarde is. De derde bewerking ontvangt een aanroep, een onderliggend binnenkomend bericht, maar retourneert geen onderliggend antwoordbericht.

[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;
  }
}

Opmerkingen

Pas de OperationContractAttribute methode toe op een methode om aan te geven dat de methode een servicebewerking implementeert als onderdeel van een servicecontract (opgegeven door een ServiceContractAttribute kenmerk).

Gebruik de OperationContractAttribute eigenschappen om de structuur van de bewerking en de waarden in metagegevens te beheren:

• De Action eigenschap geeft de actie op die deze bewerking uniek identificeert. WCF verzendt aanvraagberichten naar methoden op basis van hun actie.

• De AsyncPattern eigenschap geeft aan dat de bewerking is geïmplementeerd of asynchroon kan worden aangeroepen met behulp van een begin-/eindmethodepaar.

• De HasProtectionLevel eigenschap geeft aan of de ProtectionLevel eigenschap expliciet is ingesteld.

• De IsOneWay eigenschap geeft aan dat de bewerking slechts uit één invoerbericht bestaat. De bewerking heeft geen gekoppeld uitvoerbericht.

• De IsInitiating eigenschap geeft aan of deze bewerking de eerste bewerking in een sessie kan zijn.

• De IsTerminating eigenschap geeft aan of WCF de huidige sessie probeert te beëindigen nadat de bewerking is voltooid.

• De ProtectionLevel eigenschap geeft de beveiliging op berichtniveau op die een bewerking tijdens runtime vereist.

• De ReplyAction eigenschap geeft de actie van het antwoordbericht voor de bewerking op.

Het OperationContractAttribute kenmerk declareert dat een methode een bewerking in een servicecontract is. Alleen methoden die aan de OperationContractAttribute methode zijn toegewezen, worden weergegeven als servicebewerkingen. Een servicecontract zonder methoden die zijn gemarkeerd met de OperationContractAttribute methoden waarmee geen bewerkingen worden uitgevoerd.

De AsyncPattern eigenschap geeft aan dat een paar Begin<methodName> - en End<methodName-methoden> één bewerking vormen die asynchroon is geïmplementeerd (op de client of de service). De mogelijkheid van een service om bewerkingen asynchroon te implementeren, is een details van de serviceimplementatie en wordt niet weergegeven in metagegevens (zoals WSDL (Web Services Description Language).

Clients kunnen er ook voor kiezen om bewerkingen asynchroon aan te roepen, onafhankelijk van hoe de servicemethode wordt geïmplementeerd. Het aanroepen van servicebewerkingen asynchroon in de client wordt aanbevolen wanneer een servicemethode enige tijd in beslag neemt, maar gegevens rechtstreeks naar de client moet retourneren. Zie AsyncPatternvoor meer informatie.

De IsOneWay eigenschap geeft aan dat een methode helemaal geen waarde retourneert, inclusief een leeg onderliggend antwoordbericht. Dit type methode is handig voor meldingen of communicatie in gebeurtenisstijl. Methoden van dit type kunnen geen antwoordbericht retourneren, zodat de declaratie van de methode moet worden geretourneerd void.

De Action en ReplyAction eigenschappen kunnen niet alleen worden gebruikt om de standaardactie van SOAP-berichten te wijzigen, maar ook om handlers te maken voor niet-herkende berichten of om het toevoegen van acties voor het programmeren van direct berichten uit te schakelen. Gebruik de IsInitiating eigenschap om te voorkomen dat clients een bepaalde servicebewerking aanroepen voorafgaand aan andere bewerkingen. Gebruik de IsTerminating eigenschap om WCF het kanaal te laten sluiten nadat clients een bepaalde servicebewerking hebben aangeroepen. Zie Sessies gebruiken voor meer informatie.

Met de ProtectionLevel eigenschap kunt u in het bewerkingscontract opgeven of de bewerkingsberichten zijn ondertekend, versleuteld of ondertekend en versleuteld. Als een binding het beveiligingsniveau dat door het contract is vereist, niet kan worden opgegeven, wordt er tijdens runtime een uitzondering gegenereerd. Zie en Understanding Protection Level (Beveiligingsniveau) voor meer informatieProtectionLevel.