EN CONSTTRUCCIÓN ... |
<fw:socket> es un componente UI que abre una conexión push basada en websocket unidireccional (de servidor a cliente) en el lado del cliente a la que se puede acceder desde el lado del servidor a través de la interfaz PushContext inyectada mediante la anotación @Push.
Primero hay que activar los websockets mediante el siguiente parámetro de contexto booleano en web.xml:
<context-param>
<param-name>es.um.atica.fundeweb.SOCKET_ENDPOINT_ENABLED</param-name>
<param-value>true</param-value>
</context-param> |
Lo que registrara un SocketEndpoint en el servidor. Mirar WS spec issue 211.
Declare la etiqueta <fw:socket> en la vista (página) con al menos un nombre de canal (channel) y una función JavaScript llamada onmessage. El nombre del canal no puede ser una expresión EL y solo puede contener caracteres alfanuméricos, guiones, guiones bajos y puntos. Aquí hay un ejemplo que hace referencia a una función de escucha de JavaScript existente (¡no incluya los paréntesis!).
<fw:socket channel="someChannel" onmessage="socketListener" /> |
function socketListener(message, channel, event) {
console.log(message);
} |
También se puede añadir la función JavaScript en el propio componente:
<fw:socket channel="someChannel" onmessage="function(message) { console.log(message); }" /> |
El listener JavaScript onmessage, se invocará con tres argumentos:
En caso de que su servidor esté configurado para ejecutar el contenedor WS en un puerto TCP diferente al contenedor HTTP, puede usar el atributo de puerto opcional para especificar explícitamente el puerto.
<fw:socket port="8000" ... /> |
Cuando se conecta correctamente, el websocket está abierto de forma predeterminada siempre que el documento esté abierto, y se volverá a conectar automáticamente a intervalos cada vez mayores cuando la conexión se cierre o se cancele como resultado de, por ejemplo, un error. un error de red o reinicio del servidor. No se volverá a conectar automáticamente cuando el primer intento de conexión ya falle. El websocket se cerrará implícitamente una vez que se descargue el documento (por ejemplo, al navegar, cerrar la ventana/pestaña del navegador, etc.). Para volver a conectarse con éxito después de reiniciar el servidor o al cambiar a un nuevo nodo de servidor, debe asegurarse de que la persistencia de la sesión esté habilitada en el servidor.
En el backend, se puede inyectar una instancia de PushContext a través de la anotación @Push, junto con el nombre del canal en cualquier componente Seam, donde se necesite enviar un mensaje push. Para enviar el mensaje, se invoca al método PushContext.send(Object) con cualquier objeto Java que represente el mensaje.
@Push
private PushContext someChannel;
public void sendMessage(Object message) {
someChannel.send(message);
} |
Por defecto, el nombre del canal se toma del nombre de la variable en la que se realiza la inyección. También se puede especificar opcionalmente mediante el atributo channel de la anotación @Push. El siguiente ejemplo se inyecta el contexto push del canal foo en la variable bar.
@Push(channel="foo") private PushContext bar; |
El mensaje se codificará como JSON y se entregará como parámetro a la función JavaScript onmessage asociada con el nombre del canal. Puede ser cualquier objeto, desde un String a colección o un mapa e incluso un POJO (JAVABEAN). Para conocer los tipos de parámetros admitidos (y descendientes) por Json.encode(Object) son: Boolean, Number, CharSequence, Date, Enum, Temporal, Collections, Map; Si el tipo de objeto no coincide con ninguno de ellos, entonces se inspeccionara el objeto como un POJO (JAVABEAN), donde las propiedades públicas (con getter público) se codificarán como un objeto JS. Los objetos de las clases Date y Temporal, cumples el estándar RFC 1123, por lo que, si es necesario, puedes usar new Date() en JavaScript.
Aunque los websockets admiten la comunicación bidireccional, el envío de <fw:socket> está diseñado para la comunicación unidireccional, de servidor a cliente. En caso de que desee enviar datos de cliente a servidor, contina realizando peticiones Faces AJAX como se hace de manera habitual. Si es necesario hacerlo desde JavaScript, puedes usar <p:remoteCommand>. De esa forma se mantiene el estado de vista de Faces, la sesión HTTP y, lo que es más importante, todas las restricciones de seguridad especificada para los servicios. Es decir, esas restricciones de seguridad no están disponibles durante un mensaje de websockets. Véase también. WS spec issue 238.
Por defecto, los websockets tienen ámbito aplicación (application scope), es decir, cualquier vista/sesión de la aplicación web, teniendo el mismo canal websocket abierto, recibirá el mismo mensaje push. El mensaje push puede ser enviado por cualquier usuario o por la propia aplicación. Está característica es útil para recibir notificaciones globales a nivel de aplicación lanzados por ella y que permiten actualizar una página concreta de esta, ejemplo: estadísticas del sitio web, listas top100, actualización de stock, etc.
El atributo opcional scope puede establecerse con el valor session, para restringir los mensajes push a todas las vistas de la sesión actual del usuario. El mensaje solo puede ser enviado por el usuario y no por la aplicación. Está característica es útil para recibir notificaciones a nivel de sesión sobre vistas lanzadas por el mismo usuario, ejemplo: el resultado de una tarea asíncrona lanzada por una acción del usuario).
<fw:socket channel="someChannel" scope="session" ... /> |
El atributo opcional scope puede establecerse con el valor session, para restringir los mensajes push sólo a la vista actual. Los mensajee push no son vistos por otras vistas en la misma sesión, incluso si son la misma URL. El mensaje solo puede ser enviado por el usuario y no por la aplicación. Está característica es útil para recibir notificaciones a nivel de vista (página) lanzadas por el mismo usuario, ejemplo: una barra de progreso sobre una acción especifica en la vista (página) actual).
<fw:socket channel="someChannel" scope="view" ... /> |
Los valores permitidos en el atributo scope son: application, session y view; (en minúsculas) y NO se permiten expresiones EL.
Además, el atributo opcional user puede establecerse con un identificador único, que hace referencia al usuario autenticado. Pude ser el nombre del usuario o un ID calculado. De esta forma, un mensaje push puede ser enviado a un usuario especifico y puede ser enviado por cualquier usuario o por la propia aplicación. El valor el atributo user tiene que implementar la interface Serializable y debe gastar poca memoria, por lo que la entidad que representa al usuario como la clase org.umu.atica.servicios.gesper.gente.entity.Persona o org.jboss.seam.security.Identity (y descendientes) no son recomendables. Podemos generar identificadores únicos mediante la clase java.util.UUID. Ejemplo de uso con el username:
<fw:socket channel="someChannel" user="#{credentials.username}" ... /> |
Cuando especificamos el atributo user el ámbito por defecto se establece en session y no se puede establecer en application. Puede establecerse con view, pero es inusual y solo debe utilizarse si el usuario autenticado representado por el valor user, tiene un ciclo de vida más corto que la sesión HTTP, ejemplo: cuando la aplicación permite cambiar entre usuarios autenticados durante la misma sesión HTTP sin invalidar al anterior usuario, que es un muy mala práctica de seguridad. Si en el caso, de reutilizar un socket de ámbito sesión, se pueden producir comportamientos indeseados cuando se envía un mensaje push dirigido a un usuario determinado. Este puede ser enviado a un usuario anterior. Este problema se resuelve estableciendo el ámbito a view, recomendando realizar una invalidación de la sesión HTTP del usuario.
Cuando el atributo user es establecido mediante una expresión EL, y este cambia durante un petición AJAX, entonces el usuario del socket también se actualizará, incluso si ninguna petición AJAX cubre la definición del <fw:socket>. Hay que asegurarse de que el valor esta ligado al menos a una propiedad de la vista en caso de querer controlarlo durante el ámbito de la vista.
En el lado del servidor, el mensaje push puede ser dirigido al usuario especificado en el atributo user mediante PushContext.send(Object, Serializable). El mensaje push puede ser enviado por todos los usuarios o por la propia aplicación. Es útil para notificar a un usuario determinado por otros usuarios, por ejemplo: chat, mensajes por parte del administrador, etc.; o por tareas en segundo plano de la aplicación como por ejemplo: notificaciones, listeners, etc..
@Push
private PushContext someChannel;
public void sendMessage(Object message, User recipientUser) {
Long recipientUserId = recipientUser.getId();
someChannel.send(message, recipientUserId);
} |
Los mensajes push pueden enviarse a varios usuarios al mismo tiempo, pasando una Collection que contenga los identificadores de los usuarios a PushContext.send(Object, Collection).
@Push
private PushContext someChannel;
public void sendMessage(Object message, Group recipientGroup) {
Collection<Long> recipientUserIds = recipientGroup.getUserIds();
someChannel.send(message, recipientUserIds);
} |
Se pueden declarar varios canales push con diferentes ámbitos con o sin especificar usuarios de la aplicación. Incluso el mismo nombre de canal se puede reutilizar entre varias vistas, incluso si su ámbito es de vista. Es más eficiente utilizar el menor número de nombres de canal y ligar el nombre del canal de la conexión push, a combinaciones especificas de ámbito/usuario y no para vistas Faces especificas. En caso de tener varios canales de ámbito vista para diferentes propósitos, lo mejor es tener un único canal de ámbito vista y tener una listener Javascript global que pueda distinguir los tareas de los diferentes mensajes enviados. Por ejemplo, enviando el mensaje al servidor como se muestra a continuación:
Map<String, Object> message = new HashMap<>();
message.put("functionName", "someFunction");
message.put("functionData", functionData); // Can be Map or Bean.
someChannel.send(message); |
que es procesado por el listener Javascript onmessage como se indica a continuación:
function someSocketListener(message) {
window[message.functionName](message.functionData);
}
function someFunction(data) {
// ...
}
function otherFunction(data) {
// ...
}
// ... |
Se puede usar el atributo opcional connected para controlar cuando se auto-conecta o no, la conexión web. Acepta valores booleanos que pueden obtenerse mediante expresiones EL
<fw:socket channel="someChannel" ... connected="#{bean.pushable}" /> |
El valor por defecto es true. Si el valor del atributo connected o rendered es una expresión EL, y se vuelve a false durante una solicitud AJAX, entonces cualquier conexión push abierta se cerrará explícitamente al acabar la petición AJAX, incluso aunque no haya actualizado el componente <fw:socket> en la petición AJAX. Hay que asegurarse de que el valor esta ligado al menos a una propiedad de la vista en caso de querer controlarlo durante el ámbito de la vista.
Se puede establecer el valor del atributo connected directamente a false y controlar manualmente la apertura de la conexión push en la parte cliente invocando con Javascript a FundeWeb.Push.open(channel), pasando el nombre del canal como parámetro. Por ejemplo, cuando se lance el listener onclick de un botón que inicia una ejecución de una tarea asíncrona de larga duración en la parte servidor. Es realmente útil, para conexiones de ámbito vista, que no necesitan realizar una carga en página de manera inmediata.
<p:commandButton ... onclick="OmniFaces.Push.open('foo')">
<p:ajax ... />
</p:commandButton>
<fw:socket channel="foo" scope="view" ... connected="false" /> |
En el caso de querer tener una comunicación push de un solo mensaje, normalmente porque se quiere presentar el resultado de una tarea asíncrona lanzada desde la vista, como es el caso del ejemplo anterior, se puede cerrar la conexión push invocando en el cliente FundeWeb.Push.open(channel), pasando el nombre del canal como parámetro. Por ejemplo, podemos usar el listener Javascript onmessage para relizar la acción:
function someSocketListener(message, channel) {
// ...
OmniFaces.Push.close(channel);
} |
Es importante no mezclar las dos formas de controlar la conexión push. O se usa una expresión EL en el atributo connected, o se especifica connected="false" y la API Javascript FundeWeb.Push para controlar la apertura/cierre de la conexión push. Mezclar ambas configuraciones puede provocar comportamientos impredecibles porque el estado de la vista Faces en el servidor no puede ser notificada de la apertura o cierre manual desde el cliente.
El listener opcional de Javascript onopen, se usa cuando se abre el websocket en el cliente. Se lanza en el primer intento de conexión, independientemente de que la conexión se pueda realizar o no. No se invoca, en las auto-reconexiones que se hagan posteriormente. Acepta como único parámetro channel, el nombre del canal.
<fw:socket channel="foo" scope="view" ... connected="false" onopen="socketOpenListener" /> |
function socketOpenListener(channel) {
// ...
} |
El listener opcional de Javascript onerror, se usa para detectar los errores de conexión antes de un nuevo reintento de conexión. Se invocará cuando el socket web pueda realizar un intento de reconexión automática en una conexión interrumpida después de la primera conexión correcta. No se invocará cuando falle el primer intento de conexión, o el servidor haya devuelto el código de motivo de cierre 1000 (cierre normal) o 1008 (política violada), o se haya excedido el número máximo de intentos de reconexión. En su lugar, se invocará listener Javascript onclose.
<fw:socket channel="foo" scope="view" ... connected="false" onerror="socketErrorListener" /> |
function socketErrorListener(code, channel, event) {
if (code == 1001) {
// Server has returned an unexpected response code. E.g. 503, because it's shutting down.
} else if (code == 1006) {
// Server is not reachable anymore. I.e. it's not anymore listening on TCP/IP requests.
} else {
// Any other reason which is usually not -1, 1000 or 1008, as the onclose will be invoked instead.
}
// In any case, the web socket will attempt to reconnect. This function will be invoked again.
// Once the web socket gives up reconnecting, the onclose will finally be invoked.
} |
El listener de Javascript onerror acepta tres parámetros:
El listener opcional de Javascript onclose, se puede usar para detectar el cierro normal o no del websocket.