com.day.cq.wcm.notification

Interface NotificationManager

public interface NotificationManager

The notification manager manages the notification and subscription configurations. It can be used to query the configurations for a given authorizable update and create them.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	createSubscription(Authorizable authorizable, ValueMap configuration) Deprecated. Use subscribe(com.day.cq.security.Authorizable, java.util.Map) instead
Channel	getChannel(java.lang.String type) Return the channel.
PersistableValueMap	getChannelConfiguration(Authorizable authorizable, java.util.Map subscriptionConfig) Return the channel configuration for the subscription.
java.util.Iterator<PersistableValueMap>	getChannelConfigurations(Authorizable authorizable) Return all channel configurations for a given authorizable.
Node	getNotificationNode(Authorizable authorizable) Deprecated. Use NotificationUtil.getNotificationNode(Authorizable) instead
Subscription	getSubscription(java.lang.String type) Return the subscription.
java.util.Iterator<PersistableValueMap>	getSubscriptionConfigurations(Authorizable authorizable) Return all subscriptions for a given authorizable.
boolean	removeSubscription(Authorizable authorizable, PersistableValueMap configuration) Deprecated. Use unsubscribe(com.day.cq.security.Authorizable, String) instead.
boolean	subscribe(Authorizable authorizable, java.util.Map<java.lang.String,java.lang.Object> configuration) Create a new subscription for the authorizable.
boolean	unsubscribe(Authorizable authorizable, java.lang.String path) Remove all subscriptions matching the given path.

Method Detail

getSubscriptionConfigurations

java.util.Iterator<PersistableValueMap> getSubscriptionConfigurations(Authorizable authorizable)

Return all subscriptions for a given authorizable.

Parameters:

authorizable - The authorizable.

Returns:

An iterator for the subscription configurations.

getChannelConfigurations

java.util.Iterator<PersistableValueMap> getChannelConfigurations(Authorizable authorizable)

Return all channel configurations for a given authorizable.

Parameters:

authorizable - The authorizable.

Returns:

An iterator for the channel configurations.

getChannel

Channel getChannel(java.lang.String type)

Return the channel.

Parameters:

type - The channel type.

Returns:

The channel or null

getSubscription

Subscription getSubscription(java.lang.String type)

Return the subscription.

Parameters:

type - The subscription type.

Returns:

The subscription or null

getChannelConfiguration

PersistableValueMap getChannelConfiguration(Authorizable authorizable,
                                          java.util.Map subscriptionConfig)

Return the channel configuration for the subscription.

Parameters:

authorizable - The authorizable.

subscriptionConfig - The subscription configuration.

Returns:

The channel configuration or null

getNotificationNode

@Deprecated
Node getNotificationNode(Authorizable authorizable)
                         throws RepositoryException

Deprecated. Use NotificationUtil.getNotificationNode(Authorizable) instead

Return the node for the settings of the notification module of an authorizable.

Parameters:

authorizable - The authorizable.

Returns:

The node.

Throws:

RepositoryException - Upon encountering a repository error getting the notification node.

createSubscription

@Deprecated
boolean createSubscription(Authorizable authorizable,
                                    ValueMap configuration)

Deprecated. Use subscribe(com.day.cq.security.Authorizable, java.util.Map) instead

Create a new subscription for the authorizable.

Parameters:

authorizable - The authorizable.

configuration - The configuration.

Returns:

true if the configuration could be created, false otherwise.

removeSubscription

@Deprecated
boolean removeSubscription(Authorizable authorizable,
                                    PersistableValueMap configuration)

Deprecated. Use unsubscribe(com.day.cq.security.Authorizable, String) instead.

Remove the subscription.

Parameters:

authorizable - The authorizable.

configuration - The configuration.

Returns:

true if the configuration could be removed, false otherwise.

subscribe

boolean subscribe(Authorizable authorizable,
                java.util.Map<java.lang.String,java.lang.Object> configuration)

Create a new subscription for the authorizable.

Parameters:

authorizable - The authorizable.

configuration - The configuration.

Returns:

true if the configuration could be created, false otherwise.

unsubscribe

boolean unsubscribe(Authorizable authorizable,
                  java.lang.String path)

Remove all subscriptions matching the given path. The path denotes the item the user originally subscribed for.

Parameters:

authorizable - The authorizable.

path - The path of the subscription to remove.

Returns:

true if the configuration could be removed, false otherwise.