net.sf.flock
Interface SubscriptionManagerI

All Known Implementing Classes:

SimpleSubscriptionManager

public interface SubscriptionManagerI

Service interface for managing subscriptions.

Version:

$Revision$

Author:

$Author$

Method Summary

java.util.Collection	getAggregateFeed(java.lang.String path, int maxItems)
ITreeNode	getHierarchy()
SubscriptionI	getSubscription(java.net.URL url) Get a given a subscription.
java.util.Collection	getSubscriptionInfos() Get lightweight information about all subscriptions.
void	refresh(java.net.URL url) Refresh a subscription (synchronously).
boolean	refreshAll() Initiate asynchronous refresh cycle.
SubscriptionI[]	subscribe(SubscriptionInfoI subscriptionInfo) Create a new subscription.
SubscriptionI[]	subscribe(java.net.URL url, java.lang.String path) Short version of subscribe.
void	unsubscribe(java.net.URL url) Remove a subscription.

Method Detail

subscribe

public SubscriptionI[] subscribe(SubscriptionInfoI subscriptionInfo)
                          throws FlockResourceException

Create a new subscription.

Parameters:

subscriptionInfo -

Returns:

SubscriptionI[]

Throws:

FlockResourceException -

subscribe

public SubscriptionI[] subscribe(java.net.URL url,
                                 java.lang.String path)
                          throws FlockResourceException

Short version of subscribe.

Parameters:

url -

path -

Returns:

SubscriptionI[]

Throws:

FlockResourceException -

unsubscribe

public void unsubscribe(java.net.URL url)
                 throws FlockResourceException

Remove a subscription.

Parameters:

url - subscription location

Throws:

FlockResourceException -

getSubscription

public SubscriptionI getSubscription(java.net.URL url)
                              throws FlockResourceException

Get a given a subscription.

Parameters:

url - subscription location

Returns:

SubscriptionI

Throws:

FlockResourceException -

getSubscriptionInfos

public java.util.Collection getSubscriptionInfos()
                                          throws FlockResourceException

Get lightweight information about all subscriptions.

Returns:

Collection of SubscriptionInfoI objects

Throws:

FlockResourceException -

refresh

public void refresh(java.net.URL url)
             throws FlockResourceException

Refresh a subscription (synchronously).

Parameters:

url - subscription location

Throws:

FlockResourceException -

refreshAll

public boolean refreshAll()

Initiate asynchronous refresh cycle.

Returns:

boolean false if refresh cycle is already in progress

getHierarchy

public ITreeNode getHierarchy()
                       throws FlockResourceException

Returns:

ITreeNode

Throws:

FlockResourceException -

getAggregateFeed

public java.util.Collection getAggregateFeed(java.lang.String path,
                                             int maxItems)
                                      throws FlockResourceException

Parameters:

path -

maxItems -

Returns:

Collection

Throws:

FlockResourceException -