HttpCookieSession

Artículo
10/07/2008

Este ejemplo muestra cómo generar un canal de protocolo personalizado para usar cookies de HTTP para la administración de sesiones. Este canal habilita la comunicación entre los servicios Windows Communication Foundation (WCF) y clientes ASMX o entre los clientes WCF y servicios ASMX.

Cuando un cliente llama a un método web en un servicio web de ASMX que se basa en la sesión, el motor ASP.NET hace lo siguiente:

Genera un id. único (id. de sesión).
Genera el objeto de sesión y lo asocia con el id. único.
Agrega el id. único a un encabezado de respuesta HTTP Set-Cookie y lo envía al cliente.
Identifica el cliente en las llamadas subsiguientes basadas en el id. de sesión que lo envía.

El cliente incluye este id. de sesión en sus solicitudes subsiguientes al servidor. El servidor utiliza el id. de sesión del cliente para cargar el objeto de sesión adecuado para el contexto de HTTP actual.

Modelo de intercambio de mensajes de canal de HttpCookieSession

Este ejemplo habilita las sesiones para los escenarios de tipo ASMX. En la parte inferior de nuestra pila de canales, tenemos el transporte HTTP que admite IRequestChannel y IReplyChannel. Es trabajo del canal proporcionar sesiones en los niveles más altos de la pila de canales. El ejemplo implementa dos canales, (IRequestSessionChannel y IReplySessionChannel) que admiten sesiones.

Canal de servicio

El ejemplo proporciona un canal de servicio en la clase HttpCookieReplySessionChannelListener. Esta clase implementa la interfaz IChannelListener y convierte el canal IReplyChannel desde la parte inferior de la pila de canales en un IReplySessionChannel. Este proceso puede estar dividido en las partes siguientes:

Cuando se abre el agente de escucha del canal, acepta un canal interno desde su agente de escucha interno. Dado que éste es un agente de escucha de datagrama y la duración de un canal aceptado se desacopla de la duración del agente de escucha, podemos cerrar el agente de escucha interno y sólo mantener el canal interno
```
            this.innerChannelListener.Open(timeoutHelper.RemainingTime());
this.innerChannel = this.innerChannelListener.AcceptChannel(timeoutHelper.RemainingTime());
this.innerChannel.Open(timeoutHelper.RemainingTime());
this.innerChannelListener.Close(timeoutHelper.RemainingTime());
```

Cuando el proceso abierto se completa, configuramos un bucle de mensajes para recibirlos desde el canal interno.

IAsyncResult result = BeginInnerReceiveRequest();
if (result != null && result.CompletedSynchronously)
{
   // do not block the user thread
   if (this.completeReceiveCallback == null)
   {
      this.completeReceiveCallback = new WaitCallback(CompleteReceiveCallback);
   }
   ThreadPool.QueueUserWorkItem(this.completeReceiveCallback, result);
}

Cuando llega un mensaje, el canal del servicio examina el identificador de la sesión y demultiplexa en el canal de sesión adecuado. El agente de escucha del canal mantiene un diccionario que asigna los identificadores de la sesión a las instancias del canal de sesión.
```
Dictionary<string, IReplySessionChannel> channelMapping;
```

La clase HttpCookieReplySessionChannel implementa IReplySessionChannel. Los niveles más altos de la pila de canales llaman al método ReceiveRequest para leer las solicitudes de esta sesión. Cada canal de la sesión tiene una cola de mensajes privada que el canal de servicio rellena.

InputQueue<RequestContext> requestQueue;

En el caso de que alguien llame al método ReceiveRequest y no haya ningún mensaje en la cola de mensajes, el canal espera un periodo de tiempo especificado antes de cerrarse. Esto limpia los canales de sesión creados para clientes que no sean de WCF.

Utilizamos channelMapping para realizar el seguimiento de ReplySessionChannels y no cerramos nuestro innerChannel subyacente hasta que se hayan cerrado todos los canales aceptados. De esta manera HttpCookieReplySessionChannel, puede existir más allá de la duración de HttpCookieReplySessionChannelListener. Además, no nos tenemos que preocupar por el hecho de que el agente de escucha recopile elementos no utilizados debajo de nosotros porque los canales aceptados mantienen una referencia para su agente de escucha mediante la devolución de llamada OnClosed.

Canal del cliente

El canal de cliente correspondiente está en la clase HttpCookieSessionChannelFactory. Durante la creación del canal, el generador de canales ajusta el canal de solicitud interno con HttpCookieRequestSessionChannel. La clase HttpCookieRequestSessionChannel reenvía las llamadas al canal de solicitud subyacente. Cuando el cliente cierra el proxy, HttpCookieRequestSessionChannel envía un mensaje al servicio que indica que se cierra el canal. Así, la pila del canal del servicio puede cerrar correctamente el canal de la sesión que está en uso.

Enlace y elemento de enlace

Después de crear los canales de cliente y servicio, el paso siguiente es integrarlos en el tiempo de ejecución de WCF. Los canales se exponen en WCF a través de los enlaces y elementos de enlace. Un enlace está compuesto de uno o varios elementos de enlace. WCF proporciona varios enlaces definidos por el sistema; por ejemplo, BasicHttpBinding o WSHttpBinding. La clase HttpCookieSessionBindingElement contiene la implementación para el elemento de enlace. Invalida el agente de escucha del canal y los métodos de creación del generador de canales para crear las instancias del agente de escucha del canal y el generador de canales necesarios.

El ejemplo utiliza las aserciones de directiva para la descripción del servicio. Esto permite al ejemplo publicar sus requisitos de canal en otros clientes que pueden utilizar el servicio. Por ejemplo, este elemento de enlace publica las aserciones de directiva para que los clientes potenciales sepan que admite sesiones. Dado que el ejemplo habilita la propiedad ExchangeTerminateMessage en la configuración del elemento de enlace, agrega las aserciones necesarias para mostrar que el servicio admite una acción de intercambio de mensajes adicional para finalizar la conversación de la sesión. Los clientes pueden utilizar a continuación esta acción. El código WSDL siguiente muestra las aserciones de directiva creadas a partir de HttpCookieSessionBindingElement.

<wsp:Policy wsu:Id="HttpCookieSessionBinding_IWcfCookieSessionService_policy" xmlns:wsp="https://schemas.xmlsoap.org/ws/2004/09/policy" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
<wsp:ExactlyOne>
<wsp:All>
<wspe:Utf816FFFECharacterEncoding xmlns:wspe="https://schemas.xmlsoap.org/ws/2004/09/policy/encoding"/>
<mhsc:httpSessionCookie xmlns:mhsc="http://samples.microsoft.com/wcf/mhsc/policy"/>
</wsp:All>
</wsp:ExactlyOne>
</wsp:Policy>

La clase HttpCookieSessionBinding es un enlace proporcionado por el sistema que utiliza el elemento de enlace descrito previamente.

Adición del canal al sistema de configuración

El ejemplo proporciona dos clases que exponen el canal del ejemplo a través de la configuración. El primero es BindingElementExtensionElement para HttpCookieSessionBindingElement. El volumen de la implementación se delega a HttpCookieSessionBindingConfigurationElement, que deriva de StandardBindingElement. HttpCookieSessionBindingConfigurationElement tiene propiedades que se corresponden con las propiedades en HttpCookieSessionBindingElement.

Sección de extensión de elemento de enlace

La sección HttpCookieSessionBindingElementSection es un BindingElementExtensionElement que expone HttpCookieSessionBindingElement en el sistema de configuración. Con algunas invalidaciones se define el nombre de la sección de configuración, el tipo del elemento de enlace y cómo crear el elemento de enlace. Podemos 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="httpCookieSession" 
               type=
"Microsoft.ServiceModel.Samples.HttpCookieSessionBindingElementElement, 
                    HttpCookieSessionExtension, Version=1.0.0.0, 
                    Culture=neutral, PublicKeyToken=null"/>
        </bindingElementExtensions >
      </extensions>

      <bindings>
      <customBinding>
        <binding name="allowCookiesBinding">
          <textMessageEncoding messageVersion="Soap11WSAddressing10" />
          <httpCookieSession sessionTimeout="10" exchangeTerminateMessage="true" />
          <httpTransport allowCookies="true" />
        </binding>
      </customBinding>
      </bindings>      
    </system.serviceModel>  
</configuration>

Código de prueba

El código de prueba para utilizar este transporte del ejemplo está disponible en los directorios de cliente y servicio. Está compuesto de dos pruebas: una utiliza un enlace con allowCookies establecido en true en el cliente. La segunda prueba habilita el cierre explícito (utilizando el intercambio de mensajes de finalización) en el enlace.

Al ejecutar el ejemplo, deberá ver el resultado siguiente:

Simple binding:
AddItem(10000,2): ItemCount=2
AddItem(10550,5): ItemCount=7
RemoveItem(10550,2): ItemCount=5
Items
10000, 2
10550, 3
Smart binding:
AddItem(10000,2): ItemCount=2
AddItem(10550,5): ItemCount=7
RemoveItem(10550,2): ItemCount=5
Items
10000, 2
10550, 3

Press <ENTER> to terminate client.

Para configurar, generar y ejecutar el ejemplo

Asegúrese de que ha realizado el Procedimiento de instalación único para ejemplos de Windows Communication Foundation.
Para generar la solución, siga las instrucciones de Generación de ejemplos de Windows Communication Foundation.
Para ejecutar el ejemplo en una configuración de equipos única o cruzada, siga las instrucciones de Ejecución de ejemplos de Windows Communication Foundation.

Footer image

Compartir a través de