com.ibm.workplace.wcm.api.extensions.syndication
Interface SubscriberCompleting

public interface SubscriberCompleting

The Subscriber Completing extension point allows implementors to receive notification of a subscriber run completing.

The provider passes in a summary of changes to the extension point allowing implementors to determine what item level changes syndication performed during the run.

Note that throughout a syndication run an item may be saved multiple times as part of the internal syndication process. Many of these multiple updates are collapsed and combined into single change info of the final consistent item. As a result the changes provided may not match the amount of events from other event sources such as the more generic WCM JMS topics.

The extension keeps track of changes during the run in a non-persistent way and makes no guarantees of recovery from failure. If the system was to fail during a run the updates performed during that run may never be reported, please plan usage accordingly.

Also note that the extension is called during syndication completing so as of invoking the syndication run is still considered active. As a result its not possible to run syndication within the implementor for the given syndicator/subscriber pair.

The plugin is registered with WCM by providing a plugin.xml in the JAR file including the implementation and specifying and extension provider similar to this:

    <extension
      point="com.ibm.workplace.wcm.api.SubscriberCompleting" id="SamplePlugin">
      <provider class="com.yourco.SamplePlugin"/>
    </extension>
    

Since:

8.5 CF3

Note:

This interface is designed to be implemented by clients.

Method Summary

Result

onSubscriberCompleting(Subscriber subscriber, SyndicationSummary summary) The registered extension is passed in info on the subscriber and also a summary that contains info on what syndication did during the run.

Method Detail

onSubscriberCompleting

Result onSubscriberCompleting(Subscriber subscriber,
                              SyndicationSummary summary)

The registered extension is passed in info on the subscriber and also a summary that contains info on what syndication did during the run. This extension runs within the context of a virtual portal, which can be obtained from the repository

Parameters:

subscriber - the subscriber that is completing its run

summary - contains information about the completing run.

Returns:

the returned result allows the extension point to return information back to the extension provider.

See Also:

Repository.getCurrentVirtualPortalContext()