IPolicyExportExtension インターフェイス

定義

カスタム バインディング ポリシー アサーションを Web サービス記述言語 (WSDL) の情報に挿入する IPolicyExportExtension を実装します。Implement IPolicyExportExtension to insert custom binding policy assertions in the Web Services Description Language (WSDL) information.

public interface class IPolicyExportExtension
public interface IPolicyExportExtension
type IPolicyExportExtension = interface
Public Interface IPolicyExportExtension
派生

IPolicyExportExtensionBindingElement の実装を次のコード例に示します。The following code example shows the implementation of IPolicyExportExtension on a BindingElement. この例では、カスタム バインディグ要素が、バインディグ レベルで WSDL ファイルに結び付けられます。In this example, a custom binding element is attached to the WSDL file at the binding level.

#region IPolicyExporter Members
public void ExportPolicy(MetadataExporter exporter, PolicyConversionContext policyContext)
{
  if (exporter == null)
    throw new NullReferenceException("The MetadataExporter object passed to the ExporterBindingElement is null.");
  if (policyContext == null)
    throw new NullReferenceException("The PolicyConversionContext object passed to the ExporterBindingElement is null.");
  
  XmlElement elem = doc.CreateElement(name1, ns1);
  elem.InnerText = "My custom text.";
  XmlAttribute att = doc.CreateAttribute("MyCustomAttribute", ns1);
  att.Value = "ExampleValue";
  elem.Attributes.Append(att);
  XmlElement subElement = doc.CreateElement("MyCustomSubElement", ns1);
  subElement.InnerText = "Custom Subelement Text.";
  elem.AppendChild(subElement);
  policyContext.GetBindingAssertions().Add(elem);
  Console.WriteLine("The custom policy exporter was called.");
}
#endregion
#Region "IPolicyExporter Members"
Public Sub ExportPolicy(ByVal exporter As MetadataExporter, ByVal policyContext As PolicyConversionContext) Implements IPolicyExportExtension.ExportPolicy
  If exporter Is Nothing Then
    Throw New NullReferenceException("The MetadataExporter object passed to the ExporterBindingElement is null.")
  End If
  If policyContext Is Nothing Then
    Throw New NullReferenceException("The PolicyConversionContext object passed to the ExporterBindingElement is null.")
  End If

  Dim elem As XmlElement = doc.CreateElement(name1, ns1)
  elem.InnerText = "My custom text."
  Dim att As XmlAttribute = doc.CreateAttribute("MyCustomAttribute", ns1)
  att.Value = "ExampleValue"
  elem.Attributes.Append(att)
  Dim subElement As XmlElement = doc.CreateElement("MyCustomSubElement", ns1)
  subElement.InnerText = "Custom Subelement Text."
  elem.AppendChild(subElement)
  policyContext.GetBindingAssertions().Add(elem)
  Console.WriteLine("The custom policy exporter was called.")
End Sub
#End Region

前のポリシー エクスポーターをアプリケーション構成ファイルから読み込めるようにする System.ServiceModel.Configuration.BindingElementExtensionElement の実装を次のコード例に示します。The following code example shows a System.ServiceModel.Configuration.BindingElementExtensionElement implementation that enables the preceding policy exporter to be loaded from an application configuration file.

public class ExporterBindingElementConfigurationSection : BindingElementExtensionElement
{
  public ExporterBindingElementConfigurationSection()
  { Console.WriteLine("Exporter configuration section created."); }

  public override Type BindingElementType
  { get { return typeof(ExporterBindingElement); } }

  protected override BindingElement CreateBindingElement()
  { return new ExporterBindingElement(); }
}
Public Class ExporterBindingElementConfigurationSection
    Inherits BindingElementExtensionElement
  Public Sub New()
      Console.WriteLine("Exporter configuration section created.")
  End Sub

  Public Overrides ReadOnly Property BindingElementType() As Type
      Get
          Return GetType(ExporterBindingElement)
      End Get
  End Property

  Protected Overrides Function CreateBindingElement() As BindingElement
      Return New ExporterBindingElement()
  End Function
End Class

カスタム ポリシー エクスポーターを読み込むホスト構成ファイルを次のコード例に示します。The following example shows the host configuration file that loads the custom policy exporter.

<system.serviceModel>
  <services>
    <service 
      name="Microsoft.WCF.Documentation.StatefulService"
      behaviorConfiguration="addMetadata"
    >
      <host>
        <baseAddresses>
          <add baseAddress="http://localhost:8080/StatefulService"/>
        </baseAddresses>
      </host>
      <endpoint 
        address="http://localhost:8080/StatefulService" 
        binding="customBinding" 
        bindingConfiguration="exporter" 
        contract="Microsoft.WCF.Documentation.IStatefulService" 
      />
      <endpoint
        address="mex"
        binding="mexHttpBinding"
        contract="IMetadataExchange"
      />
    </service>
  </services>
  <behaviors>
    <serviceBehaviors>
      <behavior name="addMetadata">
        <serviceMetadata
           httpGetEnabled="true"
           httpGetUrl=""
         />
      </behavior>
    </serviceBehaviors>
  </behaviors>
  <bindings>
    <customBinding>
      <!-- 
        Use the name attribute of the binding element as 
        the value of the bindingConfiguration attribute in 
        your endpoint.
      -->
      <binding name ="exporter">
        <!-- Use the name attribute of your binding element extension specified below. -->
        <!-- Be certain the order of your custom binding elements is correct. -->
        <exporterBinding />
        <reliableSession/>
        <textMessageEncoding messageVersion="Default" />
        <httpTransport/>
      </binding>
    </customBinding>
  </bindings>
  <extensions>
    <bindingElementExtensions>
      <!-- Use the add element to associate your bindingelement configuration handler and give it a name to use. -->
      <add 
        type="Microsoft.WCF.Documentation.ExporterBindingElementConfigurationSection,PolicyExtensions" 
        name="exporterBinding" />
    </bindingElementExtensions>
  </extensions>
</system.serviceModel>

WSDL ファイル内のカスタム アサーションを次のコード例に示します。The following example shows the custom assertion in the WSDL file.

<wsdl:definitions xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/" xmlns:wsp="http://schemas.xmlsoap.org/ws/2004/09/policy"

  namespaces removed here for clarity...

>
  <wsp:Policy wsu:Id="CustomBinding_IStatefulService_policy">
    <wsp:ExactlyOne>
      <wsp:All>
        <acme 
          b:MyCustomAttribute="ExampleValue"
          xmlns="http://Microsoft/WCF/Documentation/CustomPolicyAssertions"           xmlns:b="http://Microsoft/WCF/Documentation/CustomPolicyAssertions">
           My custom text.
          <MyCustomSubElement>Custom Subelement Text.</MyCustomSubElement>
        </acme>
        <wsrm:RMAssertion xmlns:wsrm="http://schemas.xmlsoap.org/ws/2005/02/rm/policy">
          <wsrm:InactivityTimeout Milliseconds="600000" />
          <wsrm:AcknowledgementInterval Milliseconds="200" />
        </wsrm:RMAssertion>
        <wsaw:UsingAddressing />
      </wsp:All>
    </wsp:ExactlyOne>
  </wsp:Policy>
  <wsdl:import namespace="http://microsoft.wcf.documentation" location="" />

注釈

エンドポイントの機能または要件に関するステートメントを、特定のエンドポイントによって公開される WSDL 情報に書き込むには、IPolicyExportExtension オブジェクトで System.ServiceModel.Channels.BindingElement インターフェイスを実装します。Implement the IPolicyExportExtension interface on a System.ServiceModel.Channels.BindingElement object to write statements about endpoint capabilities or requirements into the WSDL information exposed by a particular endpoint. 一般に、バインド要素はなんらかの機能を実装する要素ですが、機能の実装は必須ではありません。Typically the binding element is one that implements some feature, but this is not required. 構成ファイルからポリシー エクスポーターを読み込むには、ポリシー エクスポーターの System.ServiceModel.Configuration.BindingElementExtensionElement オブジェクトを返す BindingElement を実装する必要があります。To load your policy exporter from a configuration file, implement a System.ServiceModel.Configuration.BindingElementExtensionElement that returns the policy exporter BindingElement object.

ポリシーエクスポーターは、ポリシーアサーションを使用して、そのカスタムバインド要件またはエンドポイント機能が存在することをクライアントに通知するために、Windows Communication Foundation (WCF) によって使用されます。The policy exporter is used by Windows Communication Foundation (WCF) to use policy assertions to communicate to clients the existence of that custom binding requirement or endpoint capability.

ExportPolicy メソッドは、MetadataExporter オブジェクトと PolicyConversionContext オブジェクトを受け取ります。The ExportPolicy method takes the MetadataExporter and PolicyConversionContext objects. GetBindingAssertionsGetMessageBindingAssertions、および GetOperationBindingAssertions の各メソッドを使用して、既にさまざまなスコープでエクスポートされているポリシー アサーションのコレクションを取得します。Use the GetBindingAssertions, GetMessageBindingAssertions, and GetOperationBindingAssertions methods to obtain collections of policy assertions that have already been exported at various scopes. 次に、カスタム ポリシー アサーション オブジェクトを適切なコレクションに追加します。Then add your custom policy assertion object to the appropriate collection.

Contract プロパティは、エクスポートされるエンドポイントの ContractDescription を公開します。The Contract property exposes the ContractDescription for the endpoint that is being exported. これにより、IPolicyExportExtension 拡張は、エクスポートされたポリシー アサーションを正しく特定できます。This allows the IPolicyExportExtension extension to correctly scope their exported policy assertions. たとえば、コード内のセキュリティ属性は、セキュリティ ポリシー アサーションを追加する必要がある場所を示す ContractDescription に動作を追加できます。For example, security attributes in code may add behaviors to the ContractDescription that indicate where security policy assertions should be added.

IPolicyExportExtension のメカニズムは、WSDL のポリシー アサーションのエクスポートだけをサポートします。The IPolicyExportExtension mechanism only supports exporting policy assertions in WSDL. カスタム WSDL 要素をエクスポートする場合は、IWsdlExportExtension メカニズムを使用して WSDL を直接変更する必要があります。To export custom WSDL elements you must use the IWsdlExportExtension mechanism to modify the WSDL directly.

カスタム ポリシー アサーションが WSDL 情報に関連付けられると、クライアントは、IPolicyImportExtension オブジェクトを使用して、カスタム バインディング アサーションを検出しインポートできます。Once custom policy assertions have been attached to the WSDL information, clients can detect and import the custom binding assertions by using an IPolicyImportExtension object.

メソッド

ExportPolicy(MetadataExporter, PolicyConversionContext)

バインディングに関するカスタム ポリシー アサーションをエクスポートするために、実装して組み込みます。Implement to include for exporting a custom policy assertion about bindings.

適用対象