About the IDK ALI Portlet API
The IDK Portlet API provides ALI-specific support for portlet
development, including manipulating settings in the ALI database,
accessing user information, and managing communication with the portal.
This page provides an introduction to the IDK Portlet API. For
more details on objects and methods, see the IDK API
documentation.
Note: Note: The IDK was formerly called the Plumtree Development Kit
(EDK); some package names retain old naming conventions.
The plumtree.remote.portlet package/namespace includes the following
interfaces:
- IPortletContext
- IPortletRequest
- IPortletResponse
- IPortletUser
In general, these interfaces are called in the following order:
- A portlet uses PortletContextFactory.createPortletContext to initiate a connection for communicating with Ensemble or the
portal.
- The IPortletContext object returned allows
the portlet to access information about the request and response,
the current user, and the session. The portlet uses this information
as needed, in arbitrary order, to generate a proper response. Using IPortletContext, the portlet can access IPortletRequest, IPortletUser, IRemoteSession and IPortletResponse.
- The portlet retrieves parameters from the request using IPortletRequest.
- The portlet retrieves user information and preferences from IPortletUser.
- The portlet can access functionality in AquaLogic applications
using IRemoteSession. For details, see About Programmable Remote Client (PRC) Remote APIs.
- The portlet constructs a response using IPortletResponse. The response includes content to be displayed and any settings
to be stored or removed.
For examples of using IPortlet interfaces in a portlet, see Creating a Custom ALI Portlet with the Java IDK Portlet API and Creating a Custom ALI Portlet with the .NET IDK Portlet API.
