Merge pull request #33 from Jahia/BACKLOG-22429-event-listeners

BACKLOG-22429 JahiaEventListener interface improvements

jahia-event-listener/src/main/java/org/foo/modules/listener/CustomEventProducer.java

@@ -0,0 +1,77 @@
+package org.foo.modules.listener;
+
+import org.jahia.params.valves.BaseLoginEvent;
+import org.jahia.services.observation.JahiaEventService;
+import org.jahia.services.usermanager.JahiaUser;
+import org.jahia.services.usermanager.JahiaUserImpl;
+import org.osgi.framework.BundleContext;
+import org.osgi.service.component.annotations.Activate;
+import org.osgi.service.component.annotations.Component;
+import org.osgi.service.component.annotations.Deactivate;
+import org.osgi.service.component.annotations.Reference;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import java.util.Properties;
+import java.util.concurrent.Executors;
+import java.util.concurrent.ScheduledExecutorService;
+import java.util.concurrent.TimeUnit;
+import java.util.concurrent.atomic.AtomicBoolean;
+
+/**
+ * A custom event producer class that defines a new custom login event types and produces instances of it every
+ * 10 seconds. This serves as an example on how to create custom event types and how to inject them into the
+ * event service as well.
+ */
+@Component(immediate=true)
+public class CustomEventProducer {
+
+    private final static Logger logger = LoggerFactory.getLogger(TestEventListener.class);
+
+    private JahiaEventService jahiaEventService;
+    private AtomicBoolean active = new AtomicBoolean(false);
+
+    private ScheduledExecutorService executor;
+
+    @Reference
+    public void setJahiaEventService(JahiaEventService jahiaEventService) {
+        this.jahiaEventService = jahiaEventService;
+    }
+
+    public void produceEvents() {
+        try {
+            while (active.get()) {
+                jahiaEventService.publishEvent(new CustomLoginEvent(this, new JahiaUserImpl("testUser", "/users/testUser", new Properties(), "customRealm")));
+                Thread.sleep(10000); // 10 seconds
+            }
+        } catch (InterruptedException e) {
+            throw new RuntimeException(e);
+        }
+    }
+
+    @Activate
+    public void activate(BundleContext context) {
+        logger.info("Starting custom event producer...");
+        executor = Executors.newSingleThreadScheduledExecutor();
+        active.set(true);
+
+        Runnable task = this::produceEvents;
+
+        executor.scheduleAtFixedRate(task, 0, 2, TimeUnit.SECONDS);
+    }
+
+    @Deactivate
+    public void deactivate() {
+        logger.info("Shutting down custom event producer...");
+        active.set(false);
+        executor.shutdown();
+        executor = null;
+    }
+
+    private class CustomLoginEvent extends BaseLoginEvent {
+        public CustomLoginEvent(Object source, JahiaUser jahiaUser) {
+            super(source, jahiaUser, null);
+        }
+    }
+
+}

jahia-event-listener/src/main/java/org/foo/modules/listener/TestEventListener.java

@@ -12,8 +12,17 @@
 public class TestEventListener implements JahiaEventListener<BaseLoginEvent> {
     private final static Logger logger = LoggerFactory.getLogger(TestEventListener.class);
 
+    private static final Class<BaseLoginEvent>[] ALLOWED_EVENT_TYPES = new Class[]{BaseLoginEvent.class};
+
     @Override
     public void onEvent(EventObject event) {
-        logger.info("Received event : "+event);
+        // We can perform this cast because we said we only wanted to receive BaseLoginEvent and subclasses of it
+        BaseLoginEvent baseLoginEvent = (BaseLoginEvent) event;
+        logger.info("Received login event : class={} user={}", event.getClass().getName(), baseLoginEvent.getJahiaUser().getUserKey());
+    }
+
+    @Override
+    public Class<BaseLoginEvent>[] getEventTypes() {
+        return ALLOWED_EVENT_TYPES;
     }
 }