Java Portlet Specification
A portletek a felhasználói felület olyan szoftver komponensei, amelyek egy webportálon belül kerülnek menedzselésre és megjelenítésre. Egy webportál általában több portletet is tartalmaz, a leggyakrabban alkalmazottak a következők: e-mail kliens, időjárás-előrejelzés, hírek. Egy portlet a felépítéséből adódóan könnyen testre szabható, a felhasználó által átrendezhető, módosítható.
A különböző gyártók által elkészített portletek száma rohamos növekedésnek indult, ami komoly nehézséget okozott a webportált működtetőknek és a felhasználóknak egyaránt, hiszen a különböző gyártók különféle interfészeket alkalmaztak. Ezen problémák megoldására született a JSR (Java Specification Request) 168, a Portlet specifikáció, amely lehetővé teszi a különböző portletek együttműködését, összehangolását.
A JSR 168
A JSR 168 a portletet Java alapú komponensenként definiálja, amely egy megjelenítési réteget ad az információs rendszereknek.
A JSR 168 céljai a következők:
- futtató környezet definiálása, a portlet konténer
- a portlet és a portlet konténer közötti API definiálása
- tranziens és perzisztens adatok tárolása portletek számára
- szervletek és JSP beágyazásának lehetősége portletekbe
- portlet csomagok definiálása
- lehetőség bináris portletek hordozhatóságára, JSR 169 portletek esetén
Az számítástechnikai iparág többnyire elfogadta a JSR 168-at. Többek között a következő vállalatok tagjai a JSR 168 csoportnak: Apache, ATG, Boeing, Fujitsu, IBM, Novell, Oracle.
A portlet életciklusa
Egy szabványos JSR 168 portlet életciklusa:
- inicializálás: a portlet inicializálása
- kérések kiszolgálása: a különböző kérések végrehajtása
- megszüntetés
Portlet interfész
Minden portletnek implementálnia kell a Portlet interfészt, vagy öröklődnie kell egy ilyen osztályból. Egy portlet interfész a következő metódusobkól áll:
- init(PortletConfig config): portlet inicializálása, csak egyszer hívódik meg
- processAction(ActionRequest request, ActionResponse response): egy felhasználói kérést továbbít a portlet felé
- render(RenderRequest request, RenderResponse response): egy adott kérés végrehajtása
- destroy(): portlet megszüntetése, erőforrásainak felszabadítása
Megjelenítési módok
A JSR 168 a következő 3 megjelenítési módot definiálja:
- VIEW: a portlet jelenlegi állapotának megfelelő megjelenés
- EDIT: a felhasználó módosíthatja a megjelenését
- HELP: javaslatot tesz a felhasználónak a portlet használatához
Azonban ezek kiterjeszthetőek.
Ablak állapotok
- NORMAL: a portlet más portletekkel osztozik az adott oldalon
- MINIMIZED: a portlet nem vagy csak kevés információt jelenít meg
- MAXIMIZED: a portlet az egyedüli megjelenített portlet az adott oldalon
Hello World portlet
import java.io.PrintWriter;
import java.io.IOException;
import javax.portlet.GenericPortlet;
import javax.portlet.RenderRequest;
import javax.portlet.RenderResponse;
import javax.portlet.PortletException;
public class HelloWorldPortlet extends GenericPortlet {
/**
* A portlet a következő szöveget jeleníti meg: "Hello, World"
*/
public void render(RenderRequest request, RenderResponse response)
throws PortletException, IOException
{
PrintWriter out = response.getWriter();
out.println("Hello, World");
}
}
Hello World portlet leíró
<?xml version="1.0" encoding="UTF-8"?>
<portlet-app xmlns="http://java.sun.com/xml/ns/portlet/portlet-app_1_0.xsd"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://java.sun.com/xml/ns/portlet/portlet-app_1_0.xsd"+
"http://java.sun.com/xml/ns/portlet/portlet-app_1_0.xsd"
version="1.0">
<portlet>
<portlet-name>HelloWorldPortlet</portlet-name>
<portlet-class>org.jboss.portlet.hello.HelloWorldPortlet</portlet-class>
<supports>
<mime-type>text/html</mime-type>
<portlet-mode>VIEW</portlet-mode>
</supports>
<portlet-info>
<title>HelloWorld Portlet</title>
</portlet-info>
</portlet>
</portlet-app>
2.0 - Újabb változat
A portlet specifikáció újabb változata a 2.0-s (JSR-286), több képességgel is felruházza a portleteket. Ilyen pl. a IPC (Inter-portlet-communication), ami a portletek közti kommunikációt teszi lehetővé üzenetekkel és nyilvános render parameterekkel. Akár 2 külön portlet kontáner között is módot ad a kommunikációra. Továbbá dinamikusan generált erőforrások kiszolgálását is megengedi (serveResource). Valamint dinamikusan generált Axaj és JSON adat kisziolgálást is megenged. Itt kerülnek bevezetésre a portlet filterek és listene-ek is.
Megvalósítások
- Apache Pluto a JSR168 referencia implementációja
Kommercionális implementációk a főbb java vendoroktól:
- Oracle Portal
- IBM Websphere Portal
- JBoss Portal
- Open TextCorporation portal implementáció
Nyílt forráskódú implementációk:
- Apache Jetspeed-2 Enterprise Portal
- eXo Platform
- GateIn Portal
- uPortal
- Liferay Portal
Források
JSR-286, the Java Portlet API 2.0
http://en.wikipedia.org/wiki/Portlet
http://developers.sun.com/portalserver/reference/techart/jsr168/
http://www.javaworld.com/javaworld/jw-08-2003/jw-0801-portlet.html
http://www.caucho.com/resin-3.0/portlet/tutorial/basic-hello/index.xtp
http://onjava.com/onjava/2005/09/14/what-is-a-portlet.html
http://docs.jboss.org/jbportal/v2.4/reference-guide/en/html/tutorials.html
Külső hivatkozások
http://developers.sun.com/portalserver/reference/techart/jsr168/