com.silverpeas.subscribe
Interface ResourceSubscriptionService

All Known Implementing Classes:

AbstractResourceSubscriptionService, DefaultResourceSubscriptionService

public interface ResourceSubscriptionService

This interface defines some services for which it exists one default implementations and potentially one per component.

Author:

Yohann Chastagnier

Method Summary

SubscriptionSubscriberList	getSubscribersOfComponent(String componentInstanceId) Gets all subscribers registered on a component.
SubscriptionSubscriberList	getSubscribersOfComponentAndTypedResource(String componentInstanceId, SubscriptionResourceType resourceType, String resourceId) Gets all subscribers concerned by a specified resource represented by the given resource type and identifier.
SubscriptionSubscriberList	getSubscribersOfSubscriptionResource(SubscriptionResource subscriptionResource) Gets all subscribers concerned by a specified subscription resource.

Method Detail

getSubscribersOfComponent

SubscriptionSubscriberList getSubscribersOfComponent(String componentInstanceId)

Gets all subscribers registered on a component.
This service does not look at resources handled by the component but just explicit component subscriptions.

Parameters:

componentInstanceId - the identifier of the component instance from which subscription are requested.

Returns:

an instance of SubscriptionSubscriberList that represents a collection of SubscriptionSubscriber decorated with useful tool methods.

getSubscribersOfComponentAndTypedResource

SubscriptionSubscriberList getSubscribersOfComponentAndTypedResource(String componentInstanceId,
                                                                     SubscriptionResourceType resourceType,
                                                                     String resourceId)

Gets all subscribers concerned by a specified resource represented by the given resource type and identifier.
The inheritance of subscription is handled by this method. So if the aimed subscription resource has a parent subscription resource, subscribers of both of them are returned.

Parameters:

componentInstanceId - the identifier of the component instance from which subscription are requested.

resourceType - the type of the aimed resource.

resourceId - the identifier of the aime resource.

Returns:

an instance of SubscriptionSubscriberList that represents a collection of SubscriptionSubscriber decorated with useful tool methods.

getSubscribersOfSubscriptionResource

SubscriptionSubscriberList getSubscribersOfSubscriptionResource(SubscriptionResource subscriptionResource)

Gets all subscribers concerned by a specified subscription resource.
The inheritance of subscription is handled by this method. So if the aimed subscription resource has a parent subscription resource, subscribers of both of them are returned.

Parameters:

subscriptionResource - the instance of subscription resource.

Returns:

an instance of SubscriptionSubscriberList that represents a collection of SubscriptionSubscriber decorated with useful tool methods.