Merge pull request #8 from chrisgleissner/feature/decoupled-core-and-quartz

Decoupled core and quartz

Author: chrisgleissner

.travis.yml

@@ -1,11 +1,9 @@
 language: java
-
+install: true
 cache:
   directories:
   - $HOME/.m2
-
 jdk:
 - openjdk11
-
 script:
 - mvn clean install -Pjacoco coveralls:report

Procfile

@@ -1 +1 @@
-web: java -Dserver.port=$PORT $JAVA_OPTS -jar example/target/*.jar
+web: java -Dserver.port=$PORT $JAVA_OPTS -jar example/quartz-api/target/*.jar

README.md

@@ -1,6 +1,6 @@
 # spring-batch-rest
 
-[![Maven Central](https://img.shields.io/maven-metadata/v/http/central.maven.org/maven2/com/github/chrisgleissner/spring-batch-rest-api/maven-metadata.xml.svg)](https://search.maven.org/artifact/com.github.chrisgleissner/spring-batch-rest-api)
+[![Maven Central](https://img.shields.io/maven-central/v/com.github.chrisgleissner/spring-batch-rest-api)](https://maven-badges.herokuapp.com/maven-central/com/github/chrisgleissner/spring-batch-rest-api)
 [![Javadocs](https://www.javadoc.io/badge/com.github.chrisgleissner/spring-batch-rest-api.svg)](https://www.javadoc.io/doc/com.github.chrisgleissner/spring-batch-rest-api)
 [![Build Status](https://travis-ci.org/chrisgleissner/spring-batch-rest.svg?branch=master)](https://travis-ci.org/chrisgleissner/spring-batch-rest)
 [![Coverage Status](https://coveralls.io/repos/github/chrisgleissner/spring-batch-rest/badge.svg?branch=master)](https://coveralls.io/github/chrisgleissner/spring-batch-rest?branch=master)
@@ -55,37 +55,70 @@ Here's how to run a <a href="https://github.com/chrisgleissner/spring-batch-rest
 
 ## Getting Started
 
-To integrate the REST API in your Spring Boot project, first add a dependency for Maven:
+To integrate the REST API in your Spring Boot project, first ensure you have an entry point to your application such as
+ 
+```java
+@SpringBootApplication
+public class SpringBootApp {
+    public static void main(String[] args) {
+        SpringApplication.run(SpringBootApp.class, args);
+    }
+}
+``` 
+ 
+Then, simply add one of the following two dependencies to your project:
 
+### Core API
+
+The `spring-batch-rest-api` dependency comes with `jobs` and `jobExecutions` REST endpoints. It is recommended if you
+don't require Quartz for scheduling your jobs.
+
+Maven:
 ```xml
 <dependency>
     <groupId>com.github.chrisgleissner</groupId>
     <artifactId>spring-batch-rest-api</artifactId>
-    <version>1.3.0</version>
+    <version>VERSION</version>
 </dependency>
 ```
 
-or Gradle:
+Gradle:
 ```
-implementation 'com.github.chrisgleissner:spring-batch-rest-api:1.3.0'
+implementation 'com.github.chrisgleissner:spring-batch-rest-api:VERSION'
 ```
 
-Then add `@EnableSpringBatchRest` to your Spring Boot application class, for <a href="https://github.com/chrisgleissner/spring-batch-rest/blob/master/example/src/main/java/com/github/chrisgleissner/springbatchrest/example/SpringBatchRestSampleApplication.java">example</a>:
-```java
-@SpringBootApplication
-@EnableSpringBatchRest
-public class SpringBatchRestSampleApplication {
-    public static void main(String[] args) {
-        SpringApplication.run(SpringBatchRestSampleApplication.class, args);
-    }
-}
+### Quartz API
+
+The `spring-batch-rest-quartz-api` dependency includes everything above and and additionally exposes Quartz schedules 
+via the `jobDetails` REST endpoint.
+
+Maven:
+```xml
+<dependency>
+    <groupId>com.github.chrisgleissner</groupId>
+    <artifactId>spring-batch-rest-quartz-api</artifactId>
+    <version>VERSION</version>
+</dependency>
+```
+
+Gradle:
+```
+implementation 'com.github.chrisgleissner:spring-batch-rest-quartz-api:VERSION'
+```
+
+### See it in Action
+
+To see `spring-batch-rest-api` in action, run
+```text
+mvn install -Dmaven.test.skip; java -jar example/api/target/*.jar
 ```
 
-To see this example in action, run
+For `spring-batch-rest-quartz-api`, run
 ```text
-mvn install -Dmaven.test.skip; java -jar example/target/*.jar
+mvn install -Dmaven.test.skip; java -jar example/quartz-api/target/*.jar
 ```
-and then check the Swagger REST API docs at 
+ 
+Once it's up, check the Swagger REST API docs at 
 <a href="http://localhost:8080/swagger-ui.html">http://localhost:8080/swagger-ui.html</a>.
 
 
@@ -126,6 +159,8 @@ The following REST endpoints are available:
 
 ### Quartz Schedules
 
+As mentioned above, these endpoints are only exposed if you're using the `spring-batch-rest-api-quartz` dependency:
+
 | HTTP Method  | Path                   | Description  |
 |--------------|------------------------|--------------|
 | GET          | /jobDetails            | All Quartz schedules   |
@@ -170,7 +205,23 @@ The cache only contains job executions since the Spring context creation, ie. it
 
 Spring Batch prevents repeated invocations of a job unless you use different properties (aka job parameters) each time. To bypass this, a unique property (ie. a random UUID) is added to each job invocation. You can disable this by setting the property to false. 
 
+### Disable Spring Batch REST API REST Endpoints
+
+`com.github.chrisgleissner.springbatchrest.enabled=false` (default: true)
+
+Useful if you only want to expose the REST API in certain environments.
+
+### Disable Swagger UI 
+
+`springdoc.swagger-ui.enabled=false` (default: true)
+
+See https://github.com/springdoc/springdoc-openapi for further config options.
+
+### Disable Custom Exception Handling 
+
+`com.github.chrisgleissner.springbatchrest.controllerAdvice=false` (default: true)
 
+This disables the global exception handling via `com.github.chrisgleissner.springbatchrest.api.core.jobexecution.ResponseExceptionHandler`. 
 
 ## Job Property Overrides
 
@@ -202,21 +253,21 @@ If a property is not overridden, it is resolved against the Spring environment.
 
 The <a href="https://github.com/chrisgleissner/spring-batch-rest/tree/master/util/src/main/java/com/github/chrisgleissner/springbatchrest/util">util module</a> contains code for registering, starting and scheduling jobs:
 
-[JobBuilder](https://github.com/chrisgleissner/spring-batch-rest/blob/master/util/src/main/java/com/github/chrisgleissner/springbatchrest/util/adhoc/JobBuilder.java) builds a simple job based on a <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Runnable.html">Runnable</a>:
+[JobBuilder](https://github.com/chrisgleissner/spring-batch-rest/blob/master/util/src/main/java/com/github/chrisgleissner/springbatchrest/util/core/JobBuilder.java) builds a simple job based on a <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Runnable.html">Runnable</a>:
 
 ```java
 Job job = jobBuilder.createJob("jobName", () -> System.out.println("Running job"));
 ```
 
-[AdHocScheduler](https://github.com/chrisgleissner/spring-batch-rest/blob/master/util/src/main/java/com/github/chrisgleissner/springbatchrest/util/adhoc/AdHocScheduler.java) registers and triggers a job using a Quartz CRON trigger. This can be performed at 
+[AdHocScheduler](https://github.com/chrisgleissner/spring-batch-rest/blob/master/util/src/main/java/com/github/chrisgleissner/springbatchrest/util/quartz/AdHocScheduler.java) registers and triggers a job using a Quartz CRON trigger. This can be performed at 
 run-time rather than Spring wiring time which allows for simplified set-up of a large number of jobs that only 
 differ slightly:
 
 ```java
 adHocScheduler.schedule("jobName", job, "0/30 * * * * ?");
 ```
 
-[AdHocStarter](https://github.com/chrisgleissner/spring-batch-rest/blob/master/util/src/main/java/com/github/chrisgleissner/springbatchrest/util/adhoc/AdHocStarter.java) is similar to AdHocScheduler, but used for immediately starting a job:
+[AdHocStarter](https://github.com/chrisgleissner/spring-batch-rest/blob/master/util/src/main/java/com/github/chrisgleissner/springbatchrest/util/core/AdHocStarter.java) is similar to AdHocScheduler, but used for immediately starting a job:
 
 ```java
 adHocStarter.start("jobName", job);

api/pom.xml

@@ -6,11 +6,11 @@
     <parent>
         <groupId>com.github.chrisgleissner</groupId>
         <artifactId>spring-batch-rest</artifactId>
-        <version>1.3.1-SNAPSHOT</version>
+        <version>1.4.1-SNAPSHOT</version>
     </parent>
 
     <artifactId>spring-batch-rest-api</artifactId>
-    <version>1.3.1-SNAPSHOT</version>
+    <version>1.4.1-SNAPSHOT</version>
     <name>spring-batch-rest-api</name>
 
     <dependencies>
@@ -40,7 +40,7 @@
         <dependency>
             <groupId>org.springdoc</groupId>
             <artifactId>springdoc-openapi-ui</artifactId>
-            <version>1.2.29</version>
+            <version>1.2.33</version>
         </dependency>
         <dependency>
             <groupId>org.projectlombok</groupId>
@@ -60,10 +60,6 @@
             <groupId>org.springframework.boot</groupId>
             <artifactId>spring-boot-starter-hateoas</artifactId>
         </dependency>
-        <dependency>
-            <groupId>org.springframework.boot</groupId>
-            <artifactId>spring-boot-starter-quartz</artifactId>
-        </dependency>
         <dependency>
             <groupId>org.springframework.boot</groupId>
             <artifactId>spring-boot-starter-thymeleaf</artifactId>
@@ -78,4 +74,30 @@
             <scope>test</scope>
         </dependency>
     </dependencies>
+
+    <build>
+        <plugins>
+            <plugin>
+                <artifactId>maven-enforcer-plugin</artifactId>
+                <version>3.0.0-M3</version>
+                <executions>
+                    <execution>
+                        <id>enforce-versions</id>
+                        <goals>
+                            <goal>enforce</goal>
+                        </goals>
+                        <configuration>
+                            <rules>
+                                <bannedDependencies>
+                                    <excludes>
+                                        <exclude>org.quartz-scheduler</exclude>
+                                    </excludes>
+                                </bannedDependencies>
+                            </rules>
+                        </configuration>
+                    </execution>
+                </executions>
+            </plugin>
+        </plugins>
+    </build>
 </project>

api/src/main/java/com/github/chrisgleissner/springbatchrest/api/EnableSpringBatchRest.java

@@ -0,0 +1,5 @@
+package com.github.chrisgleissner.springbatchrest.api.core;
+
+public interface Constants {
+    String REST_API_ENABLED = "com.github.chrisgleissner.springbatchrest.enabled";
+}

api/src/main/java/com/github/chrisgleissner/springbatchrest/api/core/Constants.java

@@ -1,29 +1,34 @@
-package com.github.chrisgleissner.springbatchrest.api;
+package com.github.chrisgleissner.springbatchrest.api.core;
 
-import com.github.chrisgleissner.springbatchrest.api.job.JobController;
-import com.github.chrisgleissner.springbatchrest.api.jobdetail.JobDetailController;
-import com.github.chrisgleissner.springbatchrest.api.jobexecution.JobExecutionController;
-import com.github.chrisgleissner.springbatchrest.util.adhoc.AdHocStarter;
+import com.github.chrisgleissner.springbatchrest.api.core.job.JobController;
+import com.github.chrisgleissner.springbatchrest.api.core.jobexecution.JobExecutionController;
+import com.github.chrisgleissner.springbatchrest.util.core.AdHocStarter;
 import io.swagger.v3.oas.models.Components;
 import io.swagger.v3.oas.models.OpenAPI;
 import io.swagger.v3.oas.models.info.Info;
 import io.swagger.v3.oas.models.info.License;
 import org.springframework.batch.core.configuration.annotation.EnableBatchProcessing;
 import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
 import org.springframework.boot.info.BuildProperties;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.ComponentScan;
 import org.springframework.context.annotation.Configuration;
 
+import static com.github.chrisgleissner.springbatchrest.api.core.Constants.REST_API_ENABLED;
+
 @Configuration
 @EnableBatchProcessing
-@ComponentScan(basePackageClasses= {AdHocStarter.class, JobController.class, JobDetailController.class, JobExecutionController.class })
-public class SpringBatchRestConfiguration {
+@ConditionalOnProperty(name = REST_API_ENABLED, havingValue = "true", matchIfMissing = true)
+@ComponentScan(basePackageClasses= {AdHocStarter.class, JobController.class, JobExecutionController.class })
+public class SpringBatchRestCoreAutoConfiguration {
 
     @Autowired(required = false)
     BuildProperties buildProperties;
 
     @Bean
+    @ConditionalOnMissingBean
     public OpenAPI customOpenAPI() {
         return new OpenAPI()
                 .components(new Components())

api/src/main/java/com/github/chrisgleissner/springbatchrest/api/SpringBatchRestConfiguration.java renamed to api/src/main/java/com/github/chrisgleissner/springbatchrest/api/core/SpringBatchRestCoreAutoConfiguration.java

@@ -1,4 +1,4 @@
-package com.github.chrisgleissner.springbatchrest.api.job;
+package com.github.chrisgleissner.springbatchrest.api.core.job;
 
 import lombok.AllArgsConstructor;
 import lombok.Value;

api/src/main/java/com/github/chrisgleissner/springbatchrest/api/job/Job.java renamed to api/src/main/java/com/github/chrisgleissner/springbatchrest/api/core/job/Job.java

@@ -1,7 +1,8 @@
-package com.github.chrisgleissner.springbatchrest.api.job;
+package com.github.chrisgleissner.springbatchrest.api.core.job;
 
 import io.swagger.v3.oas.annotations.Operation;
 import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
 import org.springframework.hateoas.CollectionModel;
 import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.PathVariable;
@@ -10,10 +11,12 @@
 
 import java.util.Collection;
 
+import static com.github.chrisgleissner.springbatchrest.api.core.Constants.REST_API_ENABLED;
 import static java.util.stream.Collectors.toList;
 import static org.springframework.hateoas.server.mvc.WebMvcLinkBuilder.linkTo;
 import static org.springframework.hateoas.server.mvc.WebMvcLinkBuilder.methodOn;
 
+@ConditionalOnProperty(name = REST_API_ENABLED, havingValue = "true", matchIfMissing = true)
 @RestController
 @RequestMapping(value = "/jobs", produces = "application/hal+json")
 public class JobController {

api/src/main/java/com/github/chrisgleissner/springbatchrest/api/job/JobController.java renamed to api/src/main/java/com/github/chrisgleissner/springbatchrest/api/core/job/JobController.java

@@ -1,4 +1,4 @@
-package com.github.chrisgleissner.springbatchrest.api.job;
+package com.github.chrisgleissner.springbatchrest.api.core.job;
 
 import org.springframework.hateoas.RepresentationModel;