About the IDK Proxy API
The IDK Proxy API supports cross-product pagelet development.
The interfaces in this package provide access to information about
the environment in which the pagelet is displayed and the user currently
accessing the pagelet, including session preferences associated with
that user. This package also includes Ensemble-specific methods to
implement security and access XML payloads.
This page provides an introduction to the IDK Proxy API. For more
details on objects and methods, see the IDK API documentation.
The bea.alui.proxy package/namespace includes the following interfaces:
- IProxyContext
- IProxyRequest
- IProxyResponse
- IProxyUser
In general, these interfaces are called in the following order:
- A pagelet uses ProxyContextFactory.getInstance().createProxyContext to initiate a connection for communicating with Ensemble or the
portal.
- The IProxyContext object returned allows the
pagelet to access information about the request and response, the
current user, and the session. The pagelet uses this information as
needed, in arbitrary order, to generate a proper response. Using IProxyContext, the pagelet can access IProxyRequest, IProxyUser, IRemoteSession and IProxyResponse.
- The pagelet retrieves parameters from the request using IProxyRequest.
- The pagelet retrieves user information and preferences from IProxyUser.
- The pagelet can access functionality in AquaLogic applications
using IRemoteSession. For details, see About Programmable Remote Client (PRC) Remote APIs.
- The pagelet constructs a response using IProxyResponse. The response includes content to be displayed and any settings
to be stored or removed.
For examples of using IProxy interfaces in a pagelet, see Creating a Custom Pagelet with the Java IDK Proxy API and Creating a Custom Pagelet with the .NET IDK Proxy API.
