IPolicyExportExtension Interfaccia

Riferimento

Definizione

Spazio dei nomi:: System.ServiceModel.Description

Assembly:: System.ServiceModel.dll

Importante

Alcune informazioni sono relative alla release non definitiva del prodotto, che potrebbe subire modifiche significative prima della release definitiva. Microsoft non riconosce alcuna garanzia, espressa o implicita, in merito alle informazioni qui fornite.

Implementare IPolicyExportExtension per inserire asserzioni di criteri dell'associazione personalizzate alle informazioni di linguaggio di descrizione dei servizi Web (WSDL, Web Services Description Language).

public interface class IPolicyExportExtension

public interface IPolicyExportExtension

type IPolicyExportExtension = interface

Public Interface IPolicyExportExtension

Derivato: System.ServiceModel.Channels.AsymmetricSecurityBindingElement

System.ServiceModel.Channels.BinaryMessageEncodingBindingElement

System.ServiceModel.Channels.CompositeDuplexBindingElement

System.ServiceModel.Channels.ConnectionOrientedTransportBindingElement

System.ServiceModel.Channels.ContextBindingElement

Altro…

Esempio

Nell'esempio di codice seguente viene illustrata l'implementazione dell'interfaccia IPolicyExportExtension in una classe BindingElement. In questo esempio, un elemento dell'associazione personalizzato viene allegato al file WSDL a livello di associazione.

#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

Nell'esempio di codice seguente viene illustrata un'implementazione System.ServiceModel.Configuration.BindingElementExtensionElement che consente all'utilità di esportazione dei criteri precedente di essere caricata da un file di configurazione dell'applicazione.

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

Nell'esempio seguente viene mostrato il file di configurazione del host che carica l'utilità di esportazione dei criteri personalizzata.

<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>

Nell'esempio seguente viene mostrata l'asserzione personalizzata nel file WSDL.

<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="" />

Commenti

Implementare l'interfaccia IPolicyExportExtension in un oggetto System.ServiceModel.Channels.BindingElement per scrivere istruzioni sulle funzionalità o i requisiti dell'endpoint nelle informazioni WSDL esposte da un particolare endpoint. In genere l'elemento dell'associazione è l'elemento che implementa una funzionalità, ma non è una condizione necessaria. Per caricare l'utilità di esportazione dei criteri da un file di configurazione, implementare un oggetto System.ServiceModel.Configuration.BindingElementExtensionElement che restituisce un oggetto BindingElement dell'utilità di esportazione dei criteri.

L'esportazione dei criteri viene usata da Windows Communication Foundation (WCF) per usare le asserzioni dei criteri per comunicare ai client l'esistenza di tale requisito di associazione personalizzata o funzionalità dell'endpoint.

Il metodo ExportPolicy assume gli oggetti MetadataExporter e PolicyConversionContext. Utilizzare i metodi GetBindingAssertions, GetMessageBindingAssertions e GetOperationBindingAssertions per ottenere raccolte di asserzioni di criteri già esportate nei diversi ambiti. Aggiungere quindi l'oggetto dell'asserzione di criteri personalizzata alla raccolta appropriata.

La proprietà Contract espone ContractDescription per l'endpoint in fase di esportazione. Ciò consente all'estensione IPolicyExportExtension di assegnare l'ambito corretto alle asserzioni di criteri esportate. Ad esempio, è possibile che gli attributi di sicurezza nel codice aggiungano comportamenti a ContractDescription per indicare dove aggiungere le asserzioni di criteri di sicurezza.

Il meccanismo IPolicyExportExtension supporta solo le asserzioni di criteri di esportazione in WSDL. Per esportare elementi WSDL personalizzati è necessario utilizzare il meccanismo IWsdlExportExtension per modificare direttamente il WSDL.

Dopo aver allegato le asserzioni di criteri personalizzate alle informazioni WSDL, i client possono rilevare e importare le asserzioni dell'associazione personalizzate mediante un oggetto IPolicyImportExtension.

Metodi

ExportPolicy(MetadataExporter, PolicyConversionContext)

Procedere all'implementazione per includere un'asserzione di criteri personalizzata relativa alle associazioni da esportare.

Si applica a