Adding some spring examples

Author: kagkarlsson

db-scheduler-boot-starter/src/main/java/com/github/kagkarlsson/scheduler/boot/autoconfigure/DbSchedulerAutoConfiguration.java

@@ -22,6 +22,8 @@
 import com.github.kagkarlsson.scheduler.boot.config.DbSchedulerStarter;
 import com.github.kagkarlsson.scheduler.boot.config.startup.ContextReadyStart;
 import com.github.kagkarlsson.scheduler.boot.config.startup.ImmediateStart;
+import com.github.kagkarlsson.scheduler.event.ExecutionInterceptor;
+import com.github.kagkarlsson.scheduler.event.SchedulerListener;
 import com.github.kagkarlsson.scheduler.exceptions.SerializationException;
 import com.github.kagkarlsson.scheduler.serializer.Serializer;
 import com.github.kagkarlsson.scheduler.stats.StatsRegistry;
@@ -68,18 +70,24 @@ public class DbSchedulerAutoConfiguration {
   private final DbSchedulerProperties config;
   private final DataSource existingDataSource;
   private final List<Task<?>> configuredTasks;
+  private final List<SchedulerListener> schedulerListeners;
+  private final List<ExecutionInterceptor> executionInterceptors;
 
   public DbSchedulerAutoConfiguration(
       DbSchedulerProperties dbSchedulerProperties,
       DataSource dataSource,
-      List<Task<?>> configuredTasks) {
+      List<Task<?>> configuredTasks,
+      List<SchedulerListener> schedulerListeners,
+      List<ExecutionInterceptor> executionInterceptors) {
     this.config =
         Objects.requireNonNull(
             dbSchedulerProperties, "Can't configure db-scheduler without required configuration");
     this.existingDataSource =
         Objects.requireNonNull(dataSource, "An existing javax.sql.DataSource is required");
     this.configuredTasks =
         Objects.requireNonNull(configuredTasks, "At least one Task must be configured");
+    this.schedulerListeners = schedulerListeners;
+    this.executionInterceptors = executionInterceptors;
   }
 
   /** Provide an empty customizer if not present in the context. */
@@ -179,6 +187,12 @@ public Scheduler scheduler(DbSchedulerCustomizer customizer, StatsRegistry regis
     // Shutdown max wait
     builder.shutdownMaxWait(config.getShutdownMaxWait());
 
+    // Register listeners
+    schedulerListeners.forEach(builder::addSchedulerListener);
+
+    // Register interceptors
+    executionInterceptors.forEach(builder::addExecutionInterceptor);
+
     return builder.build();
   }
 

examples/spring-boot-example/src/main/java/com/github/kagkarlsson/examples/boot/config/SchedulerConfiguration.java

@@ -15,15 +15,26 @@
 
 import com.github.kagkarlsson.scheduler.SchedulerName;
 import com.github.kagkarlsson.scheduler.boot.config.DbSchedulerCustomizer;
+import com.github.kagkarlsson.scheduler.event.AbstractSchedulerListener;
+import com.github.kagkarlsson.scheduler.event.ExecutionInterceptor;
+import com.github.kagkarlsson.scheduler.event.SchedulerListener;
 import com.github.kagkarlsson.scheduler.serializer.JacksonSerializer;
 import com.github.kagkarlsson.scheduler.serializer.Serializer;
+import com.github.kagkarlsson.scheduler.task.ExecutionComplete;
 import java.util.Optional;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.slf4j.MDC;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 
 @Configuration
 public class SchedulerConfiguration {
 
+  public static final String MDC_TASKNAME = "task-name";
+  public static final String MDC_TASKINSTANCEID = "task-instance-id";
+  private static final Logger LOG = LoggerFactory.getLogger(SchedulerConfiguration.class);
+
   /** Bean defined when a configuration-property in DbSchedulerCustomizer needs to be overridden. */
   @Bean
   DbSchedulerCustomizer customizer() {
@@ -39,4 +50,33 @@ public Optional<Serializer> serializer() {
       }
     };
   }
+
+  @Bean
+  SchedulerListener schedulerListener() {
+    return new AbstractSchedulerListener() {
+
+      @Override
+      public void onExecutionComplete(ExecutionComplete executionComplete) {
+        LOG.info(
+            "SchedulerListener.onExecutionComplete. Result={}, took={}ms ",
+            executionComplete.getResult(),
+            executionComplete.getDuration().toMillis());
+      }
+    };
+  }
+
+  @Bean
+  ExecutionInterceptor mdcExecutionInterceptor() {
+    return (taskInstance, executionContext, chain) -> {
+      LOG.info("Setting MDC before execution");
+      MDC.put(MDC_TASKNAME, taskInstance.getTaskName());
+      MDC.put(MDC_TASKINSTANCEID, taskInstance.getId());
+      try {
+        return chain.proceed(taskInstance, executionContext);
+      } finally {
+        MDC.remove(MDC_TASKNAME);
+        MDC.remove(MDC_TASKINSTANCEID);
+      }
+    };
+  }
 }

examples/spring-boot-example/src/main/resources/logback.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<configuration>
+  <include resource="org/springframework/boot/logging/logback/defaults.xml"/>
+  <include resource="org/springframework/boot/logging/logback/console-appender.xml" />
+  <root level="INFO">
+    <appender-ref ref="CONSOLE" />
+  </root>
+</configuration>