eu.dnetlib.enabling.is.sn

Interface SubscriptionRegistry

All Known Implementing Classes:

ResourceStateSubscriptionRegistry

public interface SubscriptionRegistry

A subscription registry stores subscriptions.

Different subscription registries know how to to store different kind of subscriptions. Each registry is specialized in one type of subscriptions and knows how to quickly find all potentially interesting subscriptions so that a particular NotificationDetector can do his job the quickest way possible.

This interface is generic only for subscription purposes because the Subscriber component simply tries to register a new subscription to all available subscription registries.

Normally a subscription registry manages only a set of topic expression prefixes, but this interface doesn't force the Subscriber to know this information; instead the subscription registry itself will decide whether to accept the subscription or not.

Since many subscription registries may accept the same subscription, the identifier is preallocated by the Subscriber, since the subscription is only one, and even if we give the possibility for several detectors to detect it from different sources only one event will be generated.

Author:

marko

Method Summary

Modifier and Type	Method and Description
Collection<ResourceStateSubscription>	listMatchingSubscriptions(String prefix, String type, String resId) return all subscriptions matching a given prefix and a given type.
Collection<ResourceStateSubscription>	listSubscriptions() return all subscriptions.
String	registerSubscription(SubscriptionRequest subscription) register a subscription.
boolean	removeSubscription(String subscriptionId) removes a particular subscription.
boolean	unsubscribe(String subId) Unsubscribe a subscription if it exists.

Method Detail

registerSubscription

String registerSubscription(SubscriptionRequest subscription)
                     throws eu.dnetlib.enabling.is.sn.rmi.SubscriptionRequestRejectedException

register a subscription.

Parameters:

subscription - subscription request

Returns:

if we can accept this subcription we return the (possibly changed) identifier, otherwise null

Throws:

eu.dnetlib.enabling.is.sn.rmi.SubscriptionRequestRejectedException

unsubscribe

boolean unsubscribe(String subId)

Unsubscribe a subscription if it exists.

Parameters:

subId - subscription identifier

Returns:

true if this subscription existed and was successfully removed

listMatchingSubscriptions

Collection<ResourceStateSubscription> listMatchingSubscriptions(String prefix,
                                                                String type,
                                                                String resId)

return all subscriptions matching a given prefix and a given type. Wildcard subscriptions will match any resource type.

Parameters:

prefix - prefix

type - concrete type

resId - resource identifier

Returns:

all matching subscriptions

listSubscriptions

Collection<ResourceStateSubscription> listSubscriptions()

return all subscriptions.

Returns:

all subscriptions

removeSubscription

boolean removeSubscription(String subscriptionId)

removes a particular subscription.

Parameters:

subscriptionId - identifier

Returns:

true if successful