Make all Notifier extend AbstractEventNotifier

Since the Notifiers shouldn't throw exceptions, we let all extend the AbstractEventNotifier which gets us a enabled property and catching exceptions which may occur when notifiying.

Author: joshiste

spring-boot-admin-server/src/main/java/de/codecentric/boot/admin/notify/AbstractEventNotifier.java

@@ -44,7 +44,9 @@ public void notify(ClientApplicationEvent event) {
 }
 
 
-protected abstract boolean shouldNotify(ClientApplicationEvent event);
+protected boolean shouldNotify(ClientApplicationEvent event) {
+return true;
+}
 
 protected abstract void doNotify(ClientApplicationEvent event) throws Exception;
 

spring-boot-admin-server/src/main/java/de/codecentric/boot/admin/notify/CompositeNotifier.java

@@ -15,23 +15,26 @@
  */
 package de.codecentric.boot.admin.notify;
 
+import org.springframework.util.Assert;
+
 import de.codecentric.boot.admin.event.ClientApplicationEvent;
 
 /**
  * A notifier delegating notifications to all specified notifiers.
  *
  * @author Sebastian Meiser
  */
-public class CompositeNotifier implements Notifier {
-private final Iterable<Notifier> notifiers;
+public class CompositeNotifier extends AbstractEventNotifier {
+private final Iterable<Notifier> delegates;
 
-public CompositeNotifier(Iterable<Notifier> notifiers) {
-this.notifiers = notifiers;
+public CompositeNotifier(Iterable<Notifier> delegates) {
+Assert.notNull(delegates, "'delegates' must not be null!");
+this.delegates = delegates;
 }
 
 @Override
-public void notify(ClientApplicationEvent event) {
-for (Notifier notifier : notifiers) {
+public void doNotify(ClientApplicationEvent event) {
+for (Notifier notifier : delegates) {
 notifier.notify(event);
 }
 }

spring-boot-admin-server/src/main/java/de/codecentric/boot/admin/notify/RemindingNotifier.java

@@ -20,6 +20,8 @@
 import java.util.concurrent.ConcurrentHashMap;
 import java.util.concurrent.TimeUnit;
 
+import org.springframework.util.Assert;
+
 import de.codecentric.boot.admin.event.ClientApplicationDeregisteredEvent;
 import de.codecentric.boot.admin.event.ClientApplicationEvent;
 import de.codecentric.boot.admin.event.ClientApplicationStatusChangedEvent;
@@ -29,18 +31,19 @@
  *
  * @author Johannes Edmeier
  */
-public class RemindingNotifier implements Notifier {
+public class RemindingNotifier extends AbstractEventNotifier {
 private final ConcurrentHashMap<String, Reminder> reminders = new ConcurrentHashMap<>();
 private long reminderPeriod = TimeUnit.MINUTES.toMillis(10L);
 private String[] reminderStatuses = { "DOWN", "OFFLINE" };
 private final Notifier delegate;
 
 public RemindingNotifier(Notifier delegate) {
+Assert.notNull(delegate, "'delegate' must not be null!");
 this.delegate = delegate;
 }
 
 @Override
-public void notify(ClientApplicationEvent event) {
+public void doNotify(ClientApplicationEvent event) {
 delegate.notify(event);
 if (shouldEndReminder(event)) {
 reminders.remove(event.getApplication().getId());

spring-boot-admin-server/src/main/java/de/codecentric/boot/admin/notify/filter/FilteringNotifier.java

@@ -25,16 +25,18 @@
 
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
+import org.springframework.util.Assert;
 
 import de.codecentric.boot.admin.event.ClientApplicationEvent;
+import de.codecentric.boot.admin.notify.AbstractEventNotifier;
 import de.codecentric.boot.admin.notify.Notifier;
 
 /**
  * Notifier that allows to filter certain events based on policies.
  *
  * @author Johannes Edmeier
  */
-public class FilteringNotifier implements Notifier {
+public class FilteringNotifier extends AbstractEventNotifier {
 private static final Logger LOGGER = LoggerFactory.getLogger(FilteringNotifier.class);
 private final ConcurrentMap<String, NotificationFilter> filters = new ConcurrentHashMap<>();
 private final Notifier delegate;
@@ -43,11 +45,17 @@ public class FilteringNotifier implements Notifier {
 private AtomicLong counter = new AtomicLong();
 
 public FilteringNotifier(Notifier delegate) {
+Assert.notNull(delegate, "'delegate' must not be null!");
 this.delegate = delegate;
 }
 
 @Override
-public void notify(ClientApplicationEvent event) {
+protected boolean shouldNotify(ClientApplicationEvent event) {
+return !filter(event);
+}
+
+@Override
+public void doNotify(ClientApplicationEvent event) {
 if (!filter(event)) {
 delegate.notify(event);
 }

spring-boot-admin-server/src/test/java/de/codecentric/boot/admin/notify/CompositeNotifierTest.java

@@ -4,6 +4,7 @@
 import static org.junit.Assert.assertThat;
 
 import java.util.Arrays;
+import java.util.Collections;
 
 import org.junit.Test;
 
@@ -19,6 +20,10 @@ public class CompositeNotifierTest {
 .withStatusInfo(StatusInfo.ofDown()).build(),
 StatusInfo.ofUp(), StatusInfo.ofDown());
 
+@Test(expected = IllegalArgumentException.class)
+public void test_ctor_assert() {
+new CompositeNotifier(null);
+}
 
 @Test
 public void test_all_notifiers_get_notified() throws Exception {
@@ -28,7 +33,7 @@ public void test_all_notifiers_get_notified() throws Exception {
 
 compositeNotifier.notify(APP_DOWN);
 
-assertThat(notifier1.getEvents(), is(Arrays.asList(APP_DOWN)));
-assertThat(notifier2.getEvents(), is(Arrays.asList(APP_DOWN)));
+assertThat(notifier1.getEvents(), is(Collections.singletonList(APP_DOWN)));
+assertThat(notifier2.getEvents(), is(Collections.singletonList(APP_DOWN)));
 }
 }

spring-boot-admin-server/src/test/java/de/codecentric/boot/admin/notify/RemindingNotifierTest.java

@@ -4,6 +4,7 @@
 import static org.junit.Assert.assertThat;
 
 import java.util.Arrays;
+import java.util.Collections;
 
 import org.junit.Test;
 
@@ -29,6 +30,11 @@ public class RemindingNotifierTest {
 .withStatusInfo(StatusInfo.ofUp()).build(),
 StatusInfo.ofDown(), StatusInfo.ofUp());
 
+@Test(expected = IllegalArgumentException.class)
+public void test_ctor_assert() {
+new CompositeNotifier(null);
+}
+
 @Test
 public void test_remind() throws Exception {
 TestNotifier notifier = new TestNotifier();
@@ -67,7 +73,7 @@ public void test_no_remind_before_end() throws Exception {
 reminder.notify(APP_DOWN);
 reminder.sendReminders();
 
-assertThat(notifier.getEvents(), is(Arrays.asList(APP_DOWN)));
+assertThat(notifier.getEvents(), is(Collections.singletonList(APP_DOWN)));
 }
 
 }

spring-boot-admin-server/src/test/java/de/codecentric/boot/admin/notify/filter/FilteringNotifierTest.java

@@ -1,9 +1,9 @@
 package de.codecentric.boot.admin.notify.filter;
 
+import static org.junit.Assert.assertThat;
 import static org.hamcrest.Matchers.hasItem;
 import static org.hamcrest.Matchers.hasKey;
 import static org.hamcrest.Matchers.not;
-import static org.junit.Assert.assertThat;
 
 import org.junit.Test;
 
@@ -17,6 +17,11 @@ public class FilteringNotifierTest {
 private static final ClientApplicationRegisteredEvent EVENT = new ClientApplicationRegisteredEvent(
 Application.create("foo").withHealthUrl("http://health").build());
 
+@Test(expected = IllegalArgumentException.class)
+public void test_ctor_assert() {
+new FilteringNotifier(null);
+}
+
 @Test
 public void test_expired_removal() {
 FilteringNotifier notifier = new FilteringNotifier(new TestNotifier());