OperationContractAttribute Klass

Definition

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

Arv

Object

Attribute

OperationContractAttribute

Attribut

AttributeUsageAttribute

Exempel

I följande kodexempel visas ett enkelt tjänstkontrakt med en åtgärd.

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

Följande exempel är en tjänst som implementerar ett implicit tjänstkontrakt som anger tre åtgärder. Två av åtgärderna är dubbelriktade åtgärder som returnerar underliggande svarsmeddelanden till anroparen oavsett vilket returvärde som är. Den tredje åtgärden tar emot ett anrop, ett underliggande inkommande meddelande, men returnerar inget underliggande svarsmeddelande.

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

Kommentarer

OperationContractAttribute Använd på en metod för att ange att metoden implementerar en tjänståtgärd som en del av ett tjänstkontrakt (som anges av ett ServiceContractAttribute attribut).

OperationContractAttribute Använd egenskaperna för att styra åtgärdens struktur och de värden som uttrycks i metadata:

• Egenskapen Action anger den åtgärd som unikt identifierar den här åtgärden. WCF skickar begärandemeddelanden till metoder baserat på deras åtgärd.

• Egenskapen AsyncPattern anger att åtgärden implementeras eller kan anropas asynkront med hjälp av ett Begin/End-metodpar.

• Egenskapen HasProtectionLevel anger om egenskapen uttryckligen ProtectionLevel har angetts.

• Egenskapen IsOneWay anger att åtgärden endast består av ett enda indatameddelande. Åtgärden har inget associerat utdatameddelande.

• Egenskapen IsInitiating anger om den här åtgärden kan vara den första åtgärden i en session.

• Egenskapen IsTerminating anger om WCF försöker avsluta den aktuella sessionen när åtgärden har slutförts.

• Egenskapen ProtectionLevel anger den säkerhet på meddelandenivå som en åtgärd kräver vid körning.

• Egenskapen ReplyAction anger åtgärden för svarsmeddelandet för åtgärden.

Attributet OperationContractAttribute deklarerar att en metod är en åtgärd i ett tjänstkontrakt. Endast metoder som tillskrivs OperationContractAttribute är exponerade som tjänståtgärder. Ett tjänstkontrakt utan några metoder som markerats med exponerar OperationContractAttribute inga åtgärder.

Egenskapen AsyncPattern anger att ett par Begin<methodName> - och End<methodName-metoder> utgör en enda åtgärd som implementeras asynkront (oavsett om det är på klienten eller tjänsten). Möjligheten för en tjänst att implementera åtgärder asynkront är en tjänstimplementeringsinformation och exponeras inte i metadata (till exempel Web Services Description Language (WSDL)).

På samma sätt kan klienter välja att anropa åtgärder asynkront oberoende av hur tjänstmetoden implementeras. Att anropa tjänståtgärder asynkront i klienten rekommenderas när en tjänstmetod tar lite tid men måste returnera information direkt till klienten. Mer information finns i AsyncPattern.

Egenskapen IsOneWay anger att en metod inte returnerar något värde alls, inklusive ett tomt underliggande svarsmeddelande. Den här typen av metod är användbar för meddelanden eller kommunikation i händelsestil. Metoder av den här typen kan inte returnera ett svarsmeddelande, så metodens deklaration måste returnera void.

Egenskaperna Action och ReplyAction kan användas inte bara för att ändra standardåtgärden för SOAP-meddelanden, utan även för att skapa hanterare för okända meddelanden eller för att inaktivera tilläggsåtgärder för direkt meddelandeprogrammering. Använd egenskapen IsInitiating för att förhindra att klienter anropar en viss tjänståtgärd före andra åtgärder. Använd egenskapen IsTerminating för att låta WCF stänga kanalen när klienter anropar en viss tjänståtgärd. Mer information finns i Använda sessioner.

Med ProtectionLevel egenskapen kan du ange i åtgärdskontraktet om åtgärdsmeddelandena är signerade, krypterade eller signerade och krypterade. Om en bindning inte kan tillhandahålla den säkerhetsnivå som krävs av kontraktet utlöses ett undantag vid körning. Mer information finns i ProtectionLevel och Förstå skyddsnivå.