com.canto.cumulus.db.subscriptions

Class SubscriptionManager

java.lang.Object

com.canto.cumulus.db.subscriptions.SubscriptionManager

public class SubscriptionManager
extends java.lang.Object

Manages subscriptions on items.

Since:

9.2

Method Summary

Methods

Modifier and Type	Method and Description
void	addSubscription(Item item) Subscribe to the given item.
static SubscriptionManager	getInstance(Server server) Returns the subscription manager instance for the given server.
Server	getServer() Returns the server of this connection.
java.util.Set<java.lang.String>	getSubscriptions(Item item) Returns all user UIDs subscribed to the given item.
void	getUserSubscriptions(ItemCollection itemCollection) Replaces the content of the given collection with the items the current user is subscribed to.
void	getUserSubscriptions(MultiItemCollection multiItemCollection) Replaces the content of the given collection with the items the current user is subscribed to.
boolean	hasSubscription(Item item) Returns whether the current user has a subscription for the given item.
void	removeSubscription(Item item) Unsubscribe from the given item.
void	setSessionSubscriptionsDisabled(boolean disableSubscription) Enables or disables subscription notifications for this session.
boolean	supportsSubscriptions(Item item) Returns whether the current item supports subscriptions.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static SubscriptionManager getInstance(Server server)

Returns the subscription manager instance for the given server.

Parameters:

server - server to get the subscription manager for

Returns:

subscription manager

getServer

public Server getServer()

Returns the server of this connection.

Returns:

server

addSubscription

public void addSubscription(Item item)
                     throws CumulusException

Subscribe to the given item.

Parameters:

item - the item to subscribe for change notifications

Throws:

CumulusException - in case of an error

removeSubscription

public void removeSubscription(Item item)
                        throws CumulusException

Unsubscribe from the given item.

Parameters:

item - the item to unsubscribe from

Throws:

CumulusException - in case of an error

hasSubscription

public boolean hasSubscription(Item item)
                        throws CumulusException

Returns whether the current user has a subscription for the given item.

Parameters:

item - the item to unsubscribe from

Returns:

true if the current user has a subscription for the given item, false otherwise

Throws:

CumulusException - in case of an error

supportsSubscriptions

public boolean supportsSubscriptions(Item item)
                              throws CumulusException

Returns whether the current item supports subscriptions.

Parameters:

item - the item to check

Returns:

true if the current item supports subscriptions, false otherwise

Throws:

CumulusException - in case of an error

getSubscriptions

public java.util.Set<java.lang.String> getSubscriptions(Item item)
                                                 throws CumulusException

Returns all user UIDs subscribed to the given item.

Parameters:

item - the item to get the list of subscriptions for.

Returns:

user UIDs of subscribed users

Throws:

CumulusException - in case of an error

getUserSubscriptions

public void getUserSubscriptions(ItemCollection itemCollection)
                          throws CumulusException

Replaces the content of the given collection with the items the current user is subscribed to.

Parameters:

itemCollection - collection to contain all subscribed items

Throws:

CumulusException - in case of an error

getUserSubscriptions

public void getUserSubscriptions(MultiItemCollection multiItemCollection)
                          throws CumulusException

Replaces the content of the given collection with the items the current user is subscribed to.

Parameters:

multiItemCollection - collection to contain all subscribed items

Throws:

CumulusException - in case of an error

setSessionSubscriptionsDisabled

public void setSessionSubscriptionsDisabled(boolean disableSubscription)
                                     throws PermissionDeniedException

Enables or disables subscription notifications for this session. Only available for the Cumulus admin.

Parameters:

disableSubscription - true to disable subscription notifications, false to re-enable them

Throws:

PermissionDeniedException - if the current user is not the Cumulus admin