PolicyConversionContext Class
TOC
Collapse the table of content
Expand the table of content

PolicyConversionContext Class

 

Defines a class used to retrieve binding assertions in metadata and to attach implementing binding elements at the appropriate scope.

Namespace:   System.ServiceModel.Description
Assembly:  System.ServiceModel (in System.ServiceModel.dll)

System::Object
  System.ServiceModel.Description::PolicyConversionContext

public ref class PolicyConversionContext abstract 

NameDescription
System_CAPS_protmethodPolicyConversionContext(ServiceEndpoint^)

Initializes a new instance of the PolicyConversionContext class using the specified endpoint.

NameDescription
System_CAPS_pubpropertyBindingElements

Gets a collection of binding elements to which custom binding elements that implement policy assertions are added.

System_CAPS_pubpropertyContract

Gets the contract for the endpoint.

NameDescription
System_CAPS_pubmethodEquals(Object^)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodGetBindingAssertions()

Gets a collection of policy assertions from metadata.

System_CAPS_pubmethodGetFaultBindingAssertions(FaultDescription^)

Returns a collection of policy assertions for the specified SOAP fault.

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetMessageBindingAssertions(MessageDescription^)

Gets a collection of policy assertions for a message.

System_CAPS_pubmethodGetOperationBindingAssertions(OperationDescription^)

Returns a collection of policy assertions for the specified operation.

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

An implementation of the PolicyConversionContext is passed to IPolicyExportExtension and IPolicyImportExtension objects to export and import, respectively, custom policy assertions to and from metadata. On export, a collection of policy assertions are retrieved in order to add custom assertions. On import, the assertions are retrieved in order to import specific ones and configure binding elements appropriately.

The following code example shows an implementation of the ImportPolicy method that writes all policy assertions to the console. The code comments describe how to locate a specific custom policy assertion, create and insert an implementing binding element, and remove the assertion from the collection.

public void ImportPolicy(MetadataImporter importer, 
    PolicyConversionContext context)
{
    Console.WriteLine("The custom policy importer has been called.");
    foreach (XmlElement assertion in context.GetBindingAssertions())
    {
        Console.WriteLine(assertion.NamespaceURI + " : " + assertion.Name);
        // locate a particular assertion by Name and NamespaceURI
        XmlElement customAssertion = context.GetBindingAssertions().Find(name1, ns1);
        if (customAssertion != null)
        {
          // Found assertion; remove from collection.
          context.GetBindingAssertions().Remove(customAssertion);
          Console.WriteLine(
            "Removed our custom assertion from the imported "
            + "assertions collection and inserting our custom binding element."
          );
            // Here if you find the custom policy assertion that you are looking for,
            // add the custom binding element that handles the functionality that the policy indicates.
            // Attach it to the PolicyConversionContext.BindingElements collection.
            // For example, if the custom policy had a "speed" attribute value:
            /*
              string speed 
                = customAssertion.GetAttribute(SpeedBindingElement.name2, SpeedBindingElement.ns2);
              SpeedBindingElement e = new SpeedBindingElement(speed);
              context.BindingElements.Add(e);
            */
        }

        // write assertion name in red.
        Console.ForegroundColor = ConsoleColor.Red;
        Console.WriteLine(assertion.NamespaceURI + " : " + assertion.Name);

        //write contents in gray.
        Console.WriteLine(assertion.OuterXml);
        Console.ForegroundColor = ConsoleColor.Gray; 
    }
}

The following code example shows how to register IPolicyImportExtension implementations using the <policyImporters> configuration section.

The following code example demonstrates how a custom binding element can implement IPolicyExportExtension to attach a custom policy assertion to the binding assertions.

public class MyBindingElement : BindingElement, IPolicyExportExtension
{
// BindingElement implementation . . .

	public void ExportPolicy(
	 MetadataExporter exporter, PolicyConversionContext context)
	{
		XmlDocument xmlDoc = new XmlDocument();
		XmlElement xmlElement = 
		       xmlDoc.CreateElement("MyPolicyAssertion");
		context.GetBindingAssertions().Add(xmlElement);
	}


	// Note: All custom binding elements must return a deep clone 
	// to enable the run time to support multiple bindings using the 
	// same custom binding.
	public override BindingElement Clone()
	{
		// this is just a placeholder
		return null;
	}


	// Call the inner property.
	public override T GetProperty<T>(BindingContext context)
	{
		return context.GetInnerProperty<T>();
	}

}

public class Program {
	public static void Main(string[] args) {
		EndpointAddress address = 
			new EndpointAddress("http://localhost/metadata");
		CustomBinding customBinding = 
			new CustomBinding(new BasicHttpBinding());
		customBinding.Elements.Add(new MyBindingElement());
		ContractDescription contract =
			ContractDescription.GetContract(typeof(MyContract));
		ServiceEndpoint endpoint = 
			new ServiceEndpoint(contract, customBinding, address);
		MetadataExporter exporter = new WsdlExporter();
		exporter.ExportEndpoint(endpoint);
	}
}

.NET Framework
Available since 3.0

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show:
© 2016 Microsoft