ContractDescription ContractDescription ContractDescription ContractDescription Class

定義

エンドポイントが外部と通信する内容を指定する Windows Communication Foundation (WCF) コントラクトを記述します。Describes a Windows Communication Foundation (WCF) contract that specifies what an endpoint communicates to the outside world.

public ref class ContractDescription
public class ContractDescription
type ContractDescription = class
Public Class ContractDescription
継承
ContractDescriptionContractDescriptionContractDescriptionContractDescription

次の例は、ContractDescription オブジェクトを作成または取得するさまざまな方法を示しています。The following example shows a number of ways to create or retrieve a ContractDescription object. この例では、さらに ContractDescription オブジェクトに格納されているさまざまな情報を表示します。It then displays the various pieces of information that are stored in the ContractDescription object.

           Uri baseAddress = new Uri("http://localhost:8001/Simple");
           ServiceHost serviceHost = new ServiceHost(typeof(CalculatorService), baseAddress);

           serviceHost.AddServiceEndpoint(
               typeof(ICalculator),
               new WSHttpBinding(),
               "CalculatorServiceObject");

           // Enable Mex
           ServiceMetadataBehavior smb = new ServiceMetadataBehavior();
           smb.HttpGetEnabled = true;
           serviceHost.Description.Behaviors.Add(smb);

           serviceHost.Open();

           ContractDescription cd0 = new ContractDescription("ICalculator");
           ContractDescription cd1 = new ContractDescription("ICalculator", "http://www.tempuri.org");
           ContractDescription cd2 = ContractDescription.GetContract(typeof(ICalculator));
           CalculatorService calcSvc = new CalculatorService();
           ContractDescription cd3 = ContractDescription.GetContract(typeof(ICalculator), calcSvc);
           ContractDescription cd4 = ContractDescription.GetContract(typeof(ICalculator), typeof(CalculatorService));
           ContractDescription cd = serviceHost.Description.Endpoints[0].Contract;         

           Console.WriteLine("Displaying information for contract: {0}", cd.Name.ToString());

           KeyedByTypeCollection<IContractBehavior> behaviors = cd.Behaviors;
           Console.WriteLine("\tDisplay all behaviors:");
           foreach (IContractBehavior behavior in behaviors)
           {
               Console.WriteLine("\t\t" + behavior.ToString());
           }

           Type type = cd.CallbackContractType;

           string configName = cd.ConfigurationName;
           Console.WriteLine("\tConfiguration name: {0}", configName);

           Type contractType = cd.ContractType;
           Console.WriteLine("\tContract type: {0}", contractType.ToString());

           bool hasProtectionLevel = cd.HasProtectionLevel;
           if (hasProtectionLevel)
           {
               ProtectionLevel protectionLevel = cd.ProtectionLevel;
               Console.WriteLine("\tProtection Level: {0}", protectionLevel.ToString());
           }

           
           string name = cd.Name;
           Console.WriteLine("\tName: {0}", name);

           string namespc = cd.Namespace;
           Console.WriteLine("\tNamespace: {0}", namespc);

           OperationDescriptionCollection odc = cd.Operations;
           Console.WriteLine("\tDisplay Operations:");
           foreach (OperationDescription od in odc)
           {
               Console.WriteLine("\t\t" + od.Name);
           }

           SessionMode sm = cd.SessionMode;
           Console.WriteLine("\tSessionMode: {0}", sm.ToString());

           Collection<ContractDescription> inheretedContracts = cd.GetInheritedContracts();
           Console.WriteLine("\tInherited Contracts:");
           foreach (ContractDescription contractdescription in inheretedContracts)
           {
               Console.WriteLine("\t\t" + contractdescription.Name);
           }

           Console.WriteLine("The service is ready.");
           Console.WriteLine("Press <ENTER> to terminate service.");
           Console.WriteLine();
           Console.ReadLine();

           // Close the ServiceHostBase to shutdown the service.
           serviceHost.Close();
Dim baseAddress As New Uri("http://localhost:8001/Simple")
Dim serviceHost As New ServiceHost(GetType(CalculatorService), baseAddress)

serviceHost.AddServiceEndpoint(GetType(ICalculator), New WSHttpBinding(), "CalculatorServiceObject")

' Enable Mex
Dim smb As New ServiceMetadataBehavior()
smb.HttpGetEnabled = True
serviceHost.Description.Behaviors.Add(smb)

serviceHost.Open()

Dim cd0 As New ContractDescription("ICalculator")
Dim cd1 As New ContractDescription("ICalculator", "http://www.tempuri.org")
Dim cd2 As ContractDescription = ContractDescription.GetContract(GetType(ICalculator))
Dim calcSvc As New CalculatorService()
Dim cd3 As ContractDescription = ContractDescription.GetContract(GetType(ICalculator), calcSvc)
Dim cd4 As ContractDescription = ContractDescription.GetContract(GetType(ICalculator), GetType(CalculatorService))
Dim cd As ContractDescription = serviceHost.Description.Endpoints(0).Contract

Console.WriteLine("Displaying information for contract: {0}", cd.Name.ToString())

Dim behaviors As KeyedByTypeCollection(Of IContractBehavior) = cd.Behaviors
Console.WriteLine(Constants.vbTab & "Display all behaviors:")
For Each behavior As IContractBehavior In behaviors
    Console.WriteLine(Constants.vbTab + Constants.vbTab + CType(behavior, Object).ToString())
Next behavior

Dim type As Type = cd.CallbackContractType

Dim configName As String = cd.ConfigurationName
Console.WriteLine(Constants.vbTab & "Configuration name: {0}", configName)

Dim contractType As Type = cd.ContractType
Console.WriteLine(Constants.vbTab & "Contract type: {0}", contractType.ToString())

Dim hasProtectionLevel As Boolean = cd.HasProtectionLevel
If hasProtectionLevel Then
    Dim protectionLevel As ProtectionLevel = cd.ProtectionLevel
    Console.WriteLine(Constants.vbTab & "Protection Level: {0}", protectionLevel.ToString())
End If


Dim name As String = cd.Name
Console.WriteLine(Constants.vbTab & "Name: {0}", name)

Dim namespc As String = cd.Namespace
Console.WriteLine(Constants.vbTab & "Namespace: {0}", namespc)

Dim odc As OperationDescriptionCollection = cd.Operations
Console.WriteLine(Constants.vbTab & "Display Operations:")
For Each od As OperationDescription In odc
    Console.WriteLine(Constants.vbTab + Constants.vbTab + od.Name)
Next od

Dim sm As SessionMode = cd.SessionMode
Console.WriteLine(Constants.vbTab & "SessionMode: {0}", sm.ToString())

Dim inheretedContracts As Collection(Of ContractDescription) = cd.GetInheritedContracts()
Console.WriteLine(Constants.vbTab & "Inherited Contracts:")
For Each contractdescription As ContractDescription In inheretedContracts
    Console.WriteLine(Constants.vbTab + Constants.vbTab + contractdescription.Name)
Next contractdescription

Console.WriteLine("The service is ready.")
Console.WriteLine("Press <ENTER> to terminate service.")
Console.WriteLine()
Console.ReadLine()

' Close the ServiceHostBase to shutdown the service.
serviceHost.Close()

注釈

WCF コントラクトは、エンドポイントが外部と通信する対象を指定する操作のコレクションです。A WCF contract is a collection of operations that specifies what the endpoint communicates to the outside world. それぞれの操作は、メッセージ交換です。Each operation is a message exchange. たとえば、要求メッセージとそれに関連する応答メッセージは要求/応答メッセージ交換を行います。For example, a request message and an associated reply message form a request/reply message exchange.

オブジェクトContractDescriptionは、WCF コントラクトとその操作を記述するために使用されます。A ContractDescription object is used to describe WCF contracts and their operations. ContractDescription では、各コントラクト操作に、対応する OperationDescription があります。ここでは、操作が一方向か要求/応答かなど、コントラクトの一部である各操作の側面を説明します。Within a ContractDescription, each contract operation has a corresponding OperationDescription that describes aspects of the each operation that is part of the contract, such as whether the operation is one-way or request/reply. また、それぞれの OperationDescription では、MessageDescriptionCollection を使用して、操作を構成するメッセージを記述します。Each OperationDescription also describes the messages that make up the operation using a MessageDescriptionCollection. ContractDescription には、プログラミング モデルを使用してコントラクトを定義するインターフェイスへの参照が含まれます。ContractDescription contains a reference to an interface that defines the contract using the programming model. このインターフェイスは ServiceContractAttribute でマークされ、エンドポイントの操作に対応するメソッドは OperationContractAttribute でマークされます。This interface is marked with ServiceContractAttribute and its methods that correspond to endpoint operations are marked with the OperationContractAttribute.

方向コントラクトは、次のような操作の論理セットを定義します。A duplex contract defines the following logical sets of operations:

  • サービスが呼び出すクライアント用に公開するセット。A set that the service exposes for the client to call.

  • クライアントが呼び出すサービス用に公開するセット。A set that the client exposes for the service to call.

双方向コントラクトを定義するためのプログラミング モデルでは、各セットを個別のインターフェイスに分割し、各インターフェイスに属性を適用します。The programming model for defining a duplex contract is to split each set in a separate interface and apply attributes to each interface. この場合、ContractDescription には各インターフェイスへの参照が含まれます。この参照によって、各インターフェイスは 1 つの双方向コントラクトにグループ化されます。In this case, ContractDescription contains a reference to each of the interfaces that groups them into one duplex contract.

バインディングと同様に、各コントラクトはサービスのメタデータ内でコントラクトを一意に識別する NameNamespace を持ちます。Similar to bindings, each contract has a Name and Namespace that uniquely identify it in the metadata of the service.

コンストラクター

ContractDescription(String) ContractDescription(String) ContractDescription(String) ContractDescription(String)

指定した名前を使用して、ContractDescription クラスの新しいインスタンスを初期化します。Initializes a new instance of the ContractDescription class with a specified name.

ContractDescription(String, String) ContractDescription(String, String) ContractDescription(String, String) ContractDescription(String, String)

指定した名前空間の限定名を使用して、ContractDescription クラスの新しいインスタンスを初期化します。Initializes a new instance of the ContractDescription class with a namespace-qualified name specified.

プロパティ

Behaviors Behaviors Behaviors Behaviors

コントラクトの説明に関連付けられている動作を取得します。Gets the behaviors associated with the contract description.

CallbackContractType CallbackContractType CallbackContractType CallbackContractType

コントラクトの説明で指定されたコールバック コントラクトの型を取得または設定します。Gets or sets the type of callback contract that the contract description specifies.

ConfigurationName ConfigurationName ConfigurationName ConfigurationName

コントラクトの説明の構成名を取得または設定します。Gets or sets the configuration name for the contract description.

ContractBehaviors ContractBehaviors ContractBehaviors ContractBehaviors

コントラクトの動作のコレクションを取得します。Gets the collection of behavior for the contract.

ContractType ContractType ContractType ContractType

コントラクトの説明で指定されたコントラクトの型を取得または設定します。Gets or sets the contract type that the contract description specifies.

HasProtectionLevel HasProtectionLevel HasProtectionLevel HasProtectionLevel

コントラクトに保護レベルが設定されているかどうかを示す値を取得します。Gets a value that indicates whether the contract has had a protection level set.

Name Name Name Name

コントラクトの名前を取得または設定します。Gets or sets the name of the contract.

Namespace Namespace Namespace Namespace

コントラクトの名前空間を取得または設定します。Gets or sets the namespace for the contract.

Operations Operations Operations Operations

コントラクトに関連付けられている操作の説明のコレクションを取得します。Gets the collection of operation descriptions associated with the contract.

ProtectionLevel ProtectionLevel ProtectionLevel ProtectionLevel

コントラクトに関連付けられているセキュリティ保護レベルを取得または設定します。Gets or sets the level of security protection associated with the contract.

SessionMode SessionMode SessionMode SessionMode

コントラクトにセッションが必要かどうかを示す値を取得または設定します。Gets or sets a value that indicates whether a session is required by the contract.

メソッド

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

指定したオブジェクトが、現在のオブジェクトと等しいかどうかを判断します。Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetContract(Type) GetContract(Type) GetContract(Type) GetContract(Type)

指定した型のコントラクトの、コントラクトの説明を返します。Returns the contract description for a specified type of contract.

GetContract(Type, Object) GetContract(Type, Object) GetContract(Type, Object) GetContract(Type, Object)

指定した型のコントラクトおよびサービス実装の、コントラクトの説明を返します。Returns the contract description for a specified type of contract and service implementation.

GetContract(Type, Type) GetContract(Type, Type) GetContract(Type, Type) GetContract(Type, Type)

指定した型のコントラクトおよび指定した型のサービスの、コントラクトの説明を返します。Returns the contract description for a specified type of contract and a specified type of service.

GetHashCode() GetHashCode() GetHashCode() GetHashCode()

既定のハッシュ関数として機能します。Serves as the default hash function.

(Inherited from Object)
GetInheritedContracts() GetInheritedContracts() GetInheritedContracts() GetInheritedContracts()

現在のコントラクトの説明によって継承されているコントラクトの説明のコレクションを返します。Returns a collection of contract descriptions that are inherited by the current contract description.

GetType() GetType() GetType() GetType()

現在のインスタンスの Type を取得します。Gets the Type of the current instance.

(Inherited from Object)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

現在の Object の簡易コピーを作成します。Creates a shallow copy of the current Object.

(Inherited from Object)
ShouldSerializeProtectionLevel() ShouldSerializeProtectionLevel() ShouldSerializeProtectionLevel() ShouldSerializeProtectionLevel()

ProtectionLevel プロパティが既定値から変更されたためにシリアル化する必要があるかどうかを示す値を返します。Returns a value that indicates whether the ProtectionLevel property has changed from its default value and should be serialized.

ToString() ToString() ToString() ToString()

現在のオブジェクトを表す文字列を返します。Returns a string that represents the current object.

(Inherited from Object)

適用対象