uk.ac.cam.caret.sakai.rwiki.component.service.impl

Class SiteEmailNotificationRWiki

java.lang.Object

org.sakaiproject.util.EmailNotification

org.sakaiproject.util.SiteEmailNotification

uk.ac.cam.caret.sakai.rwiki.component.service.impl.SiteEmailNotificationRWiki

All Implemented Interfaces:

NotificationAction

public class SiteEmailNotificationRWiki
extends SiteEmailNotification

SiteEmailNotificationRWiki fills the notification message and headers with details from the content change that triggered the notification event.

Author:

Sakai Software Development Team, ieb

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	SiteEmailNotificationRWiki.MessageContent

Nested classes/interfaces inherited from class org.sakaiproject.util.EmailNotification

EmailNotification.RunSendToUsers

Field Summary

Fields inherited from class org.sakaiproject.util.EmailNotification

BOUNDARY_LINE, m_siteId, MIME_ADVISORY, MULTIPART_BOUNDARY, TERMINATION_LINE

Constructor Summary

Constructors

Constructor and Description
SiteEmailNotificationRWiki(RWikiObjectService rwikiObjectService, RenderService renderService, PreferenceService preferenceService, SiteService siteService, SecurityService securityService, EntityManager entityManager, ThreadLocalManager threadLocalManager, TimeService timeService, DigestService digestService, UserDirectoryService userDirectoryService) Construct.
SiteEmailNotificationRWiki(RWikiObjectService rwikiObjectService, RenderService renderService, PreferenceService preferenceService, SiteService siteService, SecurityService securityService, EntityManager entityManager, ThreadLocalManager threadLocalManager, TimeService timeService, DigestService digestService, UserDirectoryService userDirectoryService, String siteId) Construct.

Method Summary

Modifier and Type	Method and Description
NotificationAction	getClone()
protected List<String>	getHeaders(Event e)
protected String	getHtmlMessage(Event event)
protected int	getOption(User user, String notificationId, String resourceFilter, int eventPriority, Event event)
protected String	getPlainMessage(Event event)
protected List	getRecipients(Event event)
protected String	getSiteId(String context)
protected String	getTag(String title, boolean shouldUseHtml)
protected String	htmlContent(Event event)
protected String	plainTextContent(Event event)

Methods inherited from class org.sakaiproject.util.SiteEmailNotification

addSpecialRecipients, getResourceAbility, getTo, getToSite, getToSiteNoReply, refineToSiteMembers

Methods inherited from class org.sakaiproject.util.EmailNotification

digestRecipients, digestRecipients, findHeader, findHeaderValue, getFrom, getFromEventUser, getFromService, getMessage, getOption, getSite, getSubject, getType, htmlEnd, htmlHeaders, htmlPreamble, immediateRecipients, immediateRecipients, isImmediateDeliveryOption, isImmediateDeliveryOption, makeEmailNotification, notify, plainTextHeaders, reNotify, set, set, toXml

Methods inherited from class java.lang.Object

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

Constructor Detail

SiteEmailNotificationRWiki

public SiteEmailNotificationRWiki(RWikiObjectService rwikiObjectService,
                                  RenderService renderService,
                                  PreferenceService preferenceService,
                                  SiteService siteService,
                                  SecurityService securityService,
                                  EntityManager entityManager,
                                  ThreadLocalManager threadLocalManager,
                                  TimeService timeService,
                                  DigestService digestService,
                                  UserDirectoryService userDirectoryService)

Construct.

SiteEmailNotificationRWiki

public SiteEmailNotificationRWiki(RWikiObjectService rwikiObjectService,
                                  RenderService renderService,
                                  PreferenceService preferenceService,
                                  SiteService siteService,
                                  SecurityService securityService,
                                  EntityManager entityManager,
                                  ThreadLocalManager threadLocalManager,
                                  TimeService timeService,
                                  DigestService digestService,
                                  UserDirectoryService userDirectoryService,
                                  String siteId)

Construct.

Method Detail

getClone

public NotificationAction getClone()

Specified by:

getClone in interface NotificationAction

Overrides:

getClone in class SiteEmailNotification

getSiteId

protected String getSiteId(String context)

getPlainMessage

protected String getPlainMessage(Event event)

getHtmlMessage

protected String getHtmlMessage(Event event)

plainTextContent

protected String plainTextContent(Event event)

Overrides:

plainTextContent in class EmailNotification

htmlContent

protected String htmlContent(Event event)

Overrides:

htmlContent in class EmailNotification

getHeaders

protected List<String> getHeaders(Event e)

Overrides:

getHeaders in class EmailNotification

getTag

protected String getTag(String title,
                        boolean shouldUseHtml)

Overrides:

getTag in class EmailNotification

getOption

protected int getOption(User user,
                        String notificationId,
                        String resourceFilter,
                        int eventPriority,
                        Event event)

Overrides:

getOption in class EmailNotification

getRecipients

protected List getRecipients(Event event)

Overrides:

getRecipients in class SiteEmailNotification