dekoh.portal.syndication.aggregator.managed
Class AggregationManager

java.lang.Object
  dekoh.portal.syndication.aggregator.managed.AggregationManager

public class AggregationManager
extends Object

Since:

Oct 8, 2007

Field Summary

protected static String

AGGREGATE_FEED_CACHE_PATH

Method Summary

Aggregator	createAggregator(SubscriptionList subscriptionList, long scheduleFrequency) Creates an Aggregator which will poll the SubscriptionItem in the supplied list at chosen frequency.
Aggregator	createAggregator(SubscriptionList subscriptionList, long scheduleFrequency, boolean reschedule)
Aggregator	createAggregator(SubscriptionList subscriptionList, long scheduleFrequency, String aggregatorId)
Aggregator	createAggregator(SubscriptionList subscriptionList, long scheduleFrequency, String aggregatorId, boolean reschedule)
Aggregator	createAggregator(SubscriptionList subscriptionList, long scheduleFrequency, String aggregatorId, SubscriptionItemFetcher subscriptionItemFetcher)
Aggregator	createAggregator(SubscriptionList subscriptionList, long scheduleFrequency, String aggregatorId, SubscriptionItemFetcher subscriptionItemFetcher, boolean reschedule)
Aggregator	createTrayAggregator(SubscriptionList subscriptionList, long scheduleFrequency, String aggregatorId, boolean reschedule)
void	destroyAggregator(String aggregatorId)
void	destroyAggregatorForList(SubscriptionList subscriptionList)
void	destroyAll()
static AggregationManager	getAggregationManager(DesktopUser desktopUser, PortalApplicationContext applicationContext)
Aggregator	getAggregator(String aggregatorId)
Collection	getAllAggregators()
Aggregator	getTrayAggregator()

Methods inherited from class java.lang.Object

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

Field Detail

AGGREGATE_FEED_CACHE_PATH

protected static final String AGGREGATE_FEED_CACHE_PATH

See Also:

Constant Field Values

Method Detail

getAggregationManager

public static AggregationManager getAggregationManager(DesktopUser desktopUser,
                                                       PortalApplicationContext applicationContext)

createAggregator

public Aggregator createAggregator(SubscriptionList subscriptionList,
                                   long scheduleFrequency)

Creates an Aggregator which will poll the SubscriptionItem in the supplied list at chosen frequency.

When a new SubscriptionItem is added to the supplied list, the Aggregator instance returned by this method will automatically rescheduled.

Parameters:

subscriptionList - SubscriptionList which will be aggregated with the created Aggregator

scheduleFrequency - Frequency in milliseconds at which the aggregator performs aggregation

Returns:

created instance of Aggregator. Calling method scheduleAggregation method will start the aggregator.

createAggregator

public Aggregator createAggregator(SubscriptionList subscriptionList,
                                   long scheduleFrequency,
                                   boolean reschedule)

createAggregator

public Aggregator createAggregator(SubscriptionList subscriptionList,
                                   long scheduleFrequency,
                                   String aggregatorId)
                            throws AggregatorAlreadyExistsException

Throws:

AggregatorAlreadyExistsException

createAggregator

public Aggregator createAggregator(SubscriptionList subscriptionList,
                                   long scheduleFrequency,
                                   String aggregatorId,
                                   SubscriptionItemFetcher subscriptionItemFetcher)
                            throws AggregatorAlreadyExistsException

Throws:

AggregatorAlreadyExistsException

createAggregator

public Aggregator createAggregator(SubscriptionList subscriptionList,
                                   long scheduleFrequency,
                                   String aggregatorId,
                                   boolean reschedule)
                            throws AggregatorAlreadyExistsException

Parameters:

subscriptionList - constituent items of this list will be aggregated when the created aggregator is started.

scheduleFrequency - how often should the aggregator run

aggregatorId - id of aggregator

reschedule - should the aggregator be rescheduled, so that addition of new SubscriptionItem is reflected in the aggregated feed immediately.

Returns:

created Aggregator

Throws:

AggregatorAlreadyExistsException - if an aggregator with given id already exists

createTrayAggregator

public Aggregator createTrayAggregator(SubscriptionList subscriptionList,
                                       long scheduleFrequency,
                                       String aggregatorId,
                                       boolean reschedule)
                                throws AggregatorAlreadyExistsException

Throws:

AggregatorAlreadyExistsException

createAggregator

public Aggregator createAggregator(SubscriptionList subscriptionList,
                                   long scheduleFrequency,
                                   String aggregatorId,
                                   SubscriptionItemFetcher subscriptionItemFetcher,
                                   boolean reschedule)
                            throws AggregatorAlreadyExistsException

Parameters:

subscriptionList - constituent items of this list will be aggregated when the created aggregator is started.

scheduleFrequency - how often should the aggregator run

aggregatorId - id of aggregator

subscriptionItemFetcher - SubscriptionItemFetcher which determines how the SubscriptionItems url will be derived

reschedule - should the aggregator be rescheduled, so that addition of new SubscriptionItem is reflected in the aggregated feed immediately.

Returns:

created Aggregator

Throws:

AggregatorAlreadyExistsException - if an aggregator with given id already exists

destroyAggregator

public void destroyAggregator(String aggregatorId)

destroyAggregatorForList

public void destroyAggregatorForList(SubscriptionList subscriptionList)

destroyAll

public void destroyAll()

getAllAggregators

public Collection getAllAggregators()

getAggregator

public Aggregator getAggregator(String aggregatorId)

getTrayAggregator

public Aggregator getTrayAggregator()