About the Oracle WebCenter Interaction Development Kit (IDK)
Portlet API
The Oracle WebCenter Interaction Development Kit (IDK)
Portlet API provides Oracle WebCenter Interaction-specific support
for portlet development, including manipulating settings in the portal
database, accessing user information, and managing communication with
the portal.
This page provides an introduction to the Oracle WebCenter Interaction
Development Kit (IDK) Portlet API. For more details on objects and
methods, see the API documentation.
Note: Note: The IDK was formerly called the AquaLogic Interaction
Development Kit (IDK) and 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 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 Oracle WebCenter Interaction
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 Oracle WebCenter Interaction Portlet with the Java Oracle WebCenter Interaction Development Kit (IDK) Portlet API and Creating a Custom Oracle WebCenter Interaction Portlet with the .NET Oracle WebCenter Interaction Development Kit (IDK) Portlet API.
