| Advertencia |
|---|
EN CONSTTRUCCIÓN ... |
| Advertencia |
|---|
No añadir código en la aplicación, hasta leer toda la documentación. |
...
| Bloque de código |
|---|
|
public final class PushEventMyPushEvent implements orges.um.jbossatica.seamfaces.corepush.EventObjectPushEvent {
private final String user;
private final String message;
public PushEventMyPushEvent(String message) {
this.message = message(null, message);
}
public MyPushEvent(String publicuser, String getMessage(message) {
this.user return= messageuser;
this.messag e= message;
}
}
public String getMessage() {
return message;
}
public String getUser() {
return user;
}
} |
Después, Después, utiliza org.jboss.seam.core.Events.raiseEvent(org.jboss.seam.core.EventObject), para lanzar el evento
...
Esta sería la única forma en caso de que desee enviar de forma asincrónica un mensaje a una conexión push con ámbito de view o session, y/o desee pasar algo desde FacesContext o de ámbito EVENT/PAGE/SESSION como argumento (con modificador final).
Sugerencias de Diseño
...
de la UI
Si se quieren realizar actualizaciones complejas de la UI, la forma más sencilla es usando <f:ajax> dentro de <fw:socket>. Ejemplo:
| Bloque de código |
|---|
|
<h:panelGroup id="foo">
... (some complex UI here) ...
</h:panelGroup>
<h:form>
<fw:socket channel="someChannel" scope="view">
|
| Bloque de código |
|---|
|
<jms:managed-topic-publisher name="pushPublisher"
auto-create<f:ajax event="truesomeEvent" installDependencieslistener="es.um.atica.faces.push.pushInitialization"
topic-jndi-name="jms/pruebaPushTopic"/>
<jms:topic-connection topic-connection-factory-jndi-name="jms/pruebaPushConnectionFactory"
installDependencies="es.um.atica.faces.push.pushInitialization"/> |
Ahora se puede inyectar el componente pruebaPushPublisher en cualquier componente:
#{bean.pushed}" render=":foo" />
</fw:socket>
</h:form> |
Donde el mensaje push, solo contien el nombre del evento Ajax. Puedes usar cualquier nombre de evento personalizado.
| Bloque de código |
|---|
|
someChannel.send("someEvent"); |
Otra alternativa, es combinar <fw:socket> con <p:remoteCommand>, ejemplo:
| Bloque de código |
|---|
|
<h:panelGroup id="foo">
... (some complex UI here) ...
</h:panelGroup>
<fw:socket channel="someChannel" scope="view" onmessage="someCommandScript" />
<h:form>
<p:remoteCommand name="someCommandScript" action="#{bean.pushed}" update=":foo" />
</h:form> |
Si se pasa un Map<String, V> o un POJO (JAVABEAN) como el objeto en el mensaje push, después todas las entradas/propiedades estarán disponibles como parámetros de la solicitud en la acción del comando #{bean.pushed}.
Sugerencias de Diseño en Cluster
En el caso que la aplicación este desplegada en un cluster con varios nodos, y el evento push se lanza desde un nodo diferente al que esta conectado el cliente (Navegador Web), entonces este no será notificado. Una solución es usar temas (topic) JMS, lanzar el evento push a través de JMS, y usar MDB (message driven bean) para reenviar el evento push a JBoss Seam en cada nodo.
Con JBoss Seam tenemos varios componentes para ayudar a trabajar con JMS. Ejemplo para la configuración de JMS con JBoss Seam, en el fichero components.xml registramos el manager del tema (topic) JMS, como norma general, el nombre del tema comenzara con el nombre de la aplicación en minúsculas seguido de PushTopic, en el ejemplo usaremos pruebaPushTopic. Para el nombre del publisher, podemos usar el nombre que queramos. Veamos un ejemplo de configuración:
| Bloque de código |
|---|
|
<jms:managed-topic-publisher name="pushPublisher"
|
| Bloque de código |
|---|
|
@Name("pushChangeNotifier")
public class PushManager {
@In
private TopicPublisher pruebaPushPublisher;
@In
private TopicSession topicSession;
public void fireEvent(PushEvent event) {
try {
pruebaPushPublisher.publish(topicSession.createObjectMessage(event.getMessage()));
} catch (Exception ex) {
throw new RuntimeException(ex);
}
}
} |
...
| Bloque de código |
|---|
|
package es.auto-create="true" installDependencies="es.um.atica.pruebafaces.push;
import javax.ejb.ActivationConfigProperty;
import javax.ejb.MessageDriven;
import javax.ejb.TransactionAttribute;
import javax.ejb.TransactionAttributeType;
import javax.jms.JMSException;
import javax.jms.Message;
import javax.jms.MessageListener;
import org.jboss.seam.annotations.Logger;
import org.jboss.seam.annotations.Name;
import org.jboss.seam.core.Events;
import org.jboss.seam.log.Log;
import org.jboss.seam.util.Strings;
import es.um.atica.faces.push.PushEvent;
@MessageDriven(activationConfig = {
@ActivationConfigProperty(
propertyName = "destinationType",
.pushInitialization"
topic-jndi-name="jms/pruebaPushTopic"/>
<jms:topic-connection topic-connection-factory-jndi-name="jms/pruebaPushConnectionFactory"
propertyValue = "javax.jms.Topic"
),
@ActivationConfigProperty(
propertyName = "destinationLookup",
propertyValue = "jms/pruebaPushTopic"
)
})
@Name("pushReceiver")
@TransactionAttribute(value = TransactionAttributeType.NOT_SUPPORTED)
public class PushReceiver implements MessageListener {
@Logger
private Log log;
protected void raiseEvent(String eventType, installDependencies="es.um.atica.faces.push.pushInitialization"/> |
Ahora se puede inyectar el componente pushPublisher en cualquier componente:
| Bloque de código |
|---|
|
@Name("pushEventsManager ")
public class PushEventsManager {
@In
private TopicPublisher pushPublisher;
@In
private TopicSession topicSession;
public void fireEvent(PushEvent event) {
if (Strings.isEmpty(eventType)) {
log.info("Raise push event '#0'", event.getClass().toString());
Events.instance().raiseEvent(event);
} else {
log.info("Raise push event '#0'", eventType);
Events.instance().raiseEvent(eventType, event);
}
}
@Override
public void onMessage(Message jmsMessage) {
try {
String eventType = jmsMessage.getStringProperty("eventType");
PushEvent event = jmsMessage.getBody(PushEvent.class);
raiseEvent(eventType, event);
} catch (JMSException ex) {
log.error("Problem sending push event message.", ex);
}
}
} try {
pushPublisher.publish(topicSession.createObjectMessage(event.getMessage()));
} catch (Exception ex) {
throw new RuntimeException(ex);
}
}
} |
Para recibir los mensajes JMS tenemos que configurar un MDBAhora, usamos PushManager#fireEvent() para lanzar eventos JMS desde un nodo del cluster, que permite después lanzar los eventos de JBoss Seam en todos los nodos el cluster y asi enviar el mensaje al canal push correspondiente:
| Bloque de código |
|---|
|
@In
private PushManager pushManager;
public void onSomeEntityChange(Entity entity) {
pushManager.fireEvent(new PushEvent(entity.getSomeProperty()));
} |
...
Sugerencias de Diseño de la UI
...
| Bloque de código |
|---|
|
<h:panelGroup id="foo">
... (some complex UI here) ...
</h:panelGroup>
<h:form>
<fw:socket channel="someChannel" scope="view">
<f:ajax event="someEvent" listener="#{bean.pushed}" render=":foo" />
</fw:socket>
</h:form> |
Donde el mensaje push, solo contien el nombre del evento Ajax. Puedes usar cualquier nombre de evento personalizado.
| Bloque de código |
|---|
|
someChannel.send("someEvent"); |
...
| Bloque de código |
|---|
|
<h:panelGroup id="foo">
... (some complex UI here) ...
</h:panelGroup>
<fw:socket channel="someChannel" scope="view" onmessage="someCommandScript" />
<h:form>
<p:remoteCommand name="someCommandScript" action="#{bean.pushed}" update=":foo" />
</h:form> |
...
package es.um.atica.prueba.push;
import javax.ejb.ActivationConfigProperty;
import javax.ejb.MessageDriven;
import javax.ejb.TransactionAttribute;
import javax.ejb.TransactionAttributeType;
import javax.jms.JMSException;
import javax.jms.Message;
import javax.jms.MessageListener;
import org.jboss.seam.annotations.Logger;
import org.jboss.seam.annotations.Name;
import org.jboss.seam.core.Events;
import org.jboss.seam.log.Log;
import org.jboss.seam.util.Strings;
import es.um.atica.faces.push.PushEvent;
@MessageDriven(activationConfig = {
@ActivationConfigProperty(
propertyName = "destinationType",
propertyValue = "javax.jms.Topic"
),
@ActivationConfigProperty(
propertyName = "destinationLookup",
propertyValue = "jms/pruebaPushTopic"
)
})
@Name("pushReceiver")
@TransactionAttribute(value = TransactionAttributeType.NOT_SUPPORTED)
public class PushReceiver implements MessageListener {
@Logger
private Log log;
protected void raiseEvent(String eventType, PushEvent event) {
if (Strings.isEmpty(eventType)) {
log.info("Raise push event '#0'", event.getClass().toString());
Events.instance().raiseEvent(event);
} else {
log.info("Raise push event '#0'", eventType);
Events.instance().raiseEvent(eventType, event);
}
}
@Override
public void onMessage(Message jmsMessage) {
try {
String eventType = jmsMessage.getStringProperty("eventType");
PushEvent event = jmsMessage.getBody(PushEvent.class);
raiseEvent(eventType, event);
} catch (JMSException ex) {
log.error("Problem sending push event message.", ex);
}
}
} |
Ahora, usamos PushManager#fireEvent() para lanzar eventos JMS desde un nodo del cluster, que permite después lanzar los eventos de JBoss Seam en todos los nodos el cluster y asi enviar el mensaje al canal push correspondiente:
| Bloque de código |
|---|
|
@In
private PushEventsManager pushEventsManager;
public void onSomeEntityChange(Entity entity) {
pushEventsManager.fireEvent(new MyPushEvent(entity.getSomeProperty()));
} |
| Info |
|---|
IMPORTANTE EN FUNDEWEB |
Todas estas clases, están añadidas en las librerías de FundeWeb, y el sistema también esta añadido a partir del Arquetipo versión 2.0.11, que añade un perfil llamada cluster que permite terne fácilmente esta funcionalidad. Solo tendréis que usar el PushEventsManager para enviar los mensajes a través de las conexiones push. Para añadir esa configuración a una aplicación existente hay que descargar el fichero push-cluster.zip y descomprimir con Extraer aquí en la raíz del proyecto. Con esto crearemos la carpeta web/src/main/profiles/cluster.
En esta carpeta tendremos la carpeta java donde se encuentra la clase PushReceiver (la única que no esta en las librerías de FundeWeb). La ruta a esta clase, es/um/atica/__rootArtifactId__/push (que es una ruta de paquete de código fuente), la tendremos que modificar, cambiando __rootArtifactId__ por el identificador de la aplicación. En la propia clase PushReceiver, tendremos que cambiar los valores ${rootArtifactId} por el identificador de la aplicación (igual que antes).
También tenemos que modificar el fichero web/src/main/profiles/cluster/components.xml, tendremos que cambiar los valores ${rootArtifactId} por el identificador de la aplicación (igual que antes).
Para finalizar, en el POM del módulo Web, tendremos que añadir un perfil a <profiles> (el elemento XML puede estar comentado, por lo que dejamos sin comentar solo las etiquetas <profiles> y </profiles>):
| Bloque de código |
|---|
|
<profile>
<id>cluster</id>
<properties>
<cluster.profile.folder>src/main/profiles/cluster</cluster.profile.folder>
</properties>
<build>
<plugins>
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>build-helper-maven-plugin</artifactId>
<executions>
<execution>
<id>add-cluster-java</id>
<phase>generate-sources</phase>
<goals>
<goal>add-source</goal>
</goals>
<configuration>
<sources>
<source>${cluster.profile.folder}/java</source>
</sources>
</configuration>
</execution>
</executions>
</plugin>
<plugin>
<groupId>be.hikage.maven.plugins</groupId>
<artifactId>maven-xmlmerger-plugin</artifactId>
<executions>
<execution>
<id>merge-cluster-components_xml</id>
<phase>generate-resources</phase>
<goals>
<goal>mergexml</goal>
</goals>
<configuration>
<baseDirectory>${basedir}/src/main/webapp/WEB-INF</baseDirectory>
<inputDirectory>${cluster.profile.folder}/xmlmerge</inputDirectory>
<outputDirectory>${basedir}/src/main/webapp/WEB-INF</outputDirectory>
<mergeFilenamePattern>()(components\.xml)</mergeFilenamePattern>
</configuration>
</execution>
</executions>
</plugin>
</plugins>
</build>
<dependencies>
<dependency>
<groupId>es.um.atica.fundeweb</groupId>
<artifactId>fundeweb-cluster</artifactId>
</dependency>
</dependencies>
</profile> |
Para finalizar, tenemos que poner un JIRA a DJ-AT-SIST-MIDDLE (MIDWEB), como Petición de Servicio y al componente JMS, indicando que hay que crear una cola JMS para la aplicación XXXXX con rutas JNDI:
- Para el Tema (TOPIC): jms/_nombre_aplicacion_minusculas_PushTopic
- Para la fábrica de conexiones: jms/_nombre_aplicacion_minusculas_PushConnectionFactory
Más información sobre JMS:
...
Configuraciones Adicionales Obligatorias
...
| Bloque de código |
|---|
|
<!-- Exception handling -->
<web:exception-filter url-pattern="@default_url_pattern@" installed="true" />
<!-- Identity Logging -->
<web:logging-filter url-pattern="@default_url_pattern@" installed="true" />
<!-- Character encoding -->
<web:character-encoding-filter encoding="UTF-8"
override-client="true" installed="true" url-pattern="@default_url_pattern@" /> |
Si se usa el atributo atributo regex-url-pattern, para este caso añadimos la propiedad default_regex_url_pattern en el fichero components.properties, con el valor definido para la propiedad junto con la que se usa para las peticiones push, si por ejemplo, el valor de la propiedad es .*\.seam, entonces añadimos:
...