JBoss.orgCommunity Documentation
Starting from 3.0.0.Alpha1 version, the JBoss set of plugins includes tools for supporting JBoss Portal and JSR-186/JSR-286 portlets. Thus, this guide provides instructions on how to get started and manage JBoss Portlet Tools.
JBoss Portal provides an open source platform for hosting and serving a portal's Web interface, publishing and managing its content, and customizing its experience. It supports a wide range of features, including standard portlets, single sign-on, clustering, and internationalization. More about JBoss Portal can be found by visiting its home page at: http://www.jboss.org/jbossportal/.
With JBoss Portlet Tools you can easily create a Java, JSF and Seam portlet and deploy it to JBoss Portal.
JBoss Portlet Tools supports the JSR-168 Portlet Specification (Portlet 1.0) and JSR-286 Portlet Specification (Portlet 2.0) and works with JBoss Portlet Bridge for supporting Portlets in JSF/Seam applications. To enable these features, you need to add the JBoss Portlet facet to a new or an existing web project (see Chapter 2, JBoss Portlet Tools Tasks). The project could be a non-WTP project, but you should know that if it does not have the proper portlet API JAR's, the generated classes will have compile errors.
The next table lists key features supplied by JBoss Portlet Tools.
Table 1.1. Key Features of JBoss Portlet Tools
| Feature | Benefit | Chapter |
|---|---|---|
|
JBoss Portlet facets |
JBoss Portlet Tools provides the Java, JSF and Seam Portlet facets that could be enabled for a Web project. | Chapter 2, JBoss Portlet Tools Tasks |
|
Java Portlet wizard |
The wizard helps create a JSR-186/JSR-286 compliant portlets | Section 3.2.1, “Java Portlet Wizard” |
|
JSF/Seam Portlet wizard |
This wizard helps create JSF/Seam portlets | Section 3.2.2, “JSF/Seam Portlet Wizard” |
JBoss Portlet Tools needs the following minimum requirements:
Eclipse 3.4.2/Ganymede
JBoss Tools 3.0.0.Alpha1 (for higher versions of JBoss Tools make sure you use the compatible version of Eclipse)
JDK 5 or higher
JBoss Portal + JBoss AS bundle from: http://www.jboss.org/jbossportal/download/index.html
JBoss Portlet Tools has been tested using 2.6.5 and 2.7.0.ALPHA versions of JBoss Portal. Remember, if you want to use Portlet version 2.0 (JSR-268), you have to choose JBoss Portal 2.7.
JBoss Portlet Bridge (optionally) from: http://www.jboss.org/portletbridge/downloads.html
JBoss Portlet Tools is included as part of the JBoss Tools project. Refer to http://www.jboss.org/tools/download/installation.html for JBoss Tools installation instructions.