dekoh.portal.syndication
Class SyndicationService

java.lang.Object
  java.util.Observable
      dekoh.portal.syndication.SyndicationService

All Implemented Interfaces:

Iterable

public final class SyndicationService
extends Observable
implements Iterable

SyndicationService publishes the events from each of the Channel emitted by registered ChannelProviders to authenticated Dekoh network users.

Instance of SyndicationService can be obtained by calling method SyndicationService.getInstance().

Content applications intending to expose events note worthy to the users of Dekoh network are required to register implementations of ChannelProvider, usually during their start-up.

SyndicationService is a Dekoh Portal Service.

Since:

Mar 2, 2007

Nested Class Summary

static class

SyndicationService.FeedType

Field Summary

static SyndicationService

ourInstance

Method Summary

SyndicationService	deregisterChannelProvider(ChannelProvider channelProvider)
SyndicationService	deregisterChannelProviders(String componentId) Unregisters all the channels if any that were registered by the application with given component id.
ChannelProvider	getChannelProvider(String byName)
Set	getChannelProviders()
Set	getChannelProviders(Set accessLevels)
static SyndicationService	getInstance()
Iterator	iterator()
SyndicationService	registerChannelProvider(ChannelProvider channelProvider) Registers a ChannelProvider that needs syndication.

Methods inherited from class java.util.Observable

addObserver, clearChanged, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers, setChanged

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ourInstance

public static final SyndicationService ourInstance

Method Detail

getInstance

public static SyndicationService getInstance()

Returns:

instance of SyndicationService

registerChannelProvider

public SyndicationService registerChannelProvider(ChannelProvider channelProvider)

Registers a ChannelProvider that needs syndication.

Parameters:

channelProvider - a ChannelProvider implementation. if this is null, or if ChannelProvider.getComponentId() returns null this method will not register the channel provider.

Returns:

this instance

deregisterChannelProvider

public SyndicationService deregisterChannelProvider(ChannelProvider channelProvider)

deregisterChannelProviders

public SyndicationService deregisterChannelProviders(String componentId)

Unregisters all the channels if any that were registered by the application with given component id. After unregistration, the RSS/Atom feeds for that application will not be emitted.

This method is usually called when the application is being undeployed/stopped.

Parameters:

componentId - as in the component.xml of an application, cannot be null.

Returns:

this instance

iterator

public Iterator iterator()

Specified by:

iterator in interface Iterable

getChannelProviders

public Set getChannelProviders()

getChannelProviders

public Set getChannelProviders(Set accessLevels)

getChannelProvider

public ChannelProvider getChannelProvider(String byName)
                                   throws NoSuchChannelProviderException

Parameters:

byName -

Returns:

null if no provider by given name exists

Throws:

NoSuchChannelProviderException