Teilen über

IPolicyImportExtension Schnittstelle

  • Referenz

Definition

Namespace:
System.ServiceModel.Description
Assembly:
System.ServiceModel.dll

Definiert eine Methode für Objekte, die benutzerdefinierte Richtlinienassertionen zu Bindungen importieren.

public interface class IPolicyImportExtension
public interface IPolicyImportExtension
type IPolicyImportExtension = interface
Public Interface IPolicyImportExtension
Abgeleitet

Beispiele

Im folgenden Codebeispiel wird die Verwendung der PolicyAssertionCollection.Remove-Methode zum Suchen, Zurückgeben und Entfernen der Assertion in einem Schritt gezeigt.

  #region IPolicyImporter Members
  public const string name1 = "acme";
  public const string ns1 = "http://Microsoft/WCF/Documentation/CustomPolicyAssertions";

  /*
   * Importing policy assertions usually means modifying the bindingelement stack in some way
   * to support the policy assertion. The procedure is:
   * 1. Find the custom assertion to import.
   * 2. Insert a supporting custom bindingelement or modify the current binding element collection
   *     to support the assertion.
   * 3. Remove the assertion from the collection. Once the ImportPolicy method has returned,
   *     any remaining assertions for the binding cause the binding to fail import and not be
   *     constructed.
   */
  public void ImportPolicy(MetadataImporter importer, PolicyConversionContext context)
  {
    Console.WriteLine("The custom policy importer has been called.");
    // Locate the custom assertion and remove it.
    XmlElement customAssertion = context.GetBindingAssertions().Remove(name1, ns1);
    if (customAssertion != null)
    {
      Console.WriteLine(
        "Removed our custom assertion from the imported "
        + "assertions collection and inserting our custom binding element."
      );
      // Here we would add the binding modification that implemented the policy.
      // This sample does not do this.
      Console.ForegroundColor = ConsoleColor.Red;
      Console.WriteLine(customAssertion.NamespaceURI + " : " + customAssertion.Name);
      Console.WriteLine(customAssertion.OuterXml);
      Console.ForegroundColor = ConsoleColor.Gray;
    }
 }
#endregion

    #Region "IPolicyImporter Members"
    Public Const name1 As String = "acme"
    Public Const ns1 As String = "http://Microsoft/WCF/Documentation/CustomPolicyAssertions"

'    
'     * Importing policy assertions usually means modifying the bindingelement stack in some way
'     * to support the policy assertion. The procedure is:
'     * 1. Find the custom assertion to import.
'     * 2. Insert a supporting custom bindingelement or modify the current binding element collection
'     *     to support the assertion.
'     * 3. Remove the assertion from the collection. Once the ImportPolicy method has returned, 
'     *     any remaining assertions for the binding cause the binding to fail import and not be 
'     *     constructed.
'     
    Public Sub ImportPolicy(ByVal importer As MetadataImporter, ByVal context As PolicyConversionContext) Implements IPolicyImportExtension.ImportPolicy
      Console.WriteLine("The custom policy importer has been called.")
      ' Locate the custom assertion and remove it.
      Dim customAssertion As XmlElement = context.GetBindingAssertions().Remove(name1, ns1)
      If customAssertion IsNot Nothing Then
        Console.WriteLine("Removed our custom assertion from the imported " & "assertions collection and inserting our custom binding element.")
        ' Here we would add the binding modification that implemented the policy.
        ' This sample does not do this.
        Console.ForegroundColor = ConsoleColor.Red
        Console.WriteLine(customAssertion.NamespaceURI & " : " & customAssertion.Name)
        Console.WriteLine(customAssertion.OuterXml)
        Console.ForegroundColor = ConsoleColor.Gray
      End If
    End Sub
  #End Region

Im folgenden Codebeispiel wird die Clientanwendungs-Konfigurationsdatei gezeigt, mit der das benutzerdefinierte Richtlinienimportprogramm geladen wird, wenn System.ServiceModel.Description.MetadataResolver aufgerufen wird.

<client>
    <endpoint 
      address="http://localhost:8080/StatefulService" 
      binding="wsHttpBinding"
      bindingConfiguration="CustomBinding_IStatefulService" 
      contract="IStatefulService"
      name="CustomBinding_IStatefulService" />
  <metadata>
    <policyImporters>
      <extension type="Microsoft.WCF.Documentation.CustomPolicyImporter, PolicyExtensions"/>
    </policyImporters>
  </metadata>
</client>

Im folgenden Codebeispiel wird die Verwendung von MetadataResolver gezeigt, mit dem Metadaten in Beschreibungsobjekte heruntergeladen und aufgelöst werden.

// Download all metadata.
ServiceEndpointCollection endpoints
  = MetadataResolver.Resolve(
    typeof(IStatefulService),
    new EndpointAddress("http://localhost:8080/StatefulService/mex")
  );

' Download all metadata. 
Dim endpoints As ServiceEndpointCollection = MetadataResolver.Resolve(GetType(IStatefulService), New EndpointAddress("http://localhost:8080/StatefulService/mex"))

Hinweise

Implementieren Sie die IPolicyImportExtension-Schnittstelle, um in WSDL-Informationen, die von einem bestimmten Endpunkt ausgegeben werden, nach benutzerdefinierten Richtlinienassertionen zu Endpunktfunktionen oder -anforderungen zu suchen. In der Regel sucht ein Richtlinienprogramm nach einer bestimmten Assertion und fügt entweder ein Bindungselement ein, konfiguriert ein Bindungselement oder ändert den Vertrag so, dass die Anforderungen der Assertion unterstützt werden.

Im Gegensatz zu seinem Gegenstück IPolicyExportExtension erfordert IPolicyImportExtension keine Implementierung durch ein BindingElement-Objekt; Sie können es mithilfe des Clientkonfigurationsabschnitts im Beispielabschnitt oder aber programmgesteuert laden, indem Sie es dem System.ServiceModel.Description.WsdlImporter-Konstruktor hinzufügen.

Windows Communication Foundation (WCF) übergibt zwei Objekte an die ImportPolicy -Methode, ein MetadataImporter und ein PolicyConversionContext. In der Regel enthält das PolicyConversionContext-Objekt bereits die Richtlinienassertionen für jeden Bindungsbereich.

Eine IPolicyImportExtension-Implementierung führt die folgenden Schritte aus:

  1. Sucht die benutzerdefinierte Richtlinienassertion, für die sie verantwortlich ist, durch Aufruf der Methode GetBindingAssertions, GetMessageBindingAssertions oder GetOperationBindingAssertions (je nach Bereich).

  2. Entfernt die Richtlinienassertion aus der Assertionsauflistung. Die PolicyAssertionCollection.Remove-Methode sucht die Assertion, gibt sie zurück und entfernt sie (in einem Schritt).

  3. Ändern Sie den Bindungsstapel oder den Vertrag, indem Sie entweder ein erforderliches benutzerdefiniertes BindingElement der BindingElements-Eigenschaft hinzufügen oder indem Sie die PolicyConversionContext.Contract-Eigenschaft ändern.

Schritt 2 ist wichtig. Nachdem alle Richtlinienimporteure aufgerufen wurden, überprüft WCF, ob alle verbleibenden Richtlinienassertionen vorhanden sind. Falls vorhanden, geht WCF davon aus, dass der Richtlinienimport nicht erfolgreich war, und importiert die zugeordnete Bindung nicht.

Wichtig

Ein böswilliger Metadatenanbieter kann versuchen, falsch formatiertes XML als Teil der Metadaten zu versenden, um ein Richtlinienimportprogramm auszunutzen. Es wird dringend empfohlen, dass die benutzerdefinierten Richtlinienimportprogramme so konzipiert werden, dass sie stabil gegenüber allen XML-Formen sind, die an sie übergeben werden.

Benutzerdefinierte MetadataImporter-Implementierungen müssen ihr eigenes PolicyConversionContext-Objekt implementieren, um die an das benutzerdefinierte Metadatenformat angehängten Richtlinienassertionen zu extrahieren.

Wenn Sie benutzerdefinierte WSDL-Elemente exportieren und importieren möchten, bei denen es sich nicht um Richtlinienassertionen handelt, finden Sie weitere Informationen unter System.ServiceModel.Description.IWsdlExportExtension und System.ServiceModel.Description.IWsdlImportExtension.

Hinweis

Sie können benutzerdefinierte Richtlinienimporteure und Exporteure mit dem ServiceModel Metadata Utility Tool (Svcutil.exe) verwenden, indem Sie dieselben Konfigurationselemente in einer Konfigurationsdatei und die /svcutilConfig:<configFile> Option verwenden.

Methoden

ImportPolicy(MetadataImporter, PolicyConversionContext)

Definiert eine Methode, mit der benutzerdefinierte Richtlinienassertionen importiert und implementierende Bindungselemente hinzugefügt werden können.

Gilt für: