org.nuxeo.ecm.platform.ec.notification.service

Class NotificationService

java.lang.Object

org.nuxeo.runtime.model.DefaultComponent

org.nuxeo.ecm.platform.ec.notification.service.NotificationService

All Implemented Interfaces:

NotificationManager, Adaptable, Component, Extensible, TimestampedService

public class NotificationService
extends DefaultComponent
implements NotificationManager

Author:

Narcis Paslaru

Field Summary

Fields

Modifier and Type	Field and Description
protected DocumentViewCodecManager	docLocator
protected EmailHelper	emailHelper
protected static String	GENERAL_SETTINGS_EP
protected GeneralSettingsDescriptor	generalSettings
protected Map<String,NotificationListenerHook>	hookListeners
static ComponentName	NAME
protected static String	NOTIFICATION_HOOK_EP
protected static String	NOTIFICATION_VETO_EP
protected NotificationRegistry	notificationRegistry
protected static String	NOTIFICATIONS_EP
protected NotificationListenerVetoRegistry	notificationVetoRegistry
protected EventProducer	producer
static String	SUBSCRIPTION_NAME
protected static String	TEMPLATES_EP
protected static Map<String,URL>	TEMPLATES_MAP

Fields inherited from class org.nuxeo.runtime.model.DefaultComponent

lastModified

Constructor Summary

Constructors

Constructor and Description
NotificationService()

Method Summary

Modifier and Type	Method and Description
void	activate(ComponentContext context) Activates the component.
void	addSubscription(String username, String notification, DocumentModel doc, Boolean sendConfirmationEmail, NuxeoPrincipal principal, String notificationName) Called when a user subscribes to a notification.
void	addSubscriptions(String username, DocumentModel doc, Boolean sendConfirmationEmail, NuxeoPrincipal principal)
void	deactivate(ComponentContext context) Deactivates the component.
protected void	doFireEvent(Event event)
<T> T	getAdapter(Class<T> adapter) Returns an object which is an instance of the given class associated with this object.
EmailHelper	getEmailHelper()
String	getEMailSubjectPrefix()
Collection<NotificationListenerHook>	getListenerHooks()
String	getMailSessionJndiName()
Notification	getNotificationByName(String selectedNotification) Returns a notification with all data loaded (label, etc).
Set<String>	getNotificationEventNames() Gets the list of event names used by notifications.
NotificationListenerVetoRegistry	getNotificationListenerVetoRegistry()
NotificationRegistry	getNotificationRegistry() Returns the notification manager.
List<Notification>	getNotificationsForEvents(String eventId)
List<Notification>	getNotificationsForSubscriptions(String parentType)
Collection<NotificationListenerVeto>	getNotificationVetos()
String	getServerUrlPrefix()
List<DocumentModel>	getSubscribedDocuments(String prefixedPrincipalName) Returns the list of live docs the user is subscribed to.
List<String>	getSubscribers(String notification, DocumentModel doc) Gets the users that subscribed to a notification on a certain document.
List<String>	getSubscribers(String notification, String docId) Deprecated. since 7.3
List<String>	getSubscriptionsForUserOnDocument(String username, DocumentModel doc) Gets the notifications for which a user subscribed for a certain document.
List<String>	getSubscriptionsForUserOnDocument(String username, String docId) Deprecated. since 7.3
static URL	getTemplateURL(String name)
List<String>	getUsersSubscribedToNotificationOnDocument(String notification, DocumentModel doc) Gets all users and groups that subscribed to a notification on a document This is used in management of subscritptions.
List<String>	getUsersSubscribedToNotificationOnDocument(String notification, String docId) Deprecated.
void	registerExtension(Extension extension) Registers the given extension.
protected void	registerGeneralSettings(GeneralSettingsDescriptor desc)
void	removeSubscription(String username, String notification, DocumentModel doc) Called when a user cancels his notification.
void	removeSubscription(String username, String notification, String docId) Called when a user cancels his notification.
void	removeSubscriptions(String username, List<String> notifications, DocumentModel doc)
void	removeSubscriptions(String username, List<String> notifications, String docId)
void	sendDocumentByMail(DocumentModel doc, String freemarkerTemplateName, String subject, String comment, NuxeoPrincipal sender, List<String> sendTo) Sends an e-mail directly.
void	sendNotification(String notificationName, Map<String,Object> infoMap, String userPrincipal) Directly sends a notification to the principal, using the data provided in the map
void	setEmailHelper(EmailHelper emailHelper)
void	unregisterExtension(Extension extension) Unregisters the given extension.

Methods inherited from class org.nuxeo.runtime.model.DefaultComponent

applicationStarted, getApplicationStartedOrder, getLastModified, registerContribution, setLastModified, setModifiedNow, unregisterContribution

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final ComponentName NAME

SUBSCRIPTION_NAME

public static final String SUBSCRIPTION_NAME

See Also:

Constant Field Values

NOTIFICATIONS_EP

protected static final String NOTIFICATIONS_EP

See Also:

Constant Field Values

TEMPLATES_EP

protected static final String TEMPLATES_EP

See Also:

Constant Field Values

GENERAL_SETTINGS_EP

protected static final String GENERAL_SETTINGS_EP

See Also:

Constant Field Values

NOTIFICATION_HOOK_EP

protected static final String NOTIFICATION_HOOK_EP

See Also:

Constant Field Values

NOTIFICATION_VETO_EP

protected static final String NOTIFICATION_VETO_EP

See Also:

Constant Field Values

TEMPLATES_MAP

protected static final Map<String,URL> TEMPLATES_MAP

emailHelper

protected EmailHelper emailHelper

generalSettings

protected GeneralSettingsDescriptor generalSettings

notificationRegistry

protected NotificationRegistry notificationRegistry

docLocator

protected DocumentViewCodecManager docLocator

hookListeners

protected final Map<String,NotificationListenerHook> hookListeners

notificationVetoRegistry

protected NotificationListenerVetoRegistry notificationVetoRegistry

producer

protected EventProducer producer

Constructor Detail

NotificationService

public NotificationService()

Method Detail

getAdapter

public <T> T getAdapter(Class<T> adapter)

Description copied from interface: Adaptable

Returns an object which is an instance of the given class associated with this object. Returns null if no such object can be found.

Specified by:

getAdapter in interface Adaptable

Overrides:

getAdapter in class DefaultComponent

Parameters:

adapter - the adapter class to look up

Returns:

a object castable to the given class, or null if this object does not have an adapter for the given class

activate

public void activate(ComponentContext context)

Description copied from interface: Component

Activates the component.

This method is called by the runtime when a component is activated.

Specified by:

activate in interface Component

Overrides:

activate in class DefaultComponent

Parameters:

context - the runtime context

deactivate

public void deactivate(ComponentContext context)

Description copied from interface: Component

Deactivates the component.

This method is called by the runtime when a component is deactivated.

Specified by:

deactivate in interface Component

Overrides:

deactivate in class DefaultComponent

Parameters:

context - the runtime context

registerExtension

public void registerExtension(Extension extension)

Description copied from interface: Extensible

Registers the given extension.

Specified by:

registerExtension in interface Extensible

Overrides:

registerExtension in class DefaultComponent

Parameters:

extension - the extension to register

registerGeneralSettings

protected void registerGeneralSettings(GeneralSettingsDescriptor desc)

unregisterExtension

public void unregisterExtension(Extension extension)

Description copied from interface: Extensible

Unregisters the given extension.

Specified by:

unregisterExtension in interface Extensible

Overrides:

unregisterExtension in class DefaultComponent

Parameters:

extension - the extension to unregister

getNotificationRegistry

public NotificationRegistry getNotificationRegistry()

Description copied from interface: NotificationManager

Returns the notification manager.

Specified by:

getNotificationRegistry in interface NotificationManager

getNotificationListenerVetoRegistry

public NotificationListenerVetoRegistry getNotificationListenerVetoRegistry()

getSubscribers

@Deprecated
public List<String> getSubscribers(String notification,
                                               String docId)

Deprecated. since 7.3

Description copied from interface: NotificationManager

Gets the users that subscribed to a notification on a certain document.

Specified by:

getSubscribers in interface NotificationManager

See Also:

getSubscribers(String, DocumentModel)

getSubscribers

public List<String> getSubscribers(String notification,
                                   DocumentModel doc)

Description copied from interface: NotificationManager

Gets the users that subscribed to a notification on a certain document.

Specified by:

getSubscribers in interface NotificationManager

getSubscriptionsForUserOnDocument

@Deprecated
public List<String> getSubscriptionsForUserOnDocument(String username,
                                                                  String docId)

Deprecated. since 7.3

Description copied from interface: NotificationManager

Gets the notifications for which a user subscribed for a certain document.

Specified by:

getSubscriptionsForUserOnDocument in interface NotificationManager

See Also:

getSubscriptionsForUserOnDocument(String, DocumentModel)

getSubscriptionsForUserOnDocument

public List<String> getSubscriptionsForUserOnDocument(String username,
                                                      DocumentModel doc)

Description copied from interface: NotificationManager

Gets the notifications for which a user subscribed for a certain document.

Specified by:

getSubscriptionsForUserOnDocument in interface NotificationManager

addSubscription

public void addSubscription(String username,
                            String notification,
                            DocumentModel doc,
                            Boolean sendConfirmationEmail,
                            NuxeoPrincipal principal,
                            String notificationName)

Description copied from interface: NotificationManager

Called when a user subscribes to a notification.

Specified by:

addSubscription in interface NotificationManager

addSubscriptions

public void addSubscriptions(String username,
                             DocumentModel doc,
                             Boolean sendConfirmationEmail,
                             NuxeoPrincipal principal)

Specified by:

addSubscriptions in interface NotificationManager

removeSubscriptions

public void removeSubscriptions(String username,
                                List<String> notifications,
                                String docId)

Specified by:

removeSubscriptions in interface NotificationManager

removeSubscriptions

public void removeSubscriptions(String username,
                                List<String> notifications,
                                DocumentModel doc)

Specified by:

removeSubscriptions in interface NotificationManager

doFireEvent

protected void doFireEvent(Event event)

removeSubscription

public void removeSubscription(String username,
                               String notification,
                               String docId)

Description copied from interface: NotificationManager

Called when a user cancels his notification.

Specified by:

removeSubscription in interface NotificationManager

removeSubscription

public void removeSubscription(String username,
                               String notification,
                               DocumentModel doc)

Description copied from interface: NotificationManager

Called when a user cancels his notification.

Specified by:

removeSubscription in interface NotificationManager

getUsersSubscribedToNotificationOnDocument

@Deprecated
public List<String> getUsersSubscribedToNotificationOnDocument(String notification,
                                                                           String docId)

Deprecated.

Specified by:

getUsersSubscribedToNotificationOnDocument in interface NotificationManager

Parameters:

notification -

docId -

Returns:

See Also:

getSubscribers(String, DocumentModel)

getTemplateURL

public static URL getTemplateURL(String name)

getServerUrlPrefix

public String getServerUrlPrefix()

getEMailSubjectPrefix

public String getEMailSubjectPrefix()

getMailSessionJndiName

public String getMailSessionJndiName()

getNotificationByName

public Notification getNotificationByName(String selectedNotification)

Description copied from interface: NotificationManager

Returns a notification with all data loaded (label, etc).

Specified by:

getNotificationByName in interface NotificationManager

sendNotification

public void sendNotification(String notificationName,
                             Map<String,Object> infoMap,
                             String userPrincipal)

Description copied from interface: NotificationManager

Directly sends a notification to the principal, using the data provided in the map

The map should contain at least the userName of the user calling the method stored under the key "author".

infoMap should also contain all the variables that should be used to make-up the body of the notifications message.

Specified by:

sendNotification in interface NotificationManager

Parameters:

notificationName - name of notification

infoMap - data used to compose the notification body

userPrincipal - recipient used to get the adress(es) to send emails

sendDocumentByMail

public void sendDocumentByMail(DocumentModel doc,
                               String freemarkerTemplateName,
                               String subject,
                               String comment,
                               NuxeoPrincipal sender,
                               List<String> sendTo)

Description copied from interface: NotificationManager

Sends an e-mail directly.

Specified by:

sendDocumentByMail in interface NotificationManager

getNotificationsForSubscriptions

public List<Notification> getNotificationsForSubscriptions(String parentType)

Specified by:

getNotificationsForSubscriptions in interface NotificationManager

getNotificationsForEvents

public List<Notification> getNotificationsForEvents(String eventId)

Specified by:

getNotificationsForEvents in interface NotificationManager

getEmailHelper

public EmailHelper getEmailHelper()

setEmailHelper

public void setEmailHelper(EmailHelper emailHelper)

getNotificationEventNames

public Set<String> getNotificationEventNames()

Description copied from interface: NotificationManager

Gets the list of event names used by notifications.

Specified by:

getNotificationEventNames in interface NotificationManager

getListenerHooks

public Collection<NotificationListenerHook> getListenerHooks()

getNotificationVetos

public Collection<NotificationListenerVeto> getNotificationVetos()

getUsersSubscribedToNotificationOnDocument

public List<String> getUsersSubscribedToNotificationOnDocument(String notification,
                                                               DocumentModel doc)

Description copied from interface: NotificationManager

Gets all users and groups that subscribed to a notification on a document This is used in management of subscritptions.

Specified by:

getUsersSubscribedToNotificationOnDocument in interface NotificationManager

getSubscribedDocuments

public List<DocumentModel> getSubscribedDocuments(String prefixedPrincipalName)

Description copied from interface: NotificationManager

Returns the list of live docs the user is subscribed to.

Specified by:

getSubscribedDocuments in interface NotificationManager

Returns: