Compatibilidad con metadatos y configuración
En este tema se describe cómo habilitar la compatibilidad con configuración y metadatos para los enlaces y elementos de enlaces.
Información general de configuración y metadatos
En este tema se discuten las tareas que se muestran a continuación, que constituyen los elementos opcionales 1, 2 y 4 de la lista de tareas de Desarrollo de canales.
Habilitación de la compatibilidad con archivos de configuración para un elemento de enlace.
Habilitación de la compatibilidad con archivos de configuración para un enlace.
Exportación de WSDL y aserciones de directivas para un elemento de enlace.
Identificación de WSDL y aserciones de directivas para insertar y configurar su enlace o elemento de enlace.
Para obtener información sobre cómo crear enlaces y elementos de enlace definidos por el usuario, consulte Creación de enlaces definidos por el usuario y Creación de un BindingElement, respectivamente.
Agregación de la compatibilidad de configuración
Para habilitar la compatibilidad con archivos de configuración para un canal, debe implementar dos secciones de configuración, System.ServiceModel.Configuration.BindingElementExtensionElement, que habilita la compatibilidad de configuración para los elementos de enlace, y System.ServiceModel.Configuration.StandardBindingElement y System.ServiceModel.Configuration.StandardBindingCollectionElement<TStandardBinding,TBindingConfiguration>, que habilitan la compatibilidad de configuración para los enlaces.
Una manera más fácil de hacerlo consiste en usar la herramienta de muestra ConfigurationCodeGenerator para generar el código de configuración de los enlaces y elementos de enlace que cree.
Extender BindingElementExtensionElement
El siguiente código de ejemplo se ha tomado del ejemplo Transporte: UDP. El elemento UdpTransportElement es una clase BindingElementExtensionElement que expone UdpTransportBindingElement en el sistema de configuración. Con unas pocas invalidaciones básicas, el ejemplo define el nombre de la sección de configuración, el tipo del elemento de enlace y cómo crear el elemento de enlace. Los usuarios pueden registrar a continuación la sección de extensión en un archivo de configuración de la siguiente manera.
<configuration>
<system.serviceModel>
<extensions>
<bindingElementExtensions>
<add name="udpTransport" type="Microsoft.ServiceModel.Samples.UdpTransportElement, UdpTransport" />
</bindingElementExtensions>
</extensions>
</system.serviceModel>
</configuration>
Se puede hacer referencia a la extensión desde enlaces personalizados para utilizar UDP como el transporte.
<configuration>
<system.serviceModel>
<bindings>
<customBinding>
<binding configurationName="UdpCustomBinding">
<udpTransport/>
</binding>
</customBinding>
</bindings>
</system.serviceModel>
</configuration>
Agregación de la configuración para un enlace
La sección SampleProfileUdpBindingCollectionElement es un objeto StandardBindingCollectionElement<TStandardBinding,TBindingConfiguration> que expone SampleProfileUdpBinding en el sistema de configuración. El volumen de la implementación se delega a SampleProfileUdpBindingConfigurationElement, que deriva de StandardBindingElement. En el objeto SampleProfileUdpBindingConfigurationElement, se incluyen propiedades que se corresponden con las propiedades del objeto SampleProfileUdpBinding y funciones que se asignan desde el enlace del objeto ConfigurationElement. Finalmente, el método OnApplyConfiguration es invalidado en el SampleProfileUdpBinding, tal y como se muestra en el siguiente código muestra.
protected override void OnApplyConfiguration(string configurationName)
{
if (binding == null)
throw new ArgumentNullException("binding");
if (binding.GetType() != typeof(SampleProfileUdpBinding))
{
var expectedType = typeof(SampleProfileUdpBinding).AssemblyQualifiedName;
var typePassedIn = binding.GetType().AssemblyQualifiedName;
throw new ArgumentException($"Invalid type for binding. Expected type: {expectedType}. Type passed in: {typePassedIn}.");
}
SampleProfileUdpBinding udpBinding = (SampleProfileUdpBinding)binding;
udpBinding.OrderedSession = this.OrderedSession;
udpBinding.ReliableSessionEnabled = this.ReliableSessionEnabled;
udpBinding.SessionInactivityTimeout = this.SessionInactivityTimeout;
if (this.ClientBaseAddress != null)
udpBinding.ClientBaseAddress = ClientBaseAddress;
}
Para registrar este controlador con el sistema de configuración, agregue la siguiente sección al archivo de configuración pertinente.
<configuration>
<configSections>
<sectionGroup name="system.serviceModel">
<sectionGroup name="bindings">
<section name="sampleProfileUdpBinding" type="Microsoft.ServiceModel.Samples.SampleProfileUdpBindingCollectionElement, UdpTransport" />
</sectionGroup>
</sectionGroup>
</configSections>
</configuration>
A continuación, se puede establecer una referencia a este desde la sección de configuración del espacio de nombres <system.serviceModel>.
<configuration>
<system.serviceModel>
<client>
<endpoint configurationName="calculator"
address="soap.udp://localhost:8001/"
bindingConfiguration="CalculatorServer"
binding="sampleProfileUdpBinding"
contract= "Microsoft.ServiceModel.Samples.ICalculatorContract">
</endpoint>
</client>
</system.serviceModel>
</configuration>
Agregación de compatibilidad con metadatos para un elemento de enlace
Para integrar un canal en el sistema de metadatos, debe admitir la importación y exportación de la directiva. Al hacer esto, permitirá el uso de las herramientas, como la herramienta de utilidad de metadatos de ServiceModel (Svcutil.exe), para generar clientes del elemento de enlace.
Agregación de la compatibilidad con WSDL
El elemento de enlace del transporte en un enlace es el responsable de la exportación e importación de la información de direccionamiento en metadatos. Al utilizar un enlace SOAP, el elemento de enlace del transporte también debería exportar un URI de transporte correcto en los metadatos. El siguiente código de ejemplo se ha tomado del ejemplo Transporte: UDP.
Exportación de WSDL
En el objeto UdpTransportBindingElement, se implementa la interfaz System.ServiceModel.Description.IWsdlExportExtension para exportar la información de direccionamiento. El método IWsdlExportExtension.ExportEndpoint agrega la información de direccionamiento correcta al puerto WSDL.
if (context.WsdlPort != null)
{
AddAddressToWsdlPort(context.WsdlPort, context.Endpoint.Address, encodingBindingElement.MessageVersion.Addressing);
}
La implementación UdpTransportBindingElement del método ExportEndpoint también exporta un URI de transporte cuando el punto de conexión utiliza un enlace SOAP:
WsdlNS.SoapBinding soapBinding = GetSoapBinding(context, exporter);
if (soapBinding != null)
{
soapBinding.Transport = UdpPolicyStrings.UdpNamespace;
}
Importación de WSDL
Para extender el sistema de importación de WSDL para que administre la importación de las direcciones, agregue la configuración siguiente al archivo de configuración para Svcutil.exe tal y como se muestra en el archivo Svcutil.exe.config:
<configuration>
<system.serviceModel>
<client>
<metadata>
<wsdlImporters>
<extension type=" Microsoft.ServiceModel.Samples.UdpBindingElementImporter, UdpTransport" />
</wsdlImporters>
</metadata>
</client>
</system.serviceModel>
</configuration>
Al ejecutar Svcutil.exe, hay dos opciones para conseguir que Svcutil.exe cargue las extensiones de importación de WSDL:
Para señalar el archivo de configuración para su uso con Svcutil.exe, use el archivo /SvcutilConfig:<archivo>.
Agregue la sección de configuración a Svcutil.exe.config en el mismo directorio como Svcutil.exe.
El tipo UdpBindingElementImporter implementa la interfaz System.ServiceModel.Description.IWsdlImportExtension. El método ImportEndpoint importa la dirección del puerto del WSDL:
BindingElementCollection bindingElements = context.Endpoint.Binding.CreateBindingElements();
TransportBindingElement transportBindingElement = bindingElements.Find<TransportBindingElement>();
if (transportBindingElement is UdpTransportBindingElement)
{
ImportAddress(context);
}
Agregación de compatibilidad de directiva
El elemento de enlace personalizado puede exportar aserciones de directiva en el enlace de WSDL para que un extremo de servicio exprese las funciones de ese elemento de enlace. El siguiente código de ejemplo se ha tomado del ejemplo Transporte: UDP.
Exportación de directivas
En el tipo UdpTransportBindingElement, se implementa la interfaz System.ServiceModel.Description.IPolicyExportExtension para que se admita la exportación de directivas. Como resultado, System.ServiceModel.Description.MetadataExporter incluye UdpTransportBindingElement en la generación de directiva para cualquier enlace que la incluya.
En IPolicyExportExtension.ExportPolicy, agregue una aserción para UDP y otra aserción si el canal está en modo de multidifusión. Esto se debe a que el modo de multidifusión afecta a cómo se construye la pila de comunicaciones, y, por tanto, debe coordinarse entre ambos lados.
ICollection<XmlElement> bindingAssertions = context.GetBindingAssertions();
XmlDocument xmlDocument = new XmlDocument();
bindingAssertions.Add(xmlDocument.CreateElement(
UdpPolicyStrings.Prefix, UdpPolicyStrings.TransportAssertion, UdpPolicyStrings.UdpNamespace));
if (Multicast)
{
bindingAssertions.Add(xmlDocument.CreateElement(
UdpPolicyStrings.Prefix, UdpPolicyStrings.MulticastAssertion, UdpPolicyStrings.UdpNamespace));
}
Dado que los elementos de enlace de transporte personalizados son responsables de la administración del direccionamiento, la implementación System.ServiceModel.Description.IPolicyExportExtension en el UdpTransportBindingElement también debe administrar la exportación de las aserciones de directivas WS-Addressing adecuadas para indicar la versión de WS-Addressing que se está utilizando.
AddWSAddressingAssertion(context, encodingBindingElement.MessageVersion.Addressing);
Importación de directivas
Para extender el sistema de importación de directivas, agregue la siguiente configuración al archivo de configuración para Svcutil.exe tal y como se muestra en el archivo Svcutil.exe.config:
<configuration>
<system.serviceModel>
<client>
<metadata>
<policyImporters>
<extension type=" Microsoft.ServiceModel.Samples.UdpBindingElementImporter, UdpTransport" />
</policyImporters>
</metadata>
</client>
</system.serviceModel>
</configuration>
A continuación, implementamos System.ServiceModel.Description.IPolicyImportExtension desde nuestra clase registrada (UdpBindingElementImporter). En IPolicyImportExtension.ImportPolicy, examine las aserciones en el espacio de nombres adecuado y procese las que se encargan de la generación del transporte y de la comprobación de si es multidifusión. Además, elimine las aserciones que el importador administra desde la lista de aserciones de enlaces. De nuevo, al ejecutar Svcutil.exe, hay dos opciones para la integración:
Para señalar el archivo de configuración para su uso con Svcutil.exe, use el archivo /SvcutilConfig:<archivo>.
Agregue la sección de configuración a Svcutil.exe.config en el mismo directorio como Svcutil.exe.
Agregación de un importador de enlace estándar personalizado
Svcutil.exe y el tipo System.ServiceModel.Description.WsdlImporter, de forma predeterminada, reconocen e importan los enlaces proporcionados por el sistema. De lo contrario, el enlace se importa como una instancia System.ServiceModel.Channels.CustomBinding. Para permitir que Svcutil.exe y WsdlImporter importen el SampleProfileUdpBinding, el UdpBindingElementImporter actúa también como un importador de enlaces estándar personalizado.
En un importador de enlaces estándar personalizado, se implementa el método ImportEndpoint de la interfaz System.ServiceModel.Description.IWsdlImportExtension para examinar la instancia del objeto System.ServiceModel.Channels.CustomBinding que se importó desde los metadatos y comprobar si este podría haberse generado a partir de un enlace estándar concreto.
if (context.Endpoint.Binding is CustomBinding)
{
Binding binding;
if (transportBindingElement is UdpTransportBindingElement)
{
//if TryCreate is true, the CustomBinding will be replace by a SampleProfileUdpBinding in the
//generated config file for better typed generation.
if (SampleProfileUdpBinding.TryCreate(bindingElements, out binding))
{
binding.Name = context.Endpoint.Binding.Name;
binding.Namespace = context.Endpoint.Binding.Namespace;
context.Endpoint.Binding = binding;
}
}
}
Generalmente, la implementación de un importador de enlaces estándar personalizado, implica la comprobación de las propiedades de los elementos de enlace importados para comprobar que solo las propiedades que pudo establecer el enlace estándar han cambiado y el resto propiedades son sus valores predeterminados. Una estrategia básica para implementar un importador de enlace estándar consiste en crear una instancia de enlace estándar, propagar las propiedades desde los elementos de enlace a la instancia de enlace estándar que admite enlaces estándar y, a continuación, comparar los elementos de enlace desde el enlace estándar con los elementos de enlace importados.