Package 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	Description
protected EmailHelper	emailHelper
protected static final String	GENERAL_SETTINGS_EP
protected GeneralSettingsDescriptor	generalSettings
protected Map<String,NotificationListenerHook>	hookListeners
static final ComponentName	NAME
protected static final String	NOTIFICATION_HOOK_EP
protected static final String	NOTIFICATION_VETO_EP
protected NotificationRegistry	notificationRegistry
protected static final String	NOTIFICATIONS_EP
protected List<NotificationListenerVeto>	notificationVetos
protected EventProducer	producer
protected String	senderName
protected static final String	TEMPLATES_EP
protected Map<String,URL>	templateUrls

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

lastModified, name

Constructor Summary

Constructors

Constructor	Description
NotificationService()

Method Summary

Modifier and Type	Method	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 static DocumentModel	detachDocumentModel(DocumentModel doc)
protected void	disableEvents(DocumentModel doc)
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	getMailSenderName()	Returns the name of the MailSender that will handle notification MailMessages
String	getMailSessionJndiName()	Deprecated. since 2023.4 use getMailSenderName() instead.
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.
List<Notification>	getNotificationsForEvents(String eventId)
List<Notification>	getNotificationsForSubscriptions(String parentType)
Collection<NotificationListenerVeto>	getNotificationVetos()
String	getServerUrlPrefix()
List<DocumentModel>	getSubscribedDocuments(String prefixedPrincipalName, String repositoryName)	Returns the list of live docs the user is subscribed to in the given repository .
List<String>	getSubscribers(String notification, DocumentModel doc)	Gets the users that subscribed to a notification on a certain document.
List<String>	getSubscriptionsForUserOnDocument(String username, DocumentModel doc)	Gets the notifications for which a user subscribed for a certain document.
URL	getTemplateUrl(String name)
static URL	getTemplateURL(String name)	Deprecated, for removal: This API element is subject to removal in a future version. since 2025.0, use NotificationManager.getTemplateUrl(String) instead
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 subscriptions.
void	registerContribution(Object contribution, String xp, ComponentInstance component)
void	removeSubscription(String username, String notification, DocumentModel doc)	Called when a user cancels his notification.
void	removeSubscriptions(String username, List<String> notifications, DocumentModel doc)
protected void	restoreEvents(DocumentModel doc)
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	start(ComponentContext context)	Start the component.
void	stop(ComponentContext context)	Stop the component.
void	unregisterContribution(Object contribution, String xp, ComponentInstance component)

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

addRuntimeMessage, addRuntimeMessage, getDescriptor, getDescriptors, getLastModified, getRegistry, register, registerExtension, setLastModified, setModifiedNow, setName, unregister, unregisterExtension

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.nuxeo.runtime.model.Component

getApplicationStartedOrder

Field Details

NAME

public static final ComponentName NAME

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

templateUrls

protected Map<String,URL> templateUrls

emailHelper

protected EmailHelper emailHelper

generalSettings

protected GeneralSettingsDescriptor generalSettings

notificationRegistry

protected NotificationRegistry notificationRegistry

hookListeners

protected Map<String,NotificationListenerHook> hookListeners

notificationVetos

protected List<NotificationListenerVeto> notificationVetos

senderName

protected String senderName

producer

protected EventProducer producer

Constructor Details

NotificationService

public NotificationService()

Method Details

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

start

public void start(ComponentContext context)

Description copied from interface: Component

Start the component. This method is called after all the components were resolved and activated

Specified by:

start in interface Component

Overrides:

start in class DefaultComponent

stop

public void stop(ComponentContext context)

Description copied from interface: Component

Stop the component.

Specified by:

stop in interface Component

Overrides:

stop in class DefaultComponent

registerContribution

public void registerContribution(Object contribution,
 String xp,
 ComponentInstance component)

Overrides:

registerContribution in class DefaultComponent

unregisterContribution

public void unregisterContribution(Object contribution,
 String xp,
 ComponentInstance component)

Overrides:

unregisterContribution in class DefaultComponent

getTemplateUrl

public URL getTemplateUrl(String name)

Specified by:

getTemplateUrl in interface NotificationManager

Parameters:

name - the template name

Returns:

the url associated to the template with the given name

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

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

disableEvents

protected void disableEvents(DocumentModel doc)

restoreEvents

protected void restoreEvents(DocumentModel doc)

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,
 DocumentModel doc)

Specified by:

removeSubscriptions in interface NotificationManager

doFireEvent

protected void doFireEvent(Event event)

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

getTemplateURL

@Deprecated(since="2025.0",
            forRemoval=true)
public static URL getTemplateURL(String name)

Deprecated, for removal: This API element is subject to removal in a future version.

since 2025.0, use NotificationManager.getTemplateUrl(String) instead

getServerUrlPrefix

public String getServerUrlPrefix()

getEMailSubjectPrefix

public String getEMailSubjectPrefix()

getMailSessionJndiName

@Deprecated(since="2023.4")
public String getMailSessionJndiName()

Deprecated.

since 2023.4 use getMailSenderName() instead.

getMailSenderName

public String getMailSenderName()

Description copied from interface: NotificationManager

Returns the name of the MailSender that will handle notification MailMessages

Specified by:

getMailSenderName in interface NotificationManager

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 addresses 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 subscriptions.

Specified by:

getUsersSubscribedToNotificationOnDocument in interface NotificationManager

getSubscribedDocuments

public List<DocumentModel> getSubscribedDocuments(String prefixedPrincipalName,
 String repositoryName)

Description copied from interface: NotificationManager

Returns the list of live docs the user is subscribed to in the given repository .

Specified by:

getSubscribedDocuments in interface NotificationManager

detachDocumentModel

protected static DocumentModel detachDocumentModel(DocumentModel doc)