3.15.2009

Como agregar un binding TCP de forma programada a un sitio web en IIS 7.0

La información del binding en un sitio web es indispensable para indicar cuales protocolos pueden ser utilizados para comunicarse con el sitio Web. En el contexto de WCF esto significa, que tipos de protocolos vamos a poder utilizar para consumir los servicios desarrollados en WCF y hosteados en IIS 7.0 y WAS.

En días pasados conversando con algunas personas que usan IIS 7.0 para hostear servicios en WAS utilizando el protocolo TCP, me preguntaron como agregar el binding de TCP a un sitio web utilizando el API de IIS 7.0 y C#. La consulta me pareció muy útil por que permite crear instaladores que hagan deploy de los servicios de forma transparente, incluso creando sus sitios webs a la hora de la instalación y agregando el binding deseado con este instalador. Aquí esta la solución a esta consulta.

Primeramente, vamos ver que es lo que necesitamos para tener el protocolo TCP habilitado en el sitio web. Para esto, en el archvio applicationHost.config  existe la sección bindings la cual existe por sitio web definido y tiene el siguiente formato:

<bindings>
    <binding protocol="http" bindingInformation="*:80:" />
    <binding protocol="net.tcp" bindingInformation="808:*" />
    <binding protocol="net.pipe" bindingInformation="*" />
    <binding protocol="net.msmq" bindingInformation="localhost" />
    <binding protocol="msmq.formatname" bindingInformation="localhost" />
</bindings>

Como podemos ver en el elemento XML anterior, existe una etiqueta binding para cada protocolo que queremos soportar en el sitio web. Además, cada elemento tiene dos atributos: protocol y bindginInformation. El protocolo define el protocolo que se utiliza para comunicarse con el sitio web, y el bindingInformation contiene la dirección IP, el número del puerto y opcionalmente el host header para el sitio web.

Para poder agregar TCP al sitio web deseado debemos primeramente buscar el elemento que contiene los sitios web en el archivo de configuración del servidor, seguidamente buscamos el sitio web deseado, y procedemos a agregarle el binding. El código para esta operación es el siguiente:

public static void AgregarBindiingASitioWeb( string nombreSitioWeb, string protocolo, string bindingInformation )
{
using (ServerManager server = new ServerManager( ))
{
Configuration hostConfiguration = server.GetApplicationHostConfiguration( );
ConfigurationSection sitesSection = hostConfiguration.GetSection("system.applicationHost/sites"); //utilizamos XPath para obtener el elemento
ConfigurationElementCollection sitesCollection = sitesSection.GetCollection( ); //Obtenemos todos los sitios web en el archivo
//Buscamos el sitio web deseado
ConfigurationElement siteElement = FindElement(sitesCollection, "site", "name", @nombreSitioWeb);
//Si no existe, lanzamos una excepción y abortamos el método.
if (siteElement == null) throw new InvalidOperationException("Sitio no encontrado!");
//Obtenemos la configuración del binding del sitio web
ConfigurationElementCollection bindingsCollection = siteElement.GetCollection("bindings");
//Creamos un elemento de binding para el sitio y le establecemos los valores deseados
ConfigurationElement bindingElement = bindingsCollection.CreateElement("binding");
bindingElement["protocol"] = @protocolo;
bindingElement["bindingInformation"] = @bindingInformation;
//Agregamos el binding a la colección de bindings del sitio web
bindingsCollection.Add(bindingElement);
//Guardamos los cambios en el archivo applicationHost.config
server.CommitChanges( );
}
}


private static ConfigurationElement FindElement( ConfigurationElementCollection collection, string elementTagName, params string[] keyValues )
{
//Iteramos sobre la coleccion de elementos para buscar la etiqueta site que tenga en el atributo
//name el valor pasado por parámetro
foreach (ConfigurationElement element in collection)
{
//Si el elemento encontrado es el sitio
if (String.Equals(element.ElementTagName, elementTagName, StringComparison.OrdinalIgnoreCase))
{
bool matches = true;
//Entonces buscamos el atributo deseado
for (int i = 0; i < keyValues.Length; i += 2)
{
object o = element.GetAttributeValue(keyValues[i]);
string value = null;
if (o != null)
{
value = o.ToString( );
}
if (!String.Equals(value, keyValues[i + 1], StringComparison.OrdinalIgnoreCase))
{
matches = false;
break;
}
}
if (matches)
{
return element;
}
}
}
return null;
}


El código para llamar al método de crear binding es:



AgregarBindiingASitioWeb("MiNuevositioWeb", "net.tcp", "808:*");



Antes de ejecutar el código anterior, el elemento Site de MiNuevoSitioWeb lucía así:



image Después de ejecutar el código anterior el resultado es:



imageComo podemos ver en la figura anterior, el binding para TCP se agregó al elemento del sitio web solicitado.

No hay comentarios: