Quartz Support for Job Scheduler.

Author: zaxxio

pom.xml

@@ -33,6 +33,10 @@
             <artifactId>postgresql</artifactId>
             <scope>runtime</scope>
         </dependency>
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-quartz</artifactId>
+        </dependency>
         <dependency>
             <groupId>org.hibernate.orm</groupId>
             <artifactId>hibernate-ehcache</artifactId>
@@ -177,9 +181,14 @@
         </dependency>
         <dependency>
             <groupId>org.springframework.boot</groupId>
-            <artifactId>spring-boot-docker-compose</artifactId>
-            <scope>runtime</scope>
+            <artifactId>spring-boot-starter-jdbc</artifactId>
         </dependency>
+
+        <!--        <dependency>-->
+<!--            <groupId>org.springframework.boot</groupId>-->
+<!--            <artifactId>spring-boot-docker-compose</artifactId>-->
+<!--            <scope>runtime</scope>-->
+<!--        </dependency>-->
         <dependency>
             <groupId>org.springframework.boot</groupId>
             <artifactId>spring-boot-starter-data-mongodb</artifactId>

src/main/java/org/wsd/app/bootloader/BootLoader.java

@@ -65,7 +65,7 @@ public void run(String... args) throws Exception {
         person.setAddress(address);
         person.setGender(Gender.MALE);
 
-        personRepository.save(person);
+        // personRepository.save(person);
 
     }
 }

src/main/java/org/wsd/app/config/QuartzConfig.java

@@ -0,0 +1,31 @@
+/*
+ * Copyright (c) of Partha Sutradhar 2024.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included
+ * in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+package org.wsd.app.config;
+
+import org.springframework.context.annotation.Configuration;
+
+@Configuration
+public class QuartzConfig {
+
+
+}

src/main/java/org/wsd/app/controller/AuthenticationController.java

@@ -24,7 +24,7 @@
 @Log
 @RestController
 @RequestMapping("/api/auth")
-@Tag(name = "Authentication")
+@Tag(name = "Authentication Controller")
 @RequiredArgsConstructor
 public class AuthenticationController {
     private final AuthenticationService authenticationService;

src/main/java/org/wsd/app/controller/OrderController.java

@@ -10,7 +10,7 @@
 
 @RestController
 @RequiredArgsConstructor
-@Tag(name = "Order")
+@Tag(name = "Order Controller")
 @SecurityRequirement(name = "BEARER_TOKEN")
 @RequestMapping("/api/orders")
 public class OrderController {

src/main/java/org/wsd/app/controller/SchedulerController.java

@@ -0,0 +1,55 @@
+/*
+ * Copyright (c) of Partha Sutradhar 2024.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included
+ * in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+package org.wsd.app.controller;
+
+import io.swagger.v3.oas.annotations.security.SecurityRequirement;
+import io.swagger.v3.oas.annotations.tags.Tag;
+import lombok.RequiredArgsConstructor;
+import org.springframework.web.bind.annotation.PathVariable;
+import org.springframework.web.bind.annotation.PostMapping;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RestController;
+import org.wsd.app.quartz.ExecutionTimer;
+import org.wsd.app.quartz.SchedulerService;
+import org.wsd.app.quartz.TaskRunner;
+
+@RestController
+@Tag(name = "Scheduler Controller")
+@RequiredArgsConstructor
+@SecurityRequirement(name = "BEARER_TOKEN")
+@RequestMapping("/api/schedulers")
+public class SchedulerController {
+    private final SchedulerService schedulerService;
+    @PostMapping("/{id}")
+    public void execute(@PathVariable("id") int id) {
+        ExecutionTimer executionTimer = new ExecutionTimer();
+        executionTimer.setId(id);
+        executionTimer.setMaxExecution(5);
+        executionTimer.setRepeatedInterval(5000);
+//        executionTimer.setCronExpression("0/5 * * * * ? *");
+        executionTimer.setRunForever(false);
+        executionTimer.setInitialDelay(5000);
+        executionTimer.setData("Execution Completed!!");
+        schedulerService.schedule(TaskRunner.class, executionTimer);
+    }
+}

src/main/java/org/wsd/app/controller/TwoFactorAuthController.java

@@ -16,10 +16,11 @@
 @RestController
 @RequestMapping("/api/auth")
 @RequiredArgsConstructor
-@Tag(name = "Two Factor Authentication")
+@Tag(name = "Two Factor Authentication Controller")
 @SecurityRequirement(name = "BEARER_TOKEN")
 public class TwoFactorAuthController {
     private final TwoFactorService twoFactorService;
+
     @Operation(description = "Two Factor Authentication", summary = "Endpoint for two factor authentication service enable and disable.")
     @GetMapping("/2Fa/configure")
     public Payload<TwoFactorResponse> twoFactorSetup(TwoFactorRequest request) {

src/main/java/org/wsd/app/quartz/ExecutionTimer.java

@@ -0,0 +1,41 @@
+/*
+ * Copyright (c) of Partha Sutradhar 2024.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included
+ * in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+package org.wsd.app.quartz;
+
+import lombok.Data;
+import lombok.ToString;
+
+import java.io.Serializable;
+
+@ToString
+@Data
+public class ExecutionTimer implements Serializable {
+    private int id;
+    private int maxExecution;
+    private int remainingExecution;
+    private long repeatedInterval;
+    private boolean runForever;
+    private long initialDelay;
+    private String cronExpression;
+    private String data;
+}

src/main/java/org/wsd/app/quartz/ScheduleTask.java

@@ -0,0 +1,46 @@
+/*
+ * Copyright (c) of Partha Sutradhar 2024.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included
+ * in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+package org.wsd.app.quartz;
+
+
+import jakarta.persistence.*;
+import lombok.Data;
+import org.hibernate.annotations.Generated;
+
+@Entity
+@Data
+@Table(name = "schedule_task")
+public class ScheduleTask {
+    @Id
+    @GeneratedValue(strategy = GenerationType.AUTO)
+    private Long id;
+    private String jobTask;
+    private String jobGroup;
+    private String jobStatus;
+    private String jobClass;
+    private String cronExpression;
+    private String description;
+    private String interfaceName;
+    private Long repeatTime;
+    private Boolean cronJob;
+}

src/main/java/org/wsd/app/quartz/SchedulerJobFactory.java

@@ -0,0 +1,46 @@
+/*
+ * Copyright (c) of Partha Sutradhar 2024.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included
+ * in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+package org.wsd.app.quartz;
+
+import org.quartz.spi.TriggerFiredBundle;
+import org.springframework.beans.factory.config.AutowireCapableBeanFactory;
+import org.springframework.context.ApplicationContext;
+import org.springframework.context.ApplicationContextAware;
+import org.springframework.scheduling.quartz.SpringBeanJobFactory;
+
+public class SchedulerJobFactory extends SpringBeanJobFactory implements ApplicationContextAware {
+
+    private AutowireCapableBeanFactory beanFactory;
+
+    @Override
+    public void setApplicationContext(final ApplicationContext context) {
+        beanFactory = context.getAutowireCapableBeanFactory();
+    }
+
+    @Override
+    protected Object createJobInstance(final TriggerFiredBundle bundle) throws Exception {
+        final Object job = super.createJobInstance(bundle);
+        beanFactory.autowireBean(job);
+        return job;
+    }
+}