This is an automated email from the ASF dual-hosted git repository.
ilgrosso pushed a commit to branch 3_0_X
in repository https://gitbox.apache.org/repos/asf/syncope.git
The following commit(s) were added to refs/heads/3_0_X by this push:
new 7c67f0f25f Notification code improvements
7c67f0f25f is described below
commit 7c67f0f25f6c458a15a49d62fc4cad756407e34c
Author: Francesco Chicchiriccò <[email protected]>
AuthorDate: Tue Oct 15 14:27:41 2024 +0200
Notification code improvements
---
.../implementations/MyRecipientsProvider.groovy | 4 +-
.../syncope/common/lib/types/AuditLoggerName.java | 5 +-
.../api/notification/RecipientsProvider.java | 4 +-
.../provisioning/java/DefaultAuditManager.java | 6 +-
.../java/job/AbstractSchedTaskJobDelegate.java | 6 +-
.../AbstractNotificationJobDelegate.java | 23 ++---
.../notification/DefaultNotificationManager.java | 106 ++++++++++-----------
.../TestNotificationRecipientsProvider.java | 8 +-
.../syncope/fit/core/NotificationTaskITCase.java | 2 +-
9 files changed, 79 insertions(+), 85 deletions(-)
diff --git
a/client/idrepo/console/src/main/resources/org/apache/syncope/client/console/implementations/MyRecipientsProvider.groovy
b/client/idrepo/console/src/main/resources/org/apache/syncope/client/console/implementations/MyRecipientsProvider.groovy
index 1fe53ff713..39dfc7ea44 100644
---
a/client/idrepo/console/src/main/resources/org/apache/syncope/client/console/implementations/MyRecipientsProvider.groovy
+++
b/client/idrepo/console/src/main/resources/org/apache/syncope/client/console/implementations/MyRecipientsProvider.groovy
@@ -17,7 +17,9 @@
* under the License.
*/
import groovy.transform.CompileStatic
+import java.util.Map
import java.util.Set
+import org.apache.syncope.core.persistence.api.entity.Any
import org.apache.syncope.core.persistence.api.entity.Notification
import org.apache.syncope.core.provisioning.api.notification.RecipientsProvider
@@ -25,7 +27,7 @@ import
org.apache.syncope.core.provisioning.api.notification.RecipientsProvider
class MyRecipientsProvider implements RecipientsProvider {
@Override
- Set<String> provideRecipients(Notification notification) {
+ Set<String> provideRecipients(Notification notification, Any<?> any,
Map<String, Object> jexlVars) {
return Set.of();
}
}
diff --git
a/common/idrepo/lib/src/main/java/org/apache/syncope/common/lib/types/AuditLoggerName.java
b/common/idrepo/lib/src/main/java/org/apache/syncope/common/lib/types/AuditLoggerName.java
index 3e978b5393..b3440c945f 100644
---
a/common/idrepo/lib/src/main/java/org/apache/syncope/common/lib/types/AuditLoggerName.java
+++
b/common/idrepo/lib/src/main/java/org/apache/syncope/common/lib/types/AuditLoggerName.java
@@ -133,11 +133,8 @@ public class AuditLoggerName implements BaseBean {
eventBuilder.append(event);
}
eventBuilder.append(']');
-
if (result != null) {
- eventBuilder.append(":[").
- append(result).
- append(']');
+ eventBuilder.append(":[").append(result).append(']');
}
return eventBuilder.toString();
diff --git
a/core/provisioning-api/src/main/java/org/apache/syncope/core/provisioning/api/notification/RecipientsProvider.java
b/core/provisioning-api/src/main/java/org/apache/syncope/core/provisioning/api/notification/RecipientsProvider.java
index 6b3cef3cb2..f18feb3919 100644
---
a/core/provisioning-api/src/main/java/org/apache/syncope/core/provisioning/api/notification/RecipientsProvider.java
+++
b/core/provisioning-api/src/main/java/org/apache/syncope/core/provisioning/api/notification/RecipientsProvider.java
@@ -18,11 +18,13 @@
*/
package org.apache.syncope.core.provisioning.api.notification;
+import java.util.Map;
import java.util.Set;
+import org.apache.syncope.core.persistence.api.entity.Any;
import org.apache.syncope.core.persistence.api.entity.Notification;
@FunctionalInterface
public interface RecipientsProvider {
- Set<String> provideRecipients(Notification notification);
+ Set<String> provideRecipients(Notification notification, Any<?> any,
Map<String, Object> jexlVars);
}
diff --git
a/core/provisioning-java/src/main/java/org/apache/syncope/core/provisioning/java/DefaultAuditManager.java
b/core/provisioning-java/src/main/java/org/apache/syncope/core/provisioning/java/DefaultAuditManager.java
index 80c43b0931..9aa36c3d45 100644
---
a/core/provisioning-java/src/main/java/org/apache/syncope/core/provisioning/java/DefaultAuditManager.java
+++
b/core/provisioning-java/src/main/java/org/apache/syncope/core/provisioning/java/DefaultAuditManager.java
@@ -96,18 +96,16 @@ public class DefaultAuditManager implements AuditManager {
auditEntry.setDate(OffsetDateTime.now());
AuditConf auditConf =
auditConfDAO.find(auditEntry.getLogger().toAuditKey());
- boolean auditRequested = auditConf != null && auditConf.isActive();
- if (auditRequested) {
+ if (auditConf != null && auditConf.isActive()) {
return true;
}
auditEntry.setLogger(new AuditLoggerName(type, category, subcategory,
event, Result.FAILURE));
auditConf = auditConfDAO.find(auditEntry.getLogger().toAuditKey());
- auditRequested = auditConf != null && auditConf.isActive();
- return auditRequested;
+ return auditConf != null && auditConf.isActive();
}
@Transactional(propagation = Propagation.NOT_SUPPORTED)
diff --git
a/core/provisioning-java/src/main/java/org/apache/syncope/core/provisioning/java/job/AbstractSchedTaskJobDelegate.java
b/core/provisioning-java/src/main/java/org/apache/syncope/core/provisioning/java/job/AbstractSchedTaskJobDelegate.java
index 99ac1490de..e8f1297d49 100644
---
a/core/provisioning-java/src/main/java/org/apache/syncope/core/provisioning/java/job/AbstractSchedTaskJobDelegate.java
+++
b/core/provisioning-java/src/main/java/org/apache/syncope/core/provisioning/java/job/AbstractSchedTaskJobDelegate.java
@@ -177,7 +177,7 @@ public abstract class AbstractSchedTaskJobDelegate<T
extends SchedTask> implemen
AuditElements.EventCategoryType.TASK,
this.getClass().getSimpleName(),
null,
- this.getClass().getSimpleName(), // searching for before
object is too much expensive ...
+ this.getClass().getSimpleName(),
result,
task,
execution);
@@ -187,10 +187,10 @@ public abstract class AbstractSchedTaskJobDelegate<T
extends SchedTask> implemen
AuditElements.EventCategoryType.TASK,
task.getClass().getSimpleName(),
null,
- null, // searching for before object is too much expensive ...
+ this.getClass().getSimpleName(),
result,
task,
- null);
+ execution);
if (manageOperationId) {
MDC.remove(OPERATION_ID);
diff --git
a/core/provisioning-java/src/main/java/org/apache/syncope/core/provisioning/java/job/notification/AbstractNotificationJobDelegate.java
b/core/provisioning-java/src/main/java/org/apache/syncope/core/provisioning/java/job/notification/AbstractNotificationJobDelegate.java
index 8754cbf731..17f0ffd34e 100644
---
a/core/provisioning-java/src/main/java/org/apache/syncope/core/provisioning/java/job/notification/AbstractNotificationJobDelegate.java
+++
b/core/provisioning-java/src/main/java/org/apache/syncope/core/provisioning/java/job/notification/AbstractNotificationJobDelegate.java
@@ -102,12 +102,13 @@ public abstract class AbstractNotificationJobDelegate
implements NotificationJob
if (StringUtils.isBlank(task.getSubject()) ||
task.getRecipients().isEmpty()
|| StringUtils.isBlank(task.getHtmlBody()) ||
StringUtils.isBlank(task.getTextBody())) {
- String message = "Could not fetch all required information for
sending e-mails:\n"
- + task.getRecipients() + '\n'
- + task.getSender() + '\n'
- + task.getSubject() + '\n'
- + task.getHtmlBody() + '\n'
- + task.getTextBody();
+ String message = "Could not fetch all required information for
sending out notifications:"
+ + "\nFrom: " + task.getSender()
+ + "\nTo: " + task.getRecipients()
+ + "\nSubject: " + task.getSubject()
+ + "\nHTML body:\n" + task.getHtmlBody()
+ + "\nText body:\n" + task.getTextBody()
+ + "\n";
LOG.error(message);
execution.setStatus(NotificationJob.Status.NOT_SENT.name());
@@ -117,14 +118,8 @@ public abstract class AbstractNotificationJobDelegate
implements NotificationJob
execution.setMessage(message);
}
} else {
- if (LOG.isDebugEnabled()) {
- LOG.debug("About to send notifications:\n"
- + task.getRecipients() + '\n'
- + task.getSender() + '\n'
- + task.getSubject() + '\n'
- + task.getHtmlBody() + '\n'
- + task.getTextBody() + '\n');
- }
+ LOG.debug("About to send notifications:\nFrom: {}\nTo:
{}\nSubject: {}\nHTML body:\n{}\nText body:\n{}\n",
+ task.getSender(), task.getRecipients(), task.getSubject(),
task.getHtmlBody(), task.getTextBody());
setStatus("Sending notifications to " + task.getRecipients());
diff --git
a/core/provisioning-java/src/main/java/org/apache/syncope/core/provisioning/java/notification/DefaultNotificationManager.java
b/core/provisioning-java/src/main/java/org/apache/syncope/core/provisioning/java/notification/DefaultNotificationManager.java
index 1d2b8d52bc..1811273544 100644
---
a/core/provisioning-java/src/main/java/org/apache/syncope/core/provisioning/java/notification/DefaultNotificationManager.java
+++
b/core/provisioning-java/src/main/java/org/apache/syncope/core/provisioning/java/notification/DefaultNotificationManager.java
@@ -183,17 +183,16 @@ public class DefaultNotificationManager implements
NotificationManager {
final Any<?> any,
final Map<String, Object> jexlVars) {
- if (any != null) {
- virAttrHandler.getValues(any);
- }
+ jexlVars.put("syncopeConf",
confParamOps.list(SyncopeConstants.MASTER_DOMAIN));
+ jexlVars.put("events", notification.getEvents());
+
+ Optional.ofNullable(any).ifPresent(virAttrHandler::getValues);
List<User> recipients = new ArrayList<>();
- if (notification.getRecipientsFIQL() != null) {
- recipients.addAll(anySearchDAO.<User>search(
- SearchCondConverter.convert(searchCondVisitor,
notification.getRecipientsFIQL()),
- List.of(), AnyTypeKind.USER));
- }
+ Optional.ofNullable(notification.getRecipientsFIQL()).
+ ifPresent(fiql -> recipients.addAll(anySearchDAO.<User>search(
+ SearchCondConverter.convert(searchCondVisitor, fiql),
List.of(), AnyTypeKind.USER)));
if (notification.isSelfAsRecipient() && any instanceof User) {
recipients.add((User) any);
@@ -204,47 +203,44 @@ public class DefaultNotificationManager implements
NotificationManager {
recipients.forEach(recipient -> {
virAttrHandler.getValues(recipient);
- String email =
getRecipientEmail(notification.getRecipientAttrName(), recipient);
- if (email == null) {
- LOG.warn("{} cannot be notified: {} not found", recipient,
notification.getRecipientAttrName());
- } else {
- recipientEmails.add(email);
- recipientTOs.add(userDataBinder.getUserTO(recipient, true));
- }
+
Optional.ofNullable(getRecipientEmail(notification.getRecipientAttrName(),
recipient)).
+ ifPresentOrElse(
+ email -> {
+ recipientEmails.add(email);
+
recipientTOs.add(userDataBinder.getUserTO(recipient, true));
+ },
+ () -> LOG.warn("{} cannot be notified: {} not
found",
+ recipient,
notification.getRecipientAttrName()));
});
+ jexlVars.put("recipients", recipientTOs);
- if (notification.getStaticRecipients() != null) {
- recipientEmails.addAll(notification.getStaticRecipients());
- }
+
Optional.ofNullable(notification.getStaticRecipients()).ifPresent(recipientEmails::addAll);
- if (notification.getRecipientsProvider() != null) {
+
Optional.ofNullable(notification.getRecipientsProvider()).ifPresent(impl -> {
try {
RecipientsProvider recipientsProvider =
ImplementationManager.build(
- notification.getRecipientsProvider(),
+ impl,
() -> perContextRecipientsProvider.orElse(null),
instance -> perContextRecipientsProvider =
Optional.of(instance));
-
recipientEmails.addAll(recipientsProvider.provideRecipients(notification));
+
recipientEmails.addAll(recipientsProvider.provideRecipients(notification, any,
jexlVars));
} catch (Exception e) {
LOG.error("While building {}",
notification.getRecipientsProvider(), e);
}
- }
+ });
- jexlVars.put("recipients", recipientTOs);
- jexlVars.put("syncopeConf",
confParamOps.list(SyncopeConstants.MASTER_DOMAIN));
- jexlVars.put("events", notification.getEvents());
JexlContext ctx = new MapContext(jexlVars);
NotificationTask task =
entityFactory.newEntity(NotificationTask.class);
task.setNotification(notification);
- if (any != null) {
- task.setEntityKey(any.getKey());
- task.setAnyTypeKind(any.getType().getKind());
- }
+ Optional.ofNullable(any).ifPresent(a -> {
+ task.setEntityKey(a.getKey());
+ task.setAnyTypeKind(a.getType().getKind());
+ });
task.setTraceLevel(notification.getTraceLevel());
task.getRecipients().addAll(recipientEmails);
task.setSender(notification.getSender());
- task.setSubject(notification.getSubject());
+ task.setSubject(JexlUtils.evaluateTemplate(notification.getSubject(),
ctx));
if
(StringUtils.isNotBlank(notification.getTemplate().getTextTemplate())) {
task.setTextBody(JexlUtils.evaluateTemplate(notification.getTemplate().getTextTemplate(),
ctx));
@@ -263,8 +259,9 @@ public class DefaultNotificationManager implements
NotificationManager {
final String subcategory,
final String event) {
- final String successEvent = AuditLoggerName.buildEvent(type, category,
subcategory, event, Result.SUCCESS);
- final String failureEvent = AuditLoggerName.buildEvent(type, category,
subcategory, event, Result.FAILURE);
+ String successEvent = AuditLoggerName.buildEvent(type, category,
subcategory, event, Result.SUCCESS);
+ String failureEvent = AuditLoggerName.buildEvent(type, category,
subcategory, event, Result.FAILURE);
+
return notificationDAO.findAll().stream().
anyMatch(notification -> notification.isActive()
&& (notification.getEvents().contains(successEvent)
@@ -297,8 +294,6 @@ public class DefaultNotificationManager implements
NotificationManager {
final Object output,
final Object... input) {
- String currentEvent = AuditLoggerName.buildEvent(type, category,
subcategory, event, condition);
-
Any<?> any = null;
if (before instanceof UserTO) {
@@ -342,8 +337,10 @@ public class DefaultNotificationManager implements
NotificationManager {
}
if (notification.isActive()) {
+ String currentEvent = AuditLoggerName.buildEvent(type,
category, subcategory, event, condition);
+
if (!notification.getEvents().contains(currentEvent)) {
- LOG.debug("No events found about {}", any);
+ LOG.debug("Notification {} does not match {}",
notification, currentEvent);
} else if (anyType == null || any == null
|| notification.getAbout(anyType).isEmpty()
|| anyMatchDAO.matches(any,
SearchCondConverter.convert(
@@ -351,26 +348,26 @@ public class DefaultNotificationManager implements
NotificationManager {
LOG.debug("Creating notification task for event {} about
{}", currentEvent, any);
- Map<String, Object> model = new HashMap<>();
- model.put("who", who);
- model.put("type", type);
- model.put("category", category);
- model.put("subcategory", subcategory);
- model.put("event", event);
- model.put("condition", condition);
- model.put("before", before);
- model.put("output", output);
- model.put("input", input);
+ Map<String, Object> jexlVars = new HashMap<>();
+ jexlVars.put("who", who);
+ jexlVars.put("type", type);
+ jexlVars.put("category", category);
+ jexlVars.put("subcategory", subcategory);
+ jexlVars.put("event", event);
+ jexlVars.put("condition", condition);
+ jexlVars.put("before", before);
+ jexlVars.put("output", output);
+ jexlVars.put("input", input);
if (any instanceof User) {
- model.put("user", userDataBinder.getUserTO((User) any,
true));
+ jexlVars.put("user", userDataBinder.getUserTO((User)
any, true));
} else if (any instanceof Group) {
- model.put("group", groupDataBinder.getGroupTO((Group)
any, true));
+ jexlVars.put("group",
groupDataBinder.getGroupTO((Group) any, true));
} else if (any instanceof AnyObject) {
- model.put("anyObject",
anyObjectDataBinder.getAnyObjectTO((AnyObject) any, true));
+ jexlVars.put("anyObject",
anyObjectDataBinder.getAnyObjectTO((AnyObject) any, true));
}
- NotificationTask notificationTask =
getNotificationTask(notification, any, model);
+ NotificationTask notificationTask =
getNotificationTask(notification, any, jexlVars);
notificationTask = taskDAO.save(notificationTask);
notifications.add(notificationTask);
}
@@ -395,13 +392,10 @@ public class DefaultNotificationManager implements
NotificationManager {
if ("username".equals(intAttrName.getField())) {
email = user.getUsername();
} else if (intAttrName.getSchemaType() != null) {
- UMembership membership = null;
- if (intAttrName.getMembershipOfGroup() != null) {
- Group group =
groupDAO.findByName(intAttrName.getMembershipOfGroup());
- if (group != null) {
- membership =
user.getMembership(group.getKey()).orElse(null);
- }
- }
+ UMembership membership =
Optional.ofNullable(intAttrName.getMembershipOfGroup()).
+ map(groupDAO::findByName).
+ flatMap(group -> user.getMembership(group.getKey())).
+ orElse(null);
switch (intAttrName.getSchemaType()) {
case PLAIN:
diff --git
a/fit/core-reference/src/main/java/org/apache/syncope/fit/core/reference/TestNotificationRecipientsProvider.java
b/fit/core-reference/src/main/java/org/apache/syncope/fit/core/reference/TestNotificationRecipientsProvider.java
index b45d84d5ef..2b17548133 100644
---
a/fit/core-reference/src/main/java/org/apache/syncope/fit/core/reference/TestNotificationRecipientsProvider.java
+++
b/fit/core-reference/src/main/java/org/apache/syncope/fit/core/reference/TestNotificationRecipientsProvider.java
@@ -18,7 +18,9 @@
*/
package org.apache.syncope.fit.core.reference;
+import java.util.Map;
import java.util.Set;
+import org.apache.syncope.core.persistence.api.entity.Any;
import org.apache.syncope.core.persistence.api.entity.Notification;
import
org.apache.syncope.core.provisioning.api.notification.RecipientsProvider;
import org.springframework.transaction.annotation.Transactional;
@@ -27,7 +29,11 @@ public class TestNotificationRecipientsProvider implements
RecipientsProvider {
@Transactional(readOnly = true)
@Override
- public Set<String> provideRecipients(final Notification notification) {
+ public Set<String> provideRecipients(
+ final Notification notification,
+ final Any<?> any,
+ final Map<String, Object> jexlVars) {
+
return Set.of(getClass().getSimpleName() + "@syncope.apache.org");
}
}
diff --git
a/fit/core-reference/src/test/java/org/apache/syncope/fit/core/NotificationTaskITCase.java
b/fit/core-reference/src/test/java/org/apache/syncope/fit/core/NotificationTaskITCase.java
index 4ec5b72acf..3d48bd6888 100644
---
a/fit/core-reference/src/test/java/org/apache/syncope/fit/core/NotificationTaskITCase.java
+++
b/fit/core-reference/src/test/java/org/apache/syncope/fit/core/NotificationTaskITCase.java
@@ -273,7 +273,7 @@ public class NotificationTaskITCase extends
AbstractNotificationTaskITCase {
assertNotNull(taskTO);
assertNotNull(taskTO.getNotification());
assertTrue(taskTO.getRecipients().containsAll(
- new
TestNotificationRecipientsProvider().provideRecipients(null)));
+ new
TestNotificationRecipientsProvider().provideRecipients(null, null, null)));
execNotificationTask(TASK_SERVICE, taskTO.getKey(), MAX_WAIT_SECONDS);
