-
Interface Summary Interface Description IContentFilter Filters the resource contents in a repository.IOffer IOffer contains all informations a syndicator has to know about an offer.IOfferComponent An offer consists out of one or more offer components which are internal references to the source repository with optional filter criteria.IOfferComponentIterator An iterator of an IOfferComponentList.IOfferComponentList IOfferComponentList is an abstract list of IOfferComponent objects.IOfferIterator An iterator of an IOfferList.IOfferList IOfferList is an abstract list of IOffer objects.ISyndicatorConfig ISubscriberConfig is used to read and manipulate the configuration of the subscriber part.ISynSubscriber ISynSubscriber contains all informations a syndicator has to know about a registered subscriber.ISynSubscriberIterator An iterator of an ISynSubscriberList.ISynSubscriberList ISynSubscriberList is an abstract list of ISynSubscriber objects.ISynSubscription ISynSubscription represents a subscription on the syndicator.ISynSubscriptionIterator An iterator of an ISynSubscriptionList.ISynSubscriptionList ISynSubscriptionList is an abstract list of ISynSubscription objects.
Package com.sapportals.wcm.service.ice.syndicator Description
Represents the syndicator part of the ICE service.
Package Specification
The entry point for work with the content exchange service is the IICEService interface. This enables you to get a reference to an ISyndicatorConfig object which has a pivotal role for managing the syndicator side of content distribution. ISyndicatorConfig enables access and interaction with other objects representing the syndicator side of the content exchange service. It helps to manage offers and subscriptions.
The graphic gives an overview of the most important interfaces related to the syndicator.
The interfaces shown have the following purpose:
- ISyndicatorConfig defines methods to handle and get information about all the offers and subscribers known to a syndicator. In particular, it offers methods to create and manage offers (IOffer objects) and to create and manage subscribers (ISynSubscriber objects). The methods available for the interface are described in detail below.
- IOffer provides methods to define and maintain the details of an offer. You can use the interface to create the components of an offer, to set the delivery policy and to access information about existing offers.
- IOfferComponent represents a component which defines a part of the content contained in an offer. It provides methods to define and manage a component. This includes setting filters that limit the resources in the component to those that meet specific criteria.
- ISynSubscriber
and ISynSubscription store information about subscribers
and subscriptions which are required by the syndicator.
The interfaces offer methods to define details related to
subscribers and subscriptions and to access information
about them.
Note that the prefix syn in the name of the interface indicates that the information is required for the syndicator side.
In addition to the interfaces described above, there are also interfaces to deal with lists. Lists of offers, components, subscribers and subscriptions can be handled with the help of the corresponding interfaces. For example, ISynSubscriberList and ISynSubscriberIterator are available for the syndicator to work with lists of subscribers.
Code Sample
// 1: getting the syndicator part
IICEService iceService = (IICEService)ResourceFactory.getInstance().getServiceFactory().getService(IICEService.ICE_SERVICE);
ISyndicatorConfig config = iceService.getSyndicatorConfig();
// 2: defining one offer comprised of two components
IOfferComponent component;
IOffer offer = config.createOffer("News", resourceContext);
component = offer.createComponent("Politics", new RID("/new/politics"), "news/politics", resourceContext);
component = offer.createComponent("Sport", new RID("/dpa/sport"), "dpa/sport", resourceContext);
// 3: register a subscriber with this syndicator
UUID subscriberUUID = <unique identifier of the subscriber>;
ISynSubscriber subscriber = config.createSubscriber("Subscriber1", "Test Subscriber", subscriberUUID, resourceContext);
// 4: create a subscription to above news offer for this subscriber
UUID subscriptionId = new UUID();
RID destinationRID = <RID of the collection where to put the content of the subscription>
ISubSubscription subscription = subscriber.createSubscription("News Subscription", subscriptionId, deliverPolicy, offer, resourceContext);
// NOTE:
// This subscription will be established only locally. The subscriber has to create it on his side, too.
// Usually, the subscriber will establish a subscription using a HTTP connection to the ICE servlet of this syndicator.
// The ICE servlet will then register the subscriber and create the subscription automatically,
// i.e. you usually don't have to do steps 3 and 4.
Related Documentation
See also com.sapportals.wcm.service.ice.subscriber
See also com.sapportals.wcm.service.ice