NoDocTitle

     Previous Next  Open TOC in new window   View as PDF - New Window  Get Adobe Reader - New Window
Content starts here

About the Oracle WebCenter Interaction Development Kit (IDK) Proxy API

The Oracle WebCenter Interaction Development Kit (IDK) Proxy API supports cross-product pagelet/portlet development. The interfaces in this package provide access to information about the environment in which the pagelet/portlet is displayed and the user currently accessing the pagelet, including session preferences associated with that user. This package also includes Oracle WebCenter Ensemble-specific methods to implement security and access XML payloads.

This topic provides an introduction to the Oracle WebCenter Interaction Development Kit (IDK) Proxy API. For more details on objects and methods, see the API documentation. For details on Oracle WebCenter Interaction-specific portlet interfaces, see About the Oracle WebCenter Interaction Development Kit (IDK) Portlet API.

The bea.alui.proxy package/namespace includes the following interfaces:


  • IProxyContext
  • IProxyRequest
  • IProxyResponse
  • IProxyUser
In general, these interfaces are called in the following order:
  1. A pagelet uses ProxyContextFactory.getInstance().createProxyContext to initiate a connection for communicating with Ensemble or the portal.
  2. 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.
  3. The pagelet retrieves parameters from the request using IProxyRequest.
  4. The pagelet retrieves user information and preferences from IProxyUser.
  5. The pagelet can access functionality in Oracle WebCenter Interaction applications using IRemoteSession. For details, see About Programmable Remote Client (PRC) Remote APIs.
  6. 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 Oracle WebCenter Interaction Development Kit (IDK) Proxy API and Creating a Custom Pagelet with the .NET Oracle WebCenter Interaction Development Kit (IDK) Proxy API.


  Back to Top      Previous Next