0 out of 1 rated this helpful - Rate this topic

OperationBehaviorAttribute Class

Specifies the local execution behavior of a service method.

System.Object
  System.Attribute
    System.ServiceModel.OperationBehaviorAttribute

Namespace:  System.ServiceModel
Assembly:  System.ServiceModel (in System.ServiceModel.dll)
[AttributeUsageAttribute(AttributeTargets.Method)]
public sealed class OperationBehaviorAttribute : Attribute, 
	IOperationBehavior

The OperationBehaviorAttribute type exposes the following members.

  NameDescription
Public methodOperationBehaviorAttributeInitializes a new instance of the OperationBehaviorAttribute class.
Top
  NameDescription
Public propertyAutoDisposeParametersGets or sets whether parameters are to be automatically disposed.
Public propertyImpersonationGets or sets a value that indicates the level of caller impersonation that the operation supports.
Public propertyReleaseInstanceModeGets or sets a value that indicates when in the course of an operation invocation to recycle the service object.
Public propertyTransactionAutoCompleteGets or sets a value that indicates whether to automatically complete the current transaction scope if no unhandled exceptions occur.
Public propertyTransactionScopeRequiredGets or sets a value that indicates whether the method requires a transaction scope for its execution.
Public propertyTypeIdWhen implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.)
Top
  NameDescription
Public methodEqualsInfrastructure. Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeReturns the hash code for this instance. (Inherited from Attribute.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodIsDefaultAttributeWhen overridden in a derived class, indicates whether the value of this instance is the default value for the derived class. (Inherited from Attribute.)
Public methodMatchWhen overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top
  NameDescription
Explicit interface implemetationPrivate method_Attribute.GetIDsOfNamesMaps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute.)
Explicit interface implemetationPrivate method_Attribute.GetTypeInfoRetrieves the type information for an object, which can be used to get the type information for an interface. (Inherited from Attribute.)
Explicit interface implemetationPrivate method_Attribute.GetTypeInfoCountRetrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute.)
Explicit interface implemetationPrivate method_Attribute.InvokeProvides access to properties and methods exposed by an object. (Inherited from Attribute.)
Explicit interface implemetationPrivate methodIOperationBehavior.AddBindingParametersImplements the AddBindingParameters method.
Explicit interface implemetationPrivate methodIOperationBehavior.ApplyClientBehaviorImplements the client operation behavior.
Explicit interface implemetationPrivate methodIOperationBehavior.ApplyDispatchBehaviorImplements the service operation behavior.
Explicit interface implemetationPrivate methodIOperationBehavior.ValidateImplements the validation behavior.
Top

Use the OperationBehaviorAttribute attribute to indicate what operation-specific execution behavior the operation has when executed. (To specify execution behavior at the service level, use the ServiceBehaviorAttribute attribute.)

NoteNote

You can also use OperationBehaviorAttribute to configure a callback contract operation in a duplex client application. When used on a callback operation, the ReleaseInstanceMode property must be None or an InvalidOperationException exception is thrown at runtime.

The OperationBehaviorAttribute attribute is a programming model feature that enables common features that developers otherwise must implement themselves.

  • The AutoDisposeParameters property controls whether parameter objects passed to an operation are disposed when the operation completes.

  • The TransactionAutoComplete property specifies whether the transaction in which the method executes is automatically committed if no unhandled exceptions occur.

  • The TransactionScopeRequired property specifies whether a method must execute within a transaction.

  • The Impersonation property specifies whether the service operation can, must, or cannot impersonate the caller's identity.

  • The ReleaseInstanceMode property specifies when service objects are recycled during the method invocation process.

The following code example shows an operation that executes within a mandatory distributed transaction. The TransactionScopeRequired property indicates that the method executes under the caller's transaction and the TransactionAutoComplete property indicates that if no unhandled exceptions occur, the transaction commits automatically. If an unhandled exception does occur, the transaction is aborted.


using System;
using System.ServiceModel;
using System.Transactions;

namespace Microsoft.WCF.Documentation
{
  [ServiceContract(Namespace="http://microsoft.wcf.documentation", SessionMode=SessionMode.Required)]
  public interface IBehaviorService
  {
    [OperationContract]
    string TxWork(string message);
  }

  // Note: To use the TransactionIsolationLevel property, you 
  // must add a reference to the System.Transactions.dll assembly.
  /* The following service implementation:
   *   -- Processes messages on one thread at a time
   *   -- Creates one service object per session
   *   -- Releases the service object when the transaction commits
   */
  [ServiceBehavior(
    ConcurrencyMode=ConcurrencyMode.Single,
    InstanceContextMode=InstanceContextMode.PerSession,
    ReleaseServiceInstanceOnTransactionComplete=true
  )]
  public class BehaviorService : IBehaviorService, IDisposable
  {
    Guid myID;

    public BehaviorService()
    {
      myID = Guid.NewGuid();
      Console.WriteLine(
        "Object "
        + myID.ToString()
        + " created.");
    }

    /*
     * The following operation-level behaviors are specified:
     *   -- Always executes under a transaction scope.
     *   -- The transaction scope is completed when the operation terminates 
     *       without an unhandled exception.
     */
    [OperationBehavior(
      TransactionAutoComplete = true,
      TransactionScopeRequired = true
    )]
    [TransactionFlow(TransactionFlowOption.Mandatory)]
    public string TxWork(string message)
    {
      // Do some transactable work.
      Console.WriteLine("TxWork called with: " + message);
      // Display transaction information.

      TransactionInformation info = Transaction.Current.TransactionInformation;
      Console.WriteLine("The distributed tx ID: {0}.", info.DistributedIdentifier);
      Console.WriteLine("The tx status: {0}.", info.Status);
      return String.Format("Hello. This was object {0}.",myID.ToString()) ;
    }

    public void Dispose()
    {
      Console.WriteLine(
        "Service "
        + myID.ToString()
        + " is being recycled."
      );
    }
  }
}


.NET Framework

Supported in: 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.