Supported APIs

Portlets that you deploy to pages rendered in client-side mode can use only a subset of the portal APIs. The fact that portal pages are rendered in client-side mode is usually transparent to portlets, which are still rendered on server-side. For this reason, you should be aware that limitations exist not only for the client-side APIs that you can use, but also for the server-side APIs.

Supported server side APIs

The following server-side APIs are supported:

• Standard Portlet APIs: JSR 168 and JSR 286

• Resolver API:

  • Support for data sources and data sinks

  • Resolution services

• Portal user management API (PUMA)

• Portal Access Control API (PAC)

• Credential Vault

• Ajax Proxy API

• Content Access Service

• The model SPI is supported for local portlets only

• The dynamic user interface, Transient Page Launching (TPL) is supported for local portlets only.

Server side APIs that do not work in client-side mode

The following server side APIs are not supported in client-side mode:

• IBMPortlet API

• Eventing for JSR 168 portlets, also known as Property Broker

• Navigational state SPI

• PortalURLWriter API

• PortalStateParameterService SPI

• portlet-ext:portalRenderURL tag

Supported client-side APIs

The following client-side APIs are supported:

• iWidget API

• Enabler API

• Dojo Version 1.4

• Semantic tagging framework, aka live text for click-to-action.

Client side APIs available for portlets

General prerequisites for using the client-side APIs are as follows:

• A CSA theme is active for the given page where the portlet is deployed.

• The render type iWidget has been activated. To do this, use the XML configuration interface or modify the metadata.properties in WebDAV, or select Client Side Aggregation - Rendering in the Page Properties portlet.

In general, you can use all the client-side public APIs provided with a CSA theme. For more information refer to the API documentation.

Parent

Programming model guidelines for client-side mode

  Submitted by Sergio Sanchez Martin on Dec 29, 2010 10:15:36 AM

Re: Supported APIs: wp7

Does it mean that if a portlet is written using the server-side APIs that are supported (ie JSR 168) can be rendered in CSA mode?

+

Search Tips   |   Advanced Search