Package fr.becpg.repo.notification.impl

Class NotificationRuleServiceImpl

java.lang.Object

fr.becpg.repo.notification.impl.NotificationRuleServiceImpl

All Implemented Interfaces:

NotificationRuleService

@Service("notificationRuleService")
public class NotificationRuleServiceImpl
extends Object
implements NotificationRuleService

NotificationRuleServiceImpl class.

Version:

$Id: $Id

Author:

rabah

Field Summary

Fields

Modifier and Type	Field	Description
private AlfrescoRepository<NotificationRuleListDataItem>	alfrescoRepository
private AttributeExtractorService	attributeExtractorService
private org.alfresco.service.cmr.security.AuthorityService	authorityService
private BatchQueueService	batchQueueService
private static final String	DATE_FIELD	Constant DATE_FIELD="dateField"
private EntityDictionaryService	dictionaryService
private static final String	DISPLAY_NAME	Constant DISPLAY_NAME="displayName"
private static final String	DISPLAY_PATH	Constant DISPLAY_PATH="displayPath"
private org.alfresco.service.cmr.download.DownloadService	downloadService
private static final String	ENTITYV2_SUBTYPE	Constant ENTITYV2_SUBTYPE="isEntityV2SubType"
private ExportSearchService	exportSearchService
private org.alfresco.service.cmr.model.FileFolderService	fileFolderService
private static final String	ITEM	Constant ITEM="item"
private static final String	ITEMS	Constant ITEMS="items"
private static final org.apache.commons.logging.Log	logger	Constant logger
private BeCPGMailService	mailService
private org.alfresco.service.namespace.NamespaceService	namespaceService
private static final String	NODE	Constant NODE="node"
private static final String	NODE_TYPE	Constant NODE_TYPE="type"
private org.alfresco.service.cmr.repository.NodeService	nodeService
private static final String	NOTIFICATION	Constant NOTIFICATION="notification"
private org.alfresco.service.cmr.security.PermissionService	permissionService
private org.alfresco.service.cmr.security.PersonService	personService
private ReportTplService	reportTplService
private RepoService	repoService
private org.alfresco.service.cmr.repository.ScriptService	scriptService
private SearchRuleService	searchRuleService
private org.alfresco.service.ServiceRegistry	serviceRegistry
private static final String	TARGET_PATH	Constant TARGET_PATH="targetPath"
private org.alfresco.service.transaction.TransactionService	transactionService

Constructor Summary

Constructors

Constructor	Description
NotificationRuleServiceImpl()

Method Summary

Modifier and Type	Method	Description
private Map<String,Object>	buildBaseModel(NotificationRuleListDataItem notification, Map<String,Object> templateArgs)	buildBaseModel.
private Map<org.alfresco.service.cmr.repository.NodeRef,Object>	buildEntities(List<org.alfresco.service.cmr.repository.NodeRef> items, NotificationRuleListDataItem notification)	buildEntities.
private SearchRuleFilter	buildSearchFilter(NotificationRuleListDataItem notification)	buildSearchFilter.
private Map<String,Object>	buildTemplateArgs(NotificationRuleListDataItem notification, SearchRuleFilter filter)	buildTemplateArgs.
private Consumer<org.alfresco.service.cmr.repository.NodeRef>	createMailSender(NotificationRuleListDataItem notification, Map<String,Object> templateArgs, Map<org.alfresco.service.cmr.repository.NodeRef,Object> entities, SearchRuleFilter searchFilter, SearchRuleResult searchResult)	createMailSender.
private boolean	emailAdminNotificationDisabled(String username)	emailAdminNotificationDisabled.
private void	executeScript(NotificationRuleListDataItem notification, List<org.alfresco.service.cmr.repository.NodeRef> items, Map<String,Object> templateArgs)	executeScript.
private void	executeScriptAll(NotificationRuleListDataItem notification, List<org.alfresco.service.cmr.repository.NodeRef> items, Map<String,Object> templateArgs)	executeScriptAll.
private void	executeScriptEach(NotificationRuleListDataItem notification, List<org.alfresco.service.cmr.repository.NodeRef> items, Map<String,Object> templateArgs)	executeScriptEach.
private void	executeScriptIfExists(NotificationRuleListDataItem notification, List<org.alfresco.service.cmr.repository.NodeRef> items, Map<String,Object> templateArgs)	executeScriptIfExists.
private Set<String>	extractAuthoritiesFromGroup(org.alfresco.service.cmr.repository.NodeRef authority)	extractAuthoritiesFromGroup.
private List<org.alfresco.service.cmr.repository.NodeRef>	getAllNotificationRule()	getAllNotificationRule.
private void	initializeNotification(NotificationRuleListDataItem notification)	initializeNotification.
private boolean	isAllowed(NotificationRuleListDataItem notification)	isAllowed.
private boolean	isEmptyResult(NotificationRuleListDataItem notification, SearchRuleResult result, SearchRuleFilter filter)	isEmptyResult.
private void	logNoObjects(NotificationRuleListDataItem notification, SearchRuleFilter filter)	logNoObjects.
private void	processReportTemplates(NotificationRuleListDataItem notification, SearchRuleResult searchResult, Consumer<org.alfresco.service.cmr.repository.NodeRef> mailSender)	processReportTemplates.
private String	resolveDateFieldTitle(SearchRuleFilter filter, String userName)	resolveDateFieldTitle.
private void	saveErrorLog(org.alfresco.service.cmr.repository.NodeRef notificationNodeRef, NotificationRuleListDataItem notification, Exception cause)	Record on the rule why it failed, so that it does not keep failing without ever saying so.
private void	sendMail(NotificationRuleListDataItem notification, Map<String,Object> templateArgs, SearchRuleFilter searchFilter, SearchRuleResult searchResult, org.alfresco.service.cmr.repository.NodeRef downloadNode, String userName, List<Object> userEntities)	sendMail.
void	sendNotifications()	sendNotifications.
private boolean	shouldSkip(NotificationRuleListDataItem notification)	shouldSkip.
private org.alfresco.service.cmr.repository.NodeRef	waitAndSaveDownload(org.alfresco.service.cmr.repository.NodeRef downloadNode, NotificationRuleListDataItem notification, org.alfresco.service.cmr.repository.NodeRef exportFolder, org.alfresco.service.cmr.repository.NodeRef reportTpl)	waitAndSaveDownload.

Methods inherited from class java.lang.Object

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

Field Details

logger

private static final org.apache.commons.logging.Log logger

Constant logger

DATE_FIELD

private static final String DATE_FIELD

Constant DATE_FIELD="dateField"

See Also:

• Constant Field Values

NODE_TYPE

private static final String NODE_TYPE

Constant NODE_TYPE="type"

See Also:

• Constant Field Values

NODE

private static final String NODE

Constant NODE="node"

See Also:

• Constant Field Values

ITEM

private static final String ITEM

Constant ITEM="item"

See Also:

• Constant Field Values

ITEMS

private static final String ITEMS

Constant ITEMS="items"

See Also:

• Constant Field Values

NOTIFICATION

private static final String NOTIFICATION

Constant NOTIFICATION="notification"

See Also:

• Constant Field Values

TARGET_PATH

private static final String TARGET_PATH

Constant TARGET_PATH="targetPath"

See Also:

• Constant Field Values

ENTITYV2_SUBTYPE

private static final String ENTITYV2_SUBTYPE

Constant ENTITYV2_SUBTYPE="isEntityV2SubType"

See Also:

• Constant Field Values

DISPLAY_PATH

private static final String DISPLAY_PATH

Constant DISPLAY_PATH="displayPath"

See Also:

• Constant Field Values

DISPLAY_NAME

private static final String DISPLAY_NAME

Constant DISPLAY_NAME="displayName"

See Also:

• Constant Field Values

nodeService

@Autowired
private org.alfresco.service.cmr.repository.NodeService nodeService

mailService

@Autowired
private BeCPGMailService mailService

serviceRegistry

@Autowired
@Qualifier("ServiceRegistry")
private org.alfresco.service.ServiceRegistry serviceRegistry

namespaceService

@Autowired
private org.alfresco.service.namespace.NamespaceService namespaceService

authorityService

@Autowired
private org.alfresco.service.cmr.security.AuthorityService authorityService

permissionService

@Autowired
private org.alfresco.service.cmr.security.PermissionService permissionService

dictionaryService

@Autowired
private EntityDictionaryService dictionaryService

searchRuleService

@Autowired
private SearchRuleService searchRuleService

scriptService

@Autowired
private org.alfresco.service.cmr.repository.ScriptService scriptService

batchQueueService

@Autowired
private BatchQueueService batchQueueService

alfrescoRepository

@Autowired
private AlfrescoRepository<NotificationRuleListDataItem> alfrescoRepository

reportTplService

@Autowired
private ReportTplService reportTplService

exportSearchService

@Autowired
private ExportSearchService exportSearchService

downloadService

@Autowired
private org.alfresco.service.cmr.download.DownloadService downloadService

repoService

@Autowired
private RepoService repoService

transactionService

@Autowired
private org.alfresco.service.transaction.TransactionService transactionService

fileFolderService

@Autowired
private org.alfresco.service.cmr.model.FileFolderService fileFolderService

personService

@Autowired
private org.alfresco.service.cmr.security.PersonService personService

attributeExtractorService

@Autowired
private AttributeExtractorService attributeExtractorService

Constructor Details

NotificationRuleServiceImpl

public NotificationRuleServiceImpl()

Method Details

sendNotifications

public void sendNotifications()

sendNotifications.

Specified by:

sendNotifications in interface NotificationRuleService

saveErrorLog

private void saveErrorLog(org.alfresco.service.cmr.repository.NodeRef notificationNodeRef,
 NotificationRuleListDataItem notification,
 Exception cause)

Record on the rule why it failed, so that it does not keep failing without ever saying so. The rule node has already been written by initializeNotification(fr.becpg.repo.notification.data.NotificationRuleListDataItem), so the calling transaction holds its row lock: writing the error log in a transaction of its own would wait on that lock until it times out and starve the remaining rules.

Parameters:

notificationNodeRef - a NodeRef object

notification - a NotificationRuleListDataItem object

cause - the failure to report

shouldSkip

private boolean shouldSkip(NotificationRuleListDataItem notification)

shouldSkip.

Parameters:

notification - a NotificationRuleListDataItem object

Returns:

a boolean

initializeNotification

private void initializeNotification(NotificationRuleListDataItem notification)

initializeNotification.

Parameters:

notification - a NotificationRuleListDataItem object

buildSearchFilter

private SearchRuleFilter buildSearchFilter(NotificationRuleListDataItem notification)

buildSearchFilter.

Parameters:

notification - a NotificationRuleListDataItem object

Returns:

a SearchRuleFilter object

isEmptyResult

private boolean isEmptyResult(NotificationRuleListDataItem notification,
 SearchRuleResult result,
 SearchRuleFilter filter)

isEmptyResult.

Parameters:

notification - a NotificationRuleListDataItem object

result - a SearchRuleResult object

filter - a SearchRuleFilter object

Returns:

a boolean

logNoObjects

private void logNoObjects(NotificationRuleListDataItem notification,
 SearchRuleFilter filter)

logNoObjects.

Parameters:

notification - a NotificationRuleListDataItem object

filter - a SearchRuleFilter object

buildTemplateArgs

private Map<String,Object> buildTemplateArgs(NotificationRuleListDataItem notification,
 SearchRuleFilter filter)

buildTemplateArgs.

Parameters:

notification - a NotificationRuleListDataItem object

filter - a SearchRuleFilter object

Returns:

a Map object

buildEntities

private Map<org.alfresco.service.cmr.repository.NodeRef,Object> buildEntities(List<org.alfresco.service.cmr.repository.NodeRef> items,
 NotificationRuleListDataItem notification)

buildEntities.

Parameters:

items - a List object

notification - a NotificationRuleListDataItem object

Returns:

a Map object

createMailSender

private Consumer<org.alfresco.service.cmr.repository.NodeRef> createMailSender(NotificationRuleListDataItem notification,
 Map<String,Object> templateArgs,
 Map<org.alfresco.service.cmr.repository.NodeRef,Object> entities,
 SearchRuleFilter searchFilter,
 SearchRuleResult searchResult)

createMailSender.

Parameters:

notification - a NotificationRuleListDataItem object

templateArgs - a Map object

entities - a Map object

searchFilter - a SearchRuleFilter object

searchResult - a SearchRuleResult object

Returns:

a Consumer object

sendMail

private void sendMail(NotificationRuleListDataItem notification,
 Map<String,Object> templateArgs,
 SearchRuleFilter searchFilter,
 SearchRuleResult searchResult,
 org.alfresco.service.cmr.repository.NodeRef downloadNode,
 String userName,
 List<Object> userEntities)

sendMail.

Parameters:

notification - a NotificationRuleListDataItem object

templateArgs - a Map object

searchFilter - a SearchRuleFilter object

searchResult - a SearchRuleResult object

downloadNode - a NodeRef object

userName - a String object

userEntities - a List object

resolveDateFieldTitle

private String resolveDateFieldTitle(SearchRuleFilter filter,
 String userName)

resolveDateFieldTitle.

Parameters:

filter - a SearchRuleFilter object

userName - a String object

Returns:

a String object

processReportTemplates

private void processReportTemplates(NotificationRuleListDataItem notification,
 SearchRuleResult searchResult,
 Consumer<org.alfresco.service.cmr.repository.NodeRef> mailSender)

processReportTemplates.

Parameters:

notification - a NotificationRuleListDataItem object

searchResult - a SearchRuleResult object

mailSender - a Consumer object

waitAndSaveDownload

private org.alfresco.service.cmr.repository.NodeRef waitAndSaveDownload(org.alfresco.service.cmr.repository.NodeRef downloadNode,
 NotificationRuleListDataItem notification,
 org.alfresco.service.cmr.repository.NodeRef exportFolder,
 org.alfresco.service.cmr.repository.NodeRef reportTpl)
                                                                 throws InterruptedException

waitAndSaveDownload.

Parameters:

downloadNode - a NodeRef object

notification - a NotificationRuleListDataItem object

exportFolder - a NodeRef object

reportTpl - a NodeRef object

Returns:

a NodeRef object

Throws:

InterruptedException - if any.

executeScriptIfExists

private void executeScriptIfExists(NotificationRuleListDataItem notification,
 List<org.alfresco.service.cmr.repository.NodeRef> items,
 Map<String,Object> templateArgs)

executeScriptIfExists.

Parameters:

notification - a NotificationRuleListDataItem object

items - a List object

templateArgs - a Map object

emailAdminNotificationDisabled

private boolean emailAdminNotificationDisabled(String username)

emailAdminNotificationDisabled.

Parameters:

username - a String object

Returns:

a boolean

executeScript

private void executeScript(NotificationRuleListDataItem notification,
 List<org.alfresco.service.cmr.repository.NodeRef> items,
 Map<String,Object> templateArgs)

executeScript.

Parameters:

notification - a NotificationRuleListDataItem object

items - a List object

templateArgs - a Map object

executeScriptEach

private void executeScriptEach(NotificationRuleListDataItem notification,
 List<org.alfresco.service.cmr.repository.NodeRef> items,
 Map<String,Object> templateArgs)

executeScriptEach.

Parameters:

notification - a NotificationRuleListDataItem object

items - a List object

templateArgs - a Map object

executeScriptAll

private void executeScriptAll(NotificationRuleListDataItem notification,
 List<org.alfresco.service.cmr.repository.NodeRef> items,
 Map<String,Object> templateArgs)

executeScriptAll.

Parameters:

notification - a NotificationRuleListDataItem object

items - a List object

templateArgs - a Map object

buildBaseModel

private Map<String,Object> buildBaseModel(NotificationRuleListDataItem notification,
 Map<String,Object> templateArgs)

buildBaseModel.

Parameters:

notification - a NotificationRuleListDataItem object

templateArgs - a Map object

Returns:

a Map object

extractAuthoritiesFromGroup

private Set<String> extractAuthoritiesFromGroup(org.alfresco.service.cmr.repository.NodeRef authority)

extractAuthoritiesFromGroup.

Parameters:

authority - a NodeRef object

Returns:

a Set object

getAllNotificationRule

private List<org.alfresco.service.cmr.repository.NodeRef> getAllNotificationRule()

getAllNotificationRule.

Returns:

a List object

isAllowed

private boolean isAllowed(NotificationRuleListDataItem notification)

isAllowed.

Parameters:

notification - a NotificationRuleListDataItem object

Returns:

a boolean