OperationContractAttribute クラス

定義

名前空間:

System.ServiceModel

アセンブリ:

System.ServiceModel.Primitives.dll

パッケージ:

System.ServiceModel.Primitives v8.0.0

ソース:

OperationContractAttribute.cs

メソッドが、Windows Communication Foundation (WCF) アプリケーションのサービス コントラクトの一部である操作を定義することを示します。

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

継承

Object

Attribute

OperationContractAttribute

属性

AttributeUsageAttribute

例

次のコード例は、1 つの操作を持つ単純なサービスを示しています。

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

次の例は、3 つの操作を指定する暗黙のサービス コントラクトを実装するサービスです。 操作のうちの 2 つは双方向操作であり、戻り値の内容に関係なく、基になる応答メッセージを呼び出し元に返します。 3 つ目の操作は、呼び出しと基になる受信メッセージを受信しますが、基になる応答メッセージは返しません。

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

注釈

OperationContractAttribute をメソッドに適用して、そのメソッドが、サービス操作を (ServiceContractAttribute 属性によって指定される) サービス コントラクトの一部として実装することを示します。

OperationContractAttribute プロパティを使用して、操作の構造とメタデータ内に表現される値を制御します。

• Action プロパティは、この操作を一意に識別するアクションを指定します。 WCF は、アクションに基づいて要求メッセージをメソッドにディスパッチします。

• AsyncPattern プロパティは、この操作が、Begin/End メソッド ペアを使用して実装される、または非同期呼び出しが可能であることを示します。

• HasProtectionLevel プロパティは、ProtectionLevel プロパティが明示的に設定されているかどうかを示します。

• IsOneWay プロパティは、この操作が、単一の入力メッセージのみで構成されることを示します。 この操作には、関連付けられた出力メッセージがありません。

• IsInitiating プロパティは、この操作が、セッションの最初の操作になることができるかどうかを指定します。

• プロパティは IsTerminating 、操作の完了後に WCF が現在のセッションを終了するかどうかを指定します。

• ProtectionLevel プロパティは、操作が実行時に必要とするメッセージ レベルのセキュリティを指定します。

• ReplyAction プロパティは、この操作に対する応答メッセージのアクションを指定します。

OperationContractAttribute 属性は、メソッドがサービス コントラクト内の操作であることを宣言します。 OperationContractAttribute 属性を設定したメソッドだけが、サービス操作として公開されます。 OperationContractAttribute でマークされたメソッドを持たないサービス コントラクトには、公開される操作がありません。

プロパティはAsyncPattern、methodName メソッドと<EndmethodName>> メソッドのBegin<ペアが非同期的に実装された 1 つの操作を形成することを示します (クライアントとサービスのどちらでも)。 サービスが操作を非同期に実装する能力はサービス実装の詳細であり、メタデータ (Web サービス記述言語 (WSDL) など) には公開されません。

同様に、クライアントは、サービス メソッドの実装方法とは無関係に、操作を非同期で呼び出すことを選択できます。 クライアント内でのサービス操作の非同期での呼び出しは、サービス メソッドの実行に多少の時間がかかるが、情報をクライアントに直接返す必要がある場合に使用することをお勧めします。 詳細については、「AsyncPattern」を参照してください。

IsOneWay プロパティは、メソッドが、基になる空の応答メッセージも含めてまったく値を返さないことを示します。 この種のメソッドは、通知やイベント スタイルの通信に便利です。 この種のメソッドは応答メッセージを返すことができないため、メソッドの宣言では void を返す必要があります。

重要

この属性の情報ストアをプログラムで取得する場合は、リフレクションの代わりに クラスを ContractDescription 使用します。

注意

IsOneWay プロパティが false (既定) に設定されている場合は、void を返すメソッドであっても、基になるメッセージ レベルでは双方向メソッドとなります。 この場合、インフラストラクチャは、空のメッセージを作成して送信することで、メソッドが戻ったことを呼び出し元に示します。 このアプローチを使用して、アプリケーションとインフラストラクチャは、エラー情報 (SOAP エラーなど) をクライアントに返信できます。 応答メッセージの作成とディスパッチを回避する唯一の方法は、IsOneWay を true に設定することです。 詳細については、「一方向サービス」を参照してください。

Action プロパティと ReplyAction プロパティを使用すると、SOAP メッセージの既定のアクションを変更するだけではなく、認識されないメッセージ用のハンドラーを作成したり、ダイレクト メッセージ プログラミングでのアクションの追加を無効にしたりできます。 クライアントが他の操作の前に特定のサービス操作を呼び出すことができないようにするには、IsInitiating プロパティを使用します。 クライアントが特定の IsTerminating サービス操作を呼び出した後に WCF でチャネルを閉じるには、 プロパティを使用します。 詳細については、「セッションの使用」を参照してください。

ProtectionLevel プロパティを使用して、操作メッセージが署名、暗号化、または署名と暗号化の対象になるかどうかを操作コントラクトに対して指定できます。 コントラクトによって要求されるセキュリティ レベルがバインドで提供できない場合は、実行時に例外がスローされます。 詳細については、「保護レベルについて」を参照してくださいProtectionLevel。

コンストラクター

OperationContractAttribute()

OperationContractAttribute クラスの新しいインスタンスを初期化します。

プロパティ

Action	要求メッセージの WS-Addressing アクションを取得または設定します。
AsyncPattern	サービス コントラクト内で Begin<methodName> メソッドと End<methodName> メソッドのペアを使用して、操作が非同期的に実装されることを示します。
IsInitiating	メソッドが (セッションが存在する場合に) サーバー上でセッションを開始できる操作を実装するかどうかを示す値を取得または設定します。
IsOneWay	操作が応答メッセージを返すかどうかを示す値を取得または設定します。
IsTerminating	応答メッセージが存在する場合に、そのメッセージの送信後にセッションを終了するようにサービス操作がサーバーに指示するかどうかを示す値を取得または設定します。
Name	操作の名前を取得します。値の設定も可能です。
ReplyAction	操作の応答メッセージの SOAP アクションの値を取得または設定します。
TypeId	派生クラスで実装されると、この Attribute の一意の識別子を取得します。 (継承元 Attribute)

メソッド

Equals(Object)	このインスタンスが、指定されたオブジェクトと等価であるかどうかを示す値を返します。 (継承元 Attribute)
GetHashCode()	このインスタンスのハッシュ コードを返します。 (継承元 Attribute)
GetType()	現在のインスタンスの Type を取得します。 (継承元 Object)
IsDefaultAttribute()	派生クラスでオーバーライドされるとき、このインスタンスの値が派生クラスの既定値であるかどうかを示します。 (継承元 Attribute)
Match(Object)	派生クラス内でオーバーライドされたときに、指定したオブジェクトとこのインスタンスが等しいかどうかを示す値を返します。 (継承元 Attribute)
MemberwiseClone()	現在の Object の簡易コピーを作成します。 (継承元 Object)
ToString()	現在のオブジェクトを表す文字列を返します。 (継承元 Object)