IBM Portlet API

The IBM Portlet API is being deprecated for WebSphere Portal v6.1.5, but is still supported. No new functionality will be added and it is recommended you use the Standard Portlet API. These sections provide a brief description of the IBM Portlet API.

• Overview

• Portlet API concepts

• Elements of the IBM Portlet API

• Core objects

• Listeners

• Configuration objects

• Miscellaneous objects

• Portlet events

• Deployment descriptors

• JSP tags of the IBM Portlet API

• Portlet API extensions

The Javadoc for the IBM Portlet API is available from the PortalServer_root/doc/Javadoc directory.

Related information

• Understand the basics

• Overview

  Get an overview of the IBM portlet API. This API is deprecated and this topic is provided only to support portlets that have not been converted to the standard portlet API.

• Comparing the standard portlet API to the IBM portlet API

  Find out about the similarities and differences between the standard portlet API and the IBM portlet API.

• Converting IBM portlets

  You can convert your basic IBM portlets as well as IBM portlets that use the Struts Portlet Framework to the standard portlet API.

• Portlet API concepts

  Learn about portlets, portlet applications, portlet modes, and portlet states.

• Elements of the IBM Portlet API

  Know the basic interfaces, classes, and methods of the IBM Portlet API.

• Core objects

  Learn about the core objects used by portlets, PortletRequest, PortletResponse, and PortletSession. Each of these objects is an extension of its counterpart in the Servlet API.

• Listeners

  Portlets can implement PortletSessionListener, PortletPageListener, PortletTitleListener, PortletSettingsAttributesListener, and PortletApplicationSettingsAttributesListener interfaces for providing enhanced functionality.

• Configuration objects

• Miscellaneous objects

  Learn about the PortletContext, PortletLog, PortletWindow, and User objects used by portlets.

• Portlet events

  Get an overview of how a portlet can receive and respond to Action events and Message events. Read about how a portlet differs from a servlet in its processing and rendering sequence.

• JSP tags of the IBM Portlet API

  View the descriptions of the JSP tags that are recognized by the portlet container.

• Portlet API extensions

• Portlet menus

  In the context of IBM Portlet API, learn about portlet menus and how to create portlets that implement static and dynamic menus.

• Writing a portlet filter

  A portlet filter is an object that allows information flowing to or from a portlet (or filter) to be intercepted and manipulated.

  The object being filtered is intentionally left unaware of the filter's presence, allowing it to behave normally. Such an object can either be a portlet or another filter, thus allowing any number of filters to be applied to a single portlet, creating a filter chain (see the illustration below). While portlet filters can be used to manipulate data in any number of ways, one of their primary functions, for example, is to filter a portlet's input and results for use in secondary user interface environments (for example., text terminals,

  PDAs, cell phones, and so on.). Because the portlet being filtered does not know about the filter, it can receive and respond to requests in a normal and robust fashion.

Parent topic:

Develop portlets

---