Tema 3: Especificación de portlets Java Anexo: JSR 286

Transcripción

1 Tema 3: Especificación de portlets Java Anexo: JSR 286

2 JSR 286 (1) JSR 286 es la versión 2.0 de la especificación de portlets Java La versión final de la especificación saldrá a lo largo del 2008 Principales características Compatibilidad hacia atrás Es una extensión de la versión 1.0 El contenedor de portlets debe soportar Servlets 2.4 Es posible utilizar JSP 2.0 y JSTL 1.1 Mecanismos de coordinación entre portlets Eventos y parámetros públicos de renderización Anotaciones Para los métodos que procesan peticiones de acción, renderización y eventos

3 JSR 286 (2) Principales características (cont) Filtros de portlets Similar a los filtros de servlets Soporte para servir recursos Permite soportar interacciones AJAX Mejora el soporte para la gestión de la caché de las respuestas de los servlets Sincronizada con WSRP 2.0 Más información Especificación Stefan Hepper, Oliver Köth, What s new in the Java Portlet Specification V2.0 (JSR 286) ticles/0803_hepper/0803_hepper.html

4 JSR 286 (y 3) Nos centraremos especialmente en Mecanismos de coordinación entre portlets Especialmente en comunicación basada en eventos, y en menor medida en parámetros públicos de renderización Anotaciones Ilustraremos estos conceptos con un ejemplo

5 Ejemplo (1) Una sencilla mashup formada por tres portlets Stock Symbol Finder Permite buscar símbolos bursátiles a partir de palabras clave del nombre de la empresa My Stock Quotes Muestra las cotizaciones de los símbolos bursátiles añadidos por el usuario a sus preferencias Permite buscar la cotización de un símbolo bursátil My Stock Headlines Muestra noticias de los símbolos bursátiles añadidos por el usuario a sus preferencias Permite buscar noticas de un símbolo bursátil Muestran la misma información en estado de ventana normal y maximized Capa modelo simplificada y simulada en los tres portlets

6 Ejemplo (2) La búsqueda de símbolos bursátiles (Stock Quote Finder) está integrada con la funcionalidad de los portlets My Stock Quotes y My Stock Headlines Para cada símbolo bursátil resultante de la búsqueda (Stock Symbol Finder), se incluyen dos enlaces: Buscar y Añadir a preferencias Ambos enlaces generan un evento que es consumido por My Stock Quotes y My Stock Headlines En respuesta al evento del enlace Buscar, My Stock Quotes y My Stock Headlines muestran información de ese símbolo bursátil En respuesta al evento del enlace Añadir a preferencias, My Stock Quotes y My Stock Headlines añaden el símbolo bursátil a las preferencias

7 Ejemplo (3) Click en Buscar (SMJ0)

8 Ejemplo (4)

9 Ejemplo (5) Click en Añadir a preferencias (SMJ0)

10 Ejemplo (6)

11 Ejemplo (y 7) Observación La mashup ofrece una funcionalidad similar a la del portlet Stock Quote Adicionalmente Proporciona búsqueda de símbolos bursátiles Integra la búsqueda de símbolos bursátiles con la funcionalidad de los portlets My Stock Quotes y My Stock Headlines Los portlets son más sencillos que el portlet Stock Quote La funcionalidad se ha descompuesto en portlets más pequeños

12 Stock Symbol Finder searchstocksymbol.jsp... <c:foreach var="stocksymbol" items="${stocksymbols}" varstatus="status"> <portlet:actionurl var="searchstocksymbolurl"> <portlet:param name="javax.portlet.action" value="searchstocksymbol"/> <portlet:param name="stocksymbol" value="${stocksymbol.symbol}"/> <portlet:param name="companykeywords" </portlet:actionurl> value="${companykeywords}"/>... <portlet:actionurl var="addstocksymboltopreferencesurl"> <portlet:param name="javax.portlet.action" value="addstocksymboltopreferences"/> <portlet:param name="stocksymbol" value="${stocksymbol.symbol}"/> <portlet:param name="companykeywords" </portlet:actionurl> value="${companykeywords}"/>

13 Stock Symbol Finder StockSymbolFinderPortlet (1) private final static QName SEARCH_STOCK_SYMBOL_EVENT = new QName(" "SearchStockSymbol"); private final static QName ADD_STOCK_SYMBOL_TO_PREFERENCES_EVENT = //... new QName(" public void sendsearchstocksymbolevent(actionrequest request, ActionResponse response) throws PortletException, IOException { response.setrenderparameter("companykeywords", request.getparameter("companykeywords")); response.setevent(search_stock_symbol_event, request.getparameter("stocksymbol")); }

14 Stock Symbol Finder StockSymbolFinderPortlet (y public void sendaddstocksymboltopreferencesevent( ActionRequest request, ActionResponse response) throws PortletException, IOException { response.setrenderparameter("companykeywords", request.getparameter("companykeywords")); response.setevent(add_stock_symbol_to_preferences_event, request.getparameter("stocksymbol")); }

15 Stock Symbol Finder portlet.xml (1) <?xml version="1.0" encoding="utf-8"?> <portlet-app xmlns=" xmlns:xsi=" xsi:schemalocation=" version="2.0"> <portlet> <description> A portlet allowing to search stock symbols by company name </description> <portlet-name>stocksymbolfinderportlet</portlet-name>...

16 Stock Symbol Finder portlet.xml (2) <supported-publishing-event> <qname xmlns:x=" </supported-publishing-event> <supported-publishing-event> <qname xmlns:x=" s</qname> </supported-publishing-event> </portlet>

17 Stock Symbol Finder portlet.xml (y 3) <event-definition> <qname xmlns:x=" <value-type>java.lang.string</value-type> </event-definition> <event-definition> <qname xmlns:x=" s</qname> <value-type>java.lang.string</value-type> </event-definition> </portlet-app>

18 Anotación ProcessAction El procesamiento de las peticiones de acción se podría haber implementado al estilo de la versión 1.0 Redefinir processaction + if s para tomar decisión Anotación ProcessAction En la versión 2.0, la implementación de processaction en GenericPortlet intenta delegar el procesamiento de la petición de acción en un método anotado con ProcessAction, cuyo elemento name especifique el valor del parámetro javax.portlet.action Evita tener que redefinir processaction como una colección de if s Los métodos anotados con ProcessAction se deben declarar como void <methodname> (ActionRequest, ActionResponse) throws PortletException, java.io.ioexception;

19 Definición de eventos Sincronizada con WSRP portlet.xml Los eventos se definen (event-definition) dentro de portlet-app El portlet tiene que declarar los eventos que publica (supported-publishing-event) y los que desea recibir (supported-processing-event) El tipo del valor del evento debe ser serializable (java.io.serializable) y poder mapearse a XML vía JAXB (para eventos remotos) Un evento puede ser una estructura de datos compleja (e.g. un Transfer Object)

20 Envío de eventos Un evento se puede enviar durante el procesamiento de una petición de acción o una petición de evento (se explica más adelante) Las interfaces ActionResponse y EventResponse extienden a la interfaz StateAwareResponse, que incluye el método void setevent(qname name, Serializable value) El evento no se envía en este momento, sino que se añade a la respuesta (ActionResponse o EventResponse, dependiendo del tipo de petición) Para especificar el nombre del evento se utiliza javax.xml.qname Representa un nombre cualificado Forma parte del API de Java SE

21 My Stock Quotes MyStockQuotesPortlet public void processsearchstocksymbolevent(eventrequest request, EventResponse response) throws PortletException, IOException { Event event = request.getevent(); String stocksymbol = (String) event.getvalue(); // FIXME: in Liferay Portal RC, getportletmode always // returns PortletMode.VIEW. if (request.getportletmode().equals(portletmode.view)) { } response.setrenderparameter("stocksymbol", stocksymbol); response.setrenderparameter("command", "SearchStockQuote"); }

22 My Stock Quotes MyStockQuotesPortlet (y qname="{ public void processaddstocksymboltopreferencesevent( EventRequest request, EventResponse response) throws PortletException, IOException { Event event = request.getevent(); String stocksymbol = (String) event.getvalue(); // FIXME: it does not work in Liferay Portal RC. // "stocksymbol" is not added to preferences, even though // JSR 286 (section PLT.17.1) allows to modify them when // processing an event. addstocksymboltopreferences(request, stocksymbol); }

23 My Stock Quotes portlet.xml (1) <?xml version="1.0" encoding="utf-8"?> <portlet-app...> <portlet> <description> A portlet allowing to monitor stock quotes </description> <portlet-name>mystockquotesportlet</portlet-name>... <!-- FIXME: disabled. In Liferay Portal RC, the portlet's markup (in "view" mode) is not refreshed after sending an event to a portlet if its markup is cached. JSR 286 (section PLT.22.1) forces the portlet container to discard the portlet's cached markup after sending it an event. <expiration-cache>1200</expiration-cache> -->

24 My Stock Quotes portlet.xml (2)... <supported-processing-event> <qname xmlns:x=" </supported-processing-event> <supported-processing-event> <qname xmlns:x=" s</qname> </supported-processing-event> </portlet>

25 My Stock Quotes portlet.xml (y 3) <event-definition> <qname xmlns:x=" <value-type>java.lang.string</value-type> </event-definition> <event-definition> <qname xmlns:x=" s</qname> <value-type>java.lang.string</value-type> </event-definition> </portlet-app>

26 Anotación ProcessEvent El procesamiento de las peticiones de acción se podría haber implementado redefiniendo processevent Conjunto de if s para procesar cada evento Anotación ProcessEvent La implementación de processevent en GenericPortlet intenta delegar el procesamiento del evento en un método anotado con ProcessEvent, cuyo elemento qname especifique el nombre del evento Evita tener que redefinir processevent como una colección de if s Los métodos anotados con ProcessEvent se deben declarar como void <methodname> (EventRequest, EventResponse) throws PortletException, java.io.ioexception;

27 Procesamiento de una petición de acción que devuelve un evento (1) Si una petición de acción devuelve un evento, el contenedor Invoca processevent sobre todos los portlets consumidores de dicho evento Idem si processevent también devuelve un evento Invoca render sobre todos los portlets cuyo contenido no esté cacheado o sean receptores del evento

28 Procesamiento de una petición de acción que devuelve un evento (y 2) Portal Contenedor Portlet 1... Portlet N 1: Interacción (acción) sobre el portlet 1 1.1: processaction El usuario está actuando sobre una página que contiene los portlets 1, 2,... N [consumidor del evento] 1.2: processevent... [consumidor del evento] 1.N+1: processevent [consumidor del evento respuesta no en caché] 1.N+2: render... [consumidor del evento respuesta no en caché] 1.2N+1: render

29 Parámetros públicos de renderización (1) Los parámetros públicos de renderización son otro mecanismo de coordinación entre portlets Un portlet puede declarar en portlet.xml los parámetros de renderización que desea compartir con otros portlets Esos parámetros se denominan parámetros públicos de renderización Al igual que los eventos, disponen de un nombre cualificado Se recuperan (request.getparameter) y establecen (response.setparameter) como cualquier otro parámetro de renderización Cuando un portlet le da valor a un parámetro de renderización que es público, el contenedor incluirá dicho parámetro en las invocaciones a render de los portlets que han declarado que desean compartirlo Son una opción eficiente y cómoda (no hay necesidad de hacer programación adicional) cuando varios portlets comparten un mismo conjunto de parámetros de renderización (parámetros públicos de renderización)

30 Parámetros públicos de renderización (2) Ejemplo Portlet Weather: muestra el tiempo a partir de un código postal (parámetro zipcode) Portlet Map: muestra una ubicación geográfica en un mapa a partir de un código postal (parámetro zipcode) Portlet Tourist Information: muestra información turística a partir de un código postal (parámetro zipcode) Si los tres portlets declaran el parámetro zipcode como parámetro público de renderización, cuando el usuario introduzca el código postal en cualquiera de los tres portlets, los otros dos actualizarán su salida de acuerdo a ese código postal (porque el contenedor les pasa automáticamente ese parámetro)

31 Parámetros públicos de renderización (3) Ejemplo: portlet.xml en el portlet Weather <?xml version="1.0" encoding="utf-8"?> <portlet-app...> <portlet> <portlet-name>weatherportlet</portlet-name>... <supported-public-render-parameter> zipcode </supported-public-render-parameter> </portlet> <public-render-parameter> <identifier>zipcode</identifier> <qname xmlns:x=" </public-render-parameter> </portlet.app>

32 Parámetros públicos de renderización (y 4) El mecanismos de eventos Es un mecanismo general de comunicación En respuesta a un evento, el portlet puede modificar estado (e.g. cambiar preferencias, actualizar una base de datos, realizar una operación no idempotente, etc.), establecer parámetros de renderización o enviar un nuevo evento El dato del evento puede ser un tipo complejo El mecanismo de parámetros públicos de renderización Es un mecanismo cómodo y eficiente para el caso particular de portlets que comparten un conjunto de parámetros de renderización

33 Otros aspectos del ejemplo (1) Anotación RenderMode La implementación de dodispatch (que es llamado por render) en GenericPortlet primero intenta delegar la petición en un método anotado con RenderMode, cuyo elemento name especifique el modo a tratar (view, edit o help Si no lo encuentra, delega en doview, doedit o dohelp en función del modo La anotación no aporta mucho sobre la alternativa de los métodos doxxx El código de los ejemplos utiliza la anotación RenderMode por consistencia con el uso del resto de anotaciones Los métodos anotados con RenderMode se deben declarar como void <methodname> (RenderRequest, RenderResponse) throws PortletException, java.io.ioexception;

34 Otros aspectos del ejemplo (2) Anotación RenderMode (cont) public void processviewmode (RenderRequest request, RenderResponse response throws PortletException, IOException { //... public void processviewmode (RenderRequest request, RenderResponse response throws PortletException, IOException { //... public void processviewmode (RenderRequest request, } RenderResponse response throws PortletException, IOException { //...

35 Otros aspectos del ejemplo (3) JSP 2.0 Se usan expresiones JSP en las páginas JSP en cualquier situación y no sólo con los tags de JSTL Código JSP más sencillo Se usan páginas JSP (notación clásica) y no documentos JSP El markup que se devuelve es HTML y no XHTML, por lo que resulta más cómodo usar la notación clásica Librerías de tags JSTL 1.1 y librería de tags del API de portlets (versión 2.0) commonheader.jsp (en cualquiera de los tres portlets) <%@ taglib prefix="fmt" uri=" %> <%@ taglib prefix="c" uri=" %> <%@ taglib prefix="portlet" uri=" %>

36 Otros aspectos del ejemplo (y 4) Problemas con Liferay Portal RC FIXMEs de las transparencias anteriores Además, cuando se interactúa con un portlet, no se conservan los parámetros de renderización del resto de portlets (lo que contraviene a la especificación) El problema se observa rápidamente en los portlets My Stock Quotes y My Stock Headlines, que tienen deshabilitada la caché (como especifica uno de los FIXMEs anteriores)