A
Subscriber Application Development Kit

For a subscriber application to interact with Oracle9iAS Syndication Server, it must be ICE-compliant. If your subscriber application is a non ICE-compliant application, you must use the Oracle-supplied subscriber application development kit that has an API client library that will make your application ICE-compliant.

Section A.1 describes ICE-compliant applications and Section A.2 describes how to make your non ICE-compliant applications, ICE-compliant.

A.1 ICE-Compliant Applications

If your subscriber application is already ICE-compliant, then it can interact with Oracle9iAS Syndication Server with no modifications.

A.2 Non ICE-Compliant Applications

The Subscriber Application Development Kit (SADK) has a client library to assist subscriber application developers in building their own ICE-compliant applications.

The client library is written in Java and contains the following packages:

• Package - oracle.syndication provides the interface for the constants of ICE 1.1 status code. For example, constant ICE200 stands for Ok. Each ICE response payload must contain a status code section and the constant for the status code should be from the ICE status code.

• Package - oracle.syndication.ice.payload abstracts all XML formats defined by ICE 1.1 and present them as Java objects. Each Java class stands for one XML element defined in ICE 1.1. For example, Ice_sender.java corresponds to the ice-sender element in a regular ICE payload in XML

• Package - oracle.syndication.server.message.ice has all the implementations for interfaces defined inside the package oracle.syndication.server.message. ICEMessageManager is responsible for marshalling/unmarshalling messages in both directions in ICE 1.1 format. For instance, ICEMessage can construct a Java object of Ice_payload out of the incoming server response message.

• Package - oracle.syndication.server.transport.http supports the communication from the subscriber application to Oracle9iAS Syndication Server over the HTTP layer. The interface of OSSTransProtocolManager is defined inside the package of oracle.syndication.server.transport.

• Package - oracle.syndication.util.iso8601 provides the conversion for the date and time between an ISO8601-compliant string and a Java object class.

• Package - oracle.syndication.client.local defines and implements all required functions for a subscriber application. It also provides a sample implementation for the ICEClient and the ICEClientOfferManager.

Oracle Corporation recommends that the subscriber application implement its own offer manager from the interface ICEClientOfferManager in its preferred way. Offers and subscribers for the subscriber application should be kept persistently.

The ICE client library is available after installing Oracle9iAS Syndication Server. This ICE client library allows you to communicate with any ICE 1.1-compliant syndication server, and in particular you can use this client to communicate with Oracle9iAS Syndication Server.

The client library can be found under the demo/client/lib/ directory for UNIX or the demo\client\lib\ directory for Windows as the file syndclient.jar. The API documentation describes how to use this client library and can be found on the Oracle9iAS Documentation Library CD-ROM as API Reference (Javadoc) under Oracle9iAS Syndication Server, which is located under the Portals tab.

In addition, included with this release of Syndication Server is a sample client code build on top of the client library that builds a servlet that exposes a Web interface for the client. The Makefile for this servlet can be found in the demo/client/src directory on UNIX or demo\client\src directory on Windows.