diff --git a/spring-boot-admin-docs/src/site/docs/02-server/notifications/90-custom-notifiers.md b/spring-boot-admin-docs/src/site/docs/02-server/notifications/90-custom-notifiers.md index 21c84c58e78..974b44496c9 100644 --- a/spring-boot-admin-docs/src/site/docs/02-server/notifications/90-custom-notifiers.md +++ b/spring-boot-admin-docs/src/site/docs/02-server/notifications/90-custom-notifiers.md @@ -357,7 +357,7 @@ public class NotifierConfig { RemindingNotifier notifier = new RemindingNotifier( filteringNotifier, repository); notifier.setReminderPeriod(Duration.ofMinutes(10)); - notifier.setCheckReminderInverval(Duration.ofSeconds(10)); + notifier.setCheckReminderInterval(Duration.ofSeconds(10)); return notifier; } diff --git a/spring-boot-admin-docs/src/site/docs/02-server/notifications/index.mdx b/spring-boot-admin-docs/src/site/docs/02-server/notifications/index.mdx index 00696495a1c..d95aebe3083 100644 --- a/spring-boot-admin-docs/src/site/docs/02-server/notifications/index.mdx +++ b/spring-boot-admin-docs/src/site/docs/02-server/notifications/index.mdx @@ -69,7 +69,7 @@ public class NotifierConfiguration { public RemindingNotifier remindingNotifier() { RemindingNotifier notifier = new RemindingNotifier(notifier, repository); notifier.setReminderPeriod(Duration.ofMinutes(10)); // (1) - notifier.setCheckReminderInverval(Duration.ofSeconds(10)); //(2) + notifier.setCheckReminderInterval(Duration.ofSeconds(10)); //(2) return notifier; } } @@ -123,7 +123,7 @@ public class NotifierConfig { public RemindingNotifier remindingNotifier() { // (2) RemindingNotifier notifier = new RemindingNotifier(filteringNotifier(), this.repository); notifier.setReminderPeriod(Duration.ofMinutes(10)); - notifier.setCheckReminderInverval(Duration.ofSeconds(10)); + notifier.setCheckReminderInterval(Duration.ofSeconds(10)); return notifier; } diff --git a/spring-boot-admin-docs/src/site/docs/09-samples/10-sample-servlet.md b/spring-boot-admin-docs/src/site/docs/09-samples/10-sample-servlet.md index cb31e4707bb..e2d0ea4f849 100644 --- a/spring-boot-admin-docs/src/site/docs/09-samples/10-sample-servlet.md +++ b/spring-boot-admin-docs/src/site/docs/09-samples/10-sample-servlet.md @@ -362,7 +362,7 @@ public class NotifierConfig { filteringNotifier(), repository ); notifier.setReminderPeriod(Duration.ofMinutes(10)); - notifier.setCheckReminderInverval(Duration.ofSeconds(10)); + notifier.setCheckReminderInterval(Duration.ofSeconds(10)); return notifier; } } diff --git a/spring-boot-admin-docs/src/site/docs/10-reference/10-event-types.md b/spring-boot-admin-docs/src/site/docs/10-reference/10-event-types.md index 53877804fe7..c77ff2cd765 100644 --- a/spring-boot-admin-docs/src/site/docs/10-reference/10-event-types.md +++ b/spring-boot-admin-docs/src/site/docs/10-reference/10-event-types.md @@ -593,7 +593,7 @@ public RemindingNotifier remindingNotifier(Notifier delegate, InstanceRepository repository) { RemindingNotifier notifier = new RemindingNotifier(delegate, repository); notifier.setReminderPeriod(Duration.ofMinutes(10)); - notifier.setCheckReminderInverval(Duration.ofSeconds(60)); + notifier.setCheckReminderInterval(Duration.ofSeconds(60)); return notifier; } ``` diff --git a/spring-boot-admin-samples/spring-boot-admin-sample-servlet/src/main/java/de/codecentric/boot/admin/sample/NotifierConfig.java b/spring-boot-admin-samples/spring-boot-admin-sample-servlet/src/main/java/de/codecentric/boot/admin/sample/NotifierConfig.java index ea8e9be7cae..cfc2a52a100 100644 --- a/spring-boot-admin-samples/spring-boot-admin-sample-servlet/src/main/java/de/codecentric/boot/admin/sample/NotifierConfig.java +++ b/spring-boot-admin-samples/spring-boot-admin-sample-servlet/src/main/java/de/codecentric/boot/admin/sample/NotifierConfig.java @@ -55,7 +55,7 @@ public FilteringNotifier filteringNotifier() { // <1> public RemindingNotifier remindingNotifier() { // <2> RemindingNotifier notifier = new RemindingNotifier(filteringNotifier(), this.repository); notifier.setReminderPeriod(Duration.ofMinutes(10)); - notifier.setCheckReminderInverval(Duration.ofSeconds(10)); + notifier.setCheckReminderInterval(Duration.ofSeconds(10)); return notifier; } diff --git a/spring-boot-admin-server/src/main/java/de/codecentric/boot/admin/server/notify/RemindingNotifier.java b/spring-boot-admin-server/src/main/java/de/codecentric/boot/admin/server/notify/RemindingNotifier.java index 6dde021d48a..e2e32c474b8 100644 --- a/spring-boot-admin-server/src/main/java/de/codecentric/boot/admin/server/notify/RemindingNotifier.java +++ b/spring-boot-admin-server/src/main/java/de/codecentric/boot/admin/server/notify/RemindingNotifier.java @@ -53,7 +53,7 @@ public class RemindingNotifier extends AbstractEventNotifier { private final Notifier delegate; - private Duration checkReminderInverval = Duration.ofSeconds(10); + private Duration checkReminderInterval = Duration.ofSeconds(10); private Duration reminderPeriod = Duration.ofMinutes(10); @@ -83,7 +83,7 @@ else if (shouldStartReminder(event)) { public void start() { this.reminderScheduler = Schedulers.newSingle("reminders"); - this.subscription = Flux.interval(this.checkReminderInverval, this.reminderScheduler) + this.subscription = Flux.interval(this.checkReminderInterval, this.reminderScheduler) .log(log.getName(), Level.FINEST) .doOnSubscribe((s) -> log.debug("Started reminders")) .flatMap((i) -> this.sendReminders()) @@ -141,8 +141,22 @@ public void setReminderStatuses(String[] reminderStatuses) { this.reminderStatuses = copy; } - public void setCheckReminderInverval(Duration checkReminderInverval) { - this.checkReminderInverval = checkReminderInverval; + /** + * Set the interval used to check for reminders. + * @param checkReminderInterval the interval used to check for reminders + */ + public void setCheckReminderInterval(Duration checkReminderInterval) { + this.checkReminderInterval = checkReminderInterval; + } + + /** + * Set the interval used to check for reminders. + * @param checkReminderInterval the interval used to check for reminders + * @deprecated use {@link #setCheckReminderInterval(Duration)} instead. + */ + @Deprecated + public void setCheckReminderInverval(Duration checkReminderInterval) { + setCheckReminderInterval(checkReminderInterval); } protected static final class Reminder { diff --git a/spring-boot-admin-server/src/test/java/de/codecentric/boot/admin/server/notify/RemindingNotifierTest.java b/spring-boot-admin-server/src/test/java/de/codecentric/boot/admin/server/notify/RemindingNotifierTest.java index f53f79dfefc..9ea306d66a1 100644 --- a/spring-boot-admin-server/src/test/java/de/codecentric/boot/admin/server/notify/RemindingNotifierTest.java +++ b/spring-boot-admin-server/src/test/java/de/codecentric/boot/admin/server/notify/RemindingNotifierTest.java @@ -159,7 +159,7 @@ void should_resubscribe_after_error() { RemindingNotifier reminder = new RemindingNotifier(notifier, this.repository); eventPublisher.flux().flatMap(reminder::notify).subscribe(); - reminder.setCheckReminderInverval(Duration.ofMillis(10)); + reminder.setCheckReminderInterval(Duration.ofMillis(10)); reminder.setReminderPeriod(Duration.ofMillis(10)); reminder.start(); }); @@ -175,4 +175,31 @@ void should_resubscribe_after_error() { .verify(); } + @SuppressWarnings("deprecation") + @Test + void should_support_deprecated_check_reminder_inverval_setter() { + TestPublisher eventPublisher = TestPublisher.create(); + + Flux emittedNotifications = Flux.create((emitter) -> { + Notifier notifier = (event) -> { + emitter.next(event); + return Mono.empty(); + }; + + RemindingNotifier reminder = new RemindingNotifier(notifier, this.repository); + eventPublisher.flux().flatMap(reminder::notify).subscribe(); + + reminder.setCheckReminderInverval(Duration.ofMillis(10)); + reminder.setReminderPeriod(Duration.ofMillis(10)); + reminder.start(); + }); + + StepVerifier.create(emittedNotifications) + .expectSubscription() + .then(() -> eventPublisher.next(appDown)) + .expectNext(appDown, appDown) + .thenCancel() + .verify(); + } + }