pl.net.bluesoft.rnd.pt.ext.bpmnotifications

Class BpmNotificationEngine

java.lang.Object

pl.net.bluesoft.rnd.pt.ext.bpmnotifications.BpmNotificationEngine

All Implemented Interfaces:

IBpmNotificationService

public class BpmNotificationEngine
extends Object
implements IBpmNotificationService

E-mail notification engine.

Author:

tlipski@bluesoft.net.pl, mpawlak@bluesoft.net.pl

Constructor Summary

Constructors

Constructor and Description
BpmNotificationEngine(ProcessToolRegistry registry)

Method Summary

Methods

Modifier and Type	Method and Description
void	addNotificationToSend(NotificationData notificationData) Process raw notification template data and send notification
void	addNotificationToSend(ProcessedNotificationData processedNotificationData) Methods add notification to queue for notifications to be sent in the next scheduler job run
static javax.mail.Message	createMessageFromNotification(BpmNotification notification, javax.mail.Session mailSession)
TemplateData	createTemplateData(String templateName, Locale locale)
String	findTemplate(String templateName)
List<TemplateArgumentDescription>	getDefaultArgumentDescriptions(I18NSource i18NSource)
List<NotificationHistoryEntry>	getNotificationHistoryEntries()
Collection<TemplateArgumentProvider>	getTemplateArgumentProviders()
ITemplateDataProvider	getTemplateDataProvider()
void	handleNotifications() The method check if there are any new notifications in database to be sent
void	handleNotificationsWithContext() The method check if there are any new notifications in database to be sent
void	invalidateCache()
void	onProcessStateChange(BpmTask task, ProcessInstance pi, String userLogin, boolean processStarted, boolean processEnded, boolean enteringStep)
ProcessedNotificationData	processNotificationData(NotificationData notificationData)
String	processTemplate(String templateName, TemplateData templateData)
void	refreshConfigIfNecessary()
void	registerTemplateArgumentProvider(TemplateArgumentProvider provider)
void	unregisterTemplateArgumentProvider(TemplateArgumentProvider provider)

Methods inherited from class java.lang.Object

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

Constructor Detail

BpmNotificationEngine

public BpmNotificationEngine(ProcessToolRegistry registry)

Method Detail

handleNotifications

public void handleNotifications()

The method check if there are any new notifications in database to be sent

handleNotificationsWithContext

public void handleNotificationsWithContext()

The method check if there are any new notifications in database to be sent

onProcessStateChange

public void onProcessStateChange(BpmTask task,
                        ProcessInstance pi,
                        String userLogin,
                        boolean processStarted,
                        boolean processEnded,
                        boolean enteringStep)

registerTemplateArgumentProvider

public void registerTemplateArgumentProvider(TemplateArgumentProvider provider)

Specified by:

registerTemplateArgumentProvider in interface IBpmNotificationService

unregisterTemplateArgumentProvider

public void unregisterTemplateArgumentProvider(TemplateArgumentProvider provider)

Specified by:

unregisterTemplateArgumentProvider in interface IBpmNotificationService

getTemplateArgumentProviders

public Collection<TemplateArgumentProvider> getTemplateArgumentProviders()

Specified by:

getTemplateArgumentProviders in interface IBpmNotificationService

getDefaultArgumentDescriptions

public List<TemplateArgumentDescription> getDefaultArgumentDescriptions(I18NSource i18NSource)

Specified by:

getDefaultArgumentDescriptions in interface IBpmNotificationService

getNotificationHistoryEntries

public List<NotificationHistoryEntry> getNotificationHistoryEntries()

Specified by:

getNotificationHistoryEntries in interface IBpmNotificationService

invalidateCache

public void invalidateCache()

Specified by:

invalidateCache in interface IBpmNotificationService

refreshConfigIfNecessary

public void refreshConfigIfNecessary()

addNotificationToSend

public void addNotificationToSend(NotificationData notificationData)
                           throws Exception

Description copied from interface: IBpmNotificationService

Process raw notification template data and send notification

Specified by:

addNotificationToSend in interface IBpmNotificationService

Throws:

Exception

addNotificationToSend

public void addNotificationToSend(ProcessedNotificationData processedNotificationData)
                           throws Exception

Methods add notification to queue for notifications to be sent in the next scheduler job run

Specified by:

addNotificationToSend in interface IBpmNotificationService

Throws:

Exception

createMessageFromNotification

public static javax.mail.Message createMessageFromNotification(BpmNotification notification,
                                               javax.mail.Session mailSession)
                                                        throws Exception

Throws:

Exception

findTemplate

public String findTemplate(String templateName)

Specified by:

findTemplate in interface IBpmNotificationService

processTemplate

public String processTemplate(String templateName,
                     TemplateData templateData)

Specified by:

processTemplate in interface IBpmNotificationService

createTemplateData

public TemplateData createTemplateData(String templateName,
                              Locale locale)

Specified by:

createTemplateData in interface IBpmNotificationService

processNotificationData

public ProcessedNotificationData processNotificationData(NotificationData notificationData)
                                                  throws Exception

Specified by:

processNotificationData in interface IBpmNotificationService

Throws:

Exception

getTemplateDataProvider

public ITemplateDataProvider getTemplateDataProvider()

Specified by:

getTemplateDataProvider in interface IBpmNotificationService