org.craftercms.studio.impl.v2.service.notification

Class NotificationServiceImpl

java.lang.Object

org.craftercms.studio.impl.v2.service.notification.NotificationServiceImpl

All Implemented Interfaces:

NotificationService

public class NotificationServiceImpl
extends Object
implements NotificationService

Field Summary

Fields

Modifier and Type	Field and Description
protected ConfigurationService	configurationService
protected ContentService	contentService
protected EmailMessageQueueTo	emailMessages
protected Map<String,Map<String,NotificationConfigTO>>	notificationConfiguration
protected SecurityService	securityService
protected ServicesConfig	servicesConfig
protected SiteService	siteService
protected StudioConfiguration	studioConfiguration

Fields inherited from interface org.craftercms.studio.api.v2.service.notification.NotificationService

COMPLETE_DELETE, COMPLETE_GO_LIVE, COMPLETE_REJECT, COMPLETE_SCHEDULE_GO_LIVE, COMPLETE_SUBMIT_TO_GO_LIVE

Constructor Summary

Constructors

Constructor and Description
NotificationServiceImpl()

Method Summary

Modifier and Type	Method and Description
protected Set<ContentItemTO>	convertPathsToContent(String site, List<String> listOfPaths)
String	getConfigPath()
ConfigurationService	getConfigurationService()
protected NotificationConfigTO	getNotificationConfig(String site, Locale locale)
String	getNotificationMessage(String site, NotificationMessageType type, String key, Locale locale, org.apache.commons.lang3.tuple.Pair<String,Object>... params) Gets and process notification message
StudioConfiguration	getStudioConfiguration()
String	getTemplateTimezone()
void	init()
protected void	loadCannedMessages(org.dom4j.Element completedMessages, Map<String,List<MessageTO>> messageContainer)
protected void	loadConfig(String site)
protected void	loadEmailTemplates(org.dom4j.Element emailTemplates, Map<String,EmailMessageTemplateTO> messageContainer)
protected void	loadGenericMessage(org.dom4j.Element emailTemplates, Map<String,String> messageContainer)
protected void	notify(String site, List<String> toUsers, String key, Locale locale, Map<String,Object> params)
void	notify(String site, List<String> toUsers, String key, Locale locale, org.apache.commons.lang3.tuple.Pair<String,Object>... params) Process and Sends a generic email.
void	notifyApprovesContentSubmission(String site, List<String> usersToNotify, List<String> itemsSubmitted, String submitter, ZonedDateTime scheduleDate, boolean isADelete, String submissionComments, Locale locale) Send to all given users a notification of content that need to be review.
void	notifyContentApproval(String site, String submitter, List<String> itemsSubmitted, String approver, ZonedDateTime scheduleDate, Locale locale) Sends Notification when content was approve.
void	notifyContentRejection(String site, String submittedBy, List<String> rejectedItems, String rejectionReason, String userThatRejects, Locale locale) Notifies to the submitter that the content has been rejected.
void	notifyDeploymentError(String name, Throwable throwable) Sends a email to configure emails when a deployment had fail
void	notifyDeploymentError(String site, Throwable throwable, List<String> filesUnableToPublish, Locale locale) Sends a email to configure emails when a deployment had fail
void	notifyRepositoryMergeConflict(String site, List<String> filesUnableToMerge, Locale locale) Send email to admin that repository has merge conflict
protected String	processMessage(String templateName, String message, Map<String,Object> templateModel)
void	reloadConfiguration(String site) Reloads the current configuration of the notification Service.
protected void	sendEmail(String message, String subject, List<String> sendTo)
void	setConfigurationService(ConfigurationService configurationService)
void	setContentService(ContentService contentService)
void	setEmailMessages(EmailMessageQueueTo emailMessages)
void	setSecurityService(SecurityService securityService)
void	setServicesConfig(ServicesConfig servicesConfig)
void	setSiteService(SiteService siteService)
void	setStudioConfiguration(StudioConfiguration studioConfiguration)

Methods inherited from class java.lang.Object

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

Field Detail

notificationConfiguration

protected Map<String,Map<String,NotificationConfigTO>> notificationConfiguration

contentService

protected ContentService contentService

emailMessages

protected EmailMessageQueueTo emailMessages

servicesConfig

protected ServicesConfig servicesConfig

siteService

protected SiteService siteService

securityService

protected SecurityService securityService

studioConfiguration

protected StudioConfiguration studioConfiguration

configurationService

protected ConfigurationService configurationService

Constructor Detail

NotificationServiceImpl

public NotificationServiceImpl()

Method Detail

init

public void init()

notifyDeploymentError

public void notifyDeploymentError(String site,
                                  Throwable throwable,
                                  List<String> filesUnableToPublish,
                                  Locale locale)

Description copied from interface: NotificationService

Sends a email to configure emails when a deployment had fail

Specified by:

notifyDeploymentError in interface NotificationService

Parameters:

site - Name of the site which the deployment fail.

throwable - Throwable error which break the deployment. (Can be null)

filesUnableToPublish - List of files that where unable to publish (can be null)

locale - Language of the notification ,if null defaults to English.

notifyDeploymentError

public void notifyDeploymentError(String name,
                                  Throwable throwable)

Description copied from interface: NotificationService

Sends a email to configure emails when a deployment had fail

Specified by:

notifyDeploymentError in interface NotificationService

Parameters:

name - Name of the site which the deployment fail.

throwable - Throwable error which break the deployment. (Can be null)

notifyContentApproval

public void notifyContentApproval(String site,
                                  String submitter,
                                  List<String> itemsSubmitted,
                                  String approver,
                                  ZonedDateTime scheduleDate,
                                  Locale locale)

Description copied from interface: NotificationService

Sends Notification when content was approve.

Specified by:

notifyContentApproval in interface NotificationService

Parameters:

site - Site of the Content.

submitter - User that submit the content to approval.

itemsSubmitted - List of Item paths that where approve (can be null)

approver - User that approve the content.

locale - Language of the notification ,if null defaults to English.

getNotificationMessage

public String getNotificationMessage(String site,
                                     NotificationMessageType type,
                                     String key,
                                     Locale locale,
                                     org.apache.commons.lang3.tuple.Pair<String,Object>... params)

Description copied from interface: NotificationService

Gets and process notification message

Specified by:

getNotificationMessage in interface NotificationService

Parameters:

site - Site of the Content.

type - Type of the message wanted.

key - key of the message wanted

locale - Language of the message ,if null defaults to English.

params - parameters of the message this params will be use to process the message string.

Returns:

the message in the given locale and processed with the given variables.

If message not found either by key/locale it will return a default string)

notifyApprovesContentSubmission

public void notifyApprovesContentSubmission(String site,
                                            List<String> usersToNotify,
                                            List<String> itemsSubmitted,
                                            String submitter,
                                            ZonedDateTime scheduleDate,
                                            boolean isADelete,
                                            String submissionComments,
                                            Locale locale)

Description copied from interface: NotificationService

Send to all given users a notification of content that need to be review.

Specified by:

notifyApprovesContentSubmission in interface NotificationService

Parameters:

site - Site of the Content.

usersToNotify - List of users (username) to be notify.

itemsSubmitted - List of Item paths that where approve (can be null)

submitter - User (username) that is submitting the content.

scheduleDate - When the content should go live (null if now (or as soon is approve)).

isADelete - Is this submission a delete one.

locale - Language of the message ,if null defaults to English.

notify

public void notify(String site,
                   List<String> toUsers,
                   String key,
                   Locale locale,
                   org.apache.commons.lang3.tuple.Pair<String,Object>... params)

Description copied from interface: NotificationService

Process and Sends a generic email.

Specified by:

notify in interface NotificationService

Parameters:

site - Site of the Content.

toUsers - List of recipients.

key - key of the message wanted

locale - Language of the message ,if null defaults to English.

params - parameters of the message this params will be use to process the message string.

notify

protected void notify(String site,
                      List<String> toUsers,
                      String key,
                      Locale locale,
                      Map<String,Object> params)

notifyContentRejection

public void notifyContentRejection(String site,
                                   String submittedBy,
                                   List<String> rejectedItems,
                                   String rejectionReason,
                                   String userThatRejects,
                                   Locale locale)

Description copied from interface: NotificationService

Notifies to the submitter that the content has been rejected.

Specified by:

notifyContentRejection in interface NotificationService

Parameters:

site - Site of the Content.

submittedBy - User that submitted the rejected content.

rejectedItems - Items that where rejected

rejectionReason - why the content was rejected.

userThatRejects - User that is rejecting the content.

locale - Language of the message ,if null defaults to English.

loadConfig

protected void loadConfig(String site)

loadGenericMessage

protected void loadGenericMessage(org.dom4j.Element emailTemplates,
                                  Map<String,String> messageContainer)

loadEmailTemplates

protected void loadEmailTemplates(org.dom4j.Element emailTemplates,
                                  Map<String,EmailMessageTemplateTO> messageContainer)

loadCannedMessages

protected void loadCannedMessages(org.dom4j.Element completedMessages,
                                  Map<String,List<MessageTO>> messageContainer)

reloadConfiguration

public void reloadConfiguration(String site)

Description copied from interface: NotificationService

Reloads the current configuration of the notification Service.

Specified by:

reloadConfiguration in interface NotificationService

Parameters:

site - Site to reload the notification service configuration.

getNotificationConfig

protected NotificationConfigTO getNotificationConfig(String site,
                                                     Locale locale)

sendEmail

protected void sendEmail(String message,
                         String subject,
                         List<String> sendTo)

processMessage

protected String processMessage(String templateName,
                                String message,
                                Map<String,Object> templateModel)

convertPathsToContent

protected Set<ContentItemTO> convertPathsToContent(String site,
                                                   List<String> listOfPaths)

notifyRepositoryMergeConflict

public void notifyRepositoryMergeConflict(String site,
                                          List<String> filesUnableToMerge,
                                          Locale locale)

Description copied from interface: NotificationService

Send email to admin that repository has merge conflict

Specified by:

notifyRepositoryMergeConflict in interface NotificationService

Parameters:

site - site with merge conflict

filesUnableToMerge - files unable to merge

locale - language of the message ,if null defaults to English.

getConfigPath

public String getConfigPath()

getTemplateTimezone

public String getTemplateTimezone()

setContentService

public void setContentService(ContentService contentService)

setEmailMessages

public void setEmailMessages(EmailMessageQueueTo emailMessages)

setServicesConfig

public void setServicesConfig(ServicesConfig servicesConfig)

setSiteService

public void setSiteService(SiteService siteService)

setSecurityService

public void setSecurityService(SecurityService securityService)

getStudioConfiguration

public StudioConfiguration getStudioConfiguration()

setStudioConfiguration

public void setStudioConfiguration(StudioConfiguration studioConfiguration)

getConfigurationService

public ConfigurationService getConfigurationService()

setConfigurationService

public void setConfigurationService(ConfigurationService configurationService)