Package com.sapportals.portal.pb.contentservice

Provides an interface to use the Application Cache service of the Portal.

See:
          Description

Interface Summary
ICacheResponse  
IContentFetchingService The main interface of the Application cache.
IHTMLProcessor This Interface is used to add HTML processing ability to the clients using the contnet fetching service.
IHTTPRequest provides a simple interface to open a connection and request some content from a server
IPackageInformation Used by the IContentFetchingService as a container for all of the required properties for openning the connection and requesting the content
 

Package com.sapportals.portal.pb.contentservice Description

Provides an interface to use the Application Cache service of the Portal. Using this can provide a URL and a set of connection properties (via the IPackageInformation interface). The service will request the content from the server, write the response to the browser, and, if defined, will store the response content in the cache.

The Application cache service can use, if required, a smart caching mechanism, with which the service parses the response HTML for tags (IMG, IFRAME or FRAME) marked with the attribute portal_bridge, and for those tags, automatically request the content and store it also in the cache for later use. In this way, if the response contains tags directing to dynamic resources on the backend system, which have some validity period of time, but because the backend system does not cache them, they will be re-created every time the same content is requested from the backend, could be stored in the Portal cache for the validity period defined, and by that both reduce the load on the backend system and improve the response time of the iView by returning the cached image or content from the Portal cache.

The IHTMLProcessor can be used for accessing the HTML response in the Application cache after it was retrieved from the server, and before it is written to the cache and browser. So the developer can provide an implementation class to the service (through the IPackageInformation) in which one can process and alter the HTML as required and pass it back to the service for caching and displaying.

The IHTTPRequest object created by the IContentFetchingService could be used for requesting some content from a server. It uses the same IPackageInformation interface to obtain the connection information, but in this case the response is not written to the browser or the cache. The response could be read from the IHTTPRequest object itself. It is the developers responsibility to handle the response and decide whether one wants to write it to the browser or handle it in any other way.