Package com.sapportals.wcm.service.ice.subscriber

Represents the syndicator part of the ICE service.

See: Description

Interface Summary

Interface	Description
ISubscriberConfig	ISubscriberConfig is used to read and manipulate the configuration of the subscriber part.
ISubSubscription	ISubSubscription represents a subscription of the subscriber.
ISubSubscriptionIterator	An iterator of an ISubSubscriptionList.
ISubSubscriptionList	ISubSubscriptionList is an abstract list of ISubSubscription objects.
ISubSyndicator	ISubSyndicator contains all informations a subscriber has to know about a certain syndicator.
ISubSyndicatorIterator	An iterator of an ISubSyndicatorList.
ISubSyndicatorList	ISubSyndicatorList is an abstract list of ISubSyndicator objects.

Package com.sapportals.wcm.service.ice.subscriber Description

Represents the syndicator part of the ICE service.

Package Specification

The graphic gives an overview of the most important interfaces that are available for the subscriber part of the content exchange service. The central interface for the subscriber is ISubscriberConfig. It stores information about the subscriber and enables access to information about syndicators. As information about syndicators and their offers is an essential prerequisite for setting up subscriptions, an ISubSyndicator object is available to store details about the syndicator and to enable the creation of subscriptions. Individual subscriptions are represented by an ISubSubscription object.

If the name of an interface has the prefix sub, this indicates that it is associated with the subscriber side of the content exchange service. For example ISubSubscription stores information about a subscription which is important from the perspective of the subscriber, whereas ISynSubscription stores information which is important from the perspective of the syndicator.

The class diagram shows the main interfaces related to the subscriber.

The interfaces shown have the following purpose:

• ISubscriberConfig is the entry point for work with the subscriber. It provides the ID and name of the subscriber. As subscriptions are based on information from syndicators, it defines methods to get information about syndicators. It enables the creation of an ISubSyndicator object to store and maintain information about a specific syndicator and enables access to all registered ISubSyndicator objects. A further available method establishes an initial connection to a syndicator with a specified URL.
• ISubSyndicator stores all the information about a syndicator that is important from the subscribers point of view. The methods of the interface enable access and maintenance of information like the URL, ID, offers and login information of the syndicator. They allow the establishment of a connection to the syndicator and, most important of all, the creation of a subscription.
• ISubSubscription represents a subscription. It defines methods that give access to details of a subscription like the delivery policy, the URL where the incoming packages are stored and the ID of the subscribed offer. Corresponding methods allow the details of the subscription to be defined or changed. A method to handle an incoming subscription package is also available.

In addition to the interfaces for the subscriber summarized above, there are also interfaces to deal with lists of syndicators or subscriptions. For example, ISubSubscriptionList and ISubSubscriptionIterator define methods to deal with lists of subscriptions. ISubSyndicatorList and ISubSyndicatorIterator define methods to deal with lists of syndicators.

Code Samples

// 1: getting the subscriber part
IICEService iceService = (IICEService)ResourceFactory.getInstance().getServiceFactory().getService(IICEService.ICE_SERVICE);
ISubscriberConfig config = iceService.getSubscriberConfig();

// 2: register the syndicator "dpa"
UUID syndicatorUUID = <unique identifier of the syndicator>;
URL url = <URL of the syndicator>;
ISubSyndicator syndicator = config.createSyndicator("dpa", "News Provider", syndicatorUUID, url, resourceContext);

// 3: create a subscription
UUID subscriptionId = <identifier of the subscription>
String offerId = <identifier of the offer to subscribe to>
RID destinationRID = <RID of the collection where to put the content of the subscription>
ISubSubscription subscription =
  syndicator.createSubscription("News Subscription", subscriptionId, String offerId, deliverPolicy, destinationRID, resourceContext);

// NOTE:
// This subscription will be established only locally. The syndicator has to create it on his side, too.
// Use the package com.sapportals.wcm.protocol.ice, if you want to establish a subscription on the syndicator
// over a HTTP connection.

Related Documentation

com.sapportals.wcm.service.ice.syndicator
com.sapportals.wcm.service.ice