├── .gitignore
├── .idea
├── .gitignore
├── .name
├── codeStyles
│ ├── Project.xml
│ └── codeStyleConfig.xml
├── compiler.xml
├── encodings.xml
├── examples.iml
├── jarRepositories.xml
├── libraries-with-intellij-classes.xml
├── misc.xml
├── modules.xml
├── modules
│ ├── core
│ │ └── example-spring.core.test.iml
│ ├── processingapp
│ │ └── example-spring.processingapp.test.iml
│ └── webapp
│ │ └── example-spring.webapp.test.iml
└── vcs.xml
├── README.md
├── build.gradle
├── core
├── build.gradle
├── pom.xml
└── src
│ └── main
│ └── java
│ └── org
│ └── jobrunr
│ └── examples
│ └── services
│ ├── MyService.java
│ └── MyServiceInterface.java
├── gradle
└── wrapper
│ ├── gradle-wrapper.jar
│ └── gradle-wrapper.properties
├── gradlew
├── gradlew.bat
├── pom.xml
├── processingapp
├── build.gradle
├── pom.xml
└── src
│ └── main
│ ├── java
│ └── org
│ │ └── jobrunr
│ │ └── examples
│ │ └── processingapp
│ │ ├── JobServerApplication.java
│ │ └── JobServerConfiguration.java
│ └── resources
│ └── application.properties
├── settings.gradle
└── webapp
├── build.gradle
├── pom.xml
└── src
└── main
└── java
└── org
└── jobrunr
└── examples
└── webapp
├── WebApplication.java
├── WebConfiguration.java
└── api
└── JobController.java
/.gitignore:
--------------------------------------------------------------------------------
1 |
2 | # Created by https://www.gitignore.io/api/java,gradle,intellij
3 | # Edit at https://www.gitignore.io/?templates=java,gradle,intellij
4 |
5 | ### Intellij ###
6 | # Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and WebStorm
7 | # Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
8 |
9 | # User-specific stuff
10 | .idea/**/workspace.xml
11 | .idea/**/tasks.xml
12 | .idea/**/usage.statistics.xml
13 | .idea/**/dictionaries
14 | .idea/**/shelf
15 |
16 | # Generated files
17 | .idea/**/contentModel.xml
18 |
19 | # Sensitive or high-churn files
20 | .idea/**/dataSources/
21 | .idea/**/dataSources.ids
22 | .idea/**/dataSources.local.xml
23 | .idea/**/sqlDataSources.xml
24 | .idea/**/dynamic.xml
25 | .idea/**/uiDesigner.xml
26 | .idea/**/dbnavigator.xml
27 |
28 | # Gradle
29 | .idea/**/gradle.xml
30 | .idea/**/libraries
31 |
32 | # Gradle and Maven with auto-import
33 | # When using Gradle or Maven with auto-import, you should exclude module files,
34 | # since they will be recreated, and may cause churn. Uncomment if using
35 | # auto-import.
36 | # .idea/modules.xml
37 | # .idea/*.iml
38 | # .idea/modules
39 | # *.iml
40 | # *.ipr
41 |
42 | # CMake
43 | cmake-build-*/
44 |
45 | # Mongo Explorer plugin
46 | .idea/**/mongoSettings.xml
47 |
48 | # File-based project format
49 | *.iws
50 |
51 | # IntelliJ
52 | out/
53 |
54 | # mpeltonen/sbt-idea plugin
55 | .idea_modules/
56 |
57 | # JIRA plugin
58 | atlassian-ide-plugin.xml
59 |
60 | # Cursive Clojure plugin
61 | .idea/replstate.xml
62 |
63 | # Crashlytics plugin (for Android Studio and IntelliJ)
64 | com_crashlytics_export_strings.xml
65 | crashlytics.properties
66 | crashlytics-build.properties
67 | fabric.properties
68 |
69 | # Editor-based Rest Client
70 | .idea/httpRequests
71 |
72 | # Android studio 3.1+ serialized cache file
73 | .idea/caches/build_file_checksums.ser
74 |
75 | ### Intellij Patch ###
76 | # Comment Reason: https://github.com/joeblau/gitignore.io/issues/186#issuecomment-215987721
77 |
78 | # *.iml
79 | # modules.xml
80 | # .idea/misc.xml
81 | # *.ipr
82 |
83 | # Sonarlint plugin
84 | .idea/**/sonarlint/
85 |
86 | # SonarQube Plugin
87 | .idea/**/sonarIssues.xml
88 |
89 | # Markdown Navigator plugin
90 | .idea/**/markdown-navigator.xml
91 | .idea/**/markdown-navigator/
92 |
93 | ### Java ###
94 | # Compiled class file
95 | *.class
96 |
97 | # Log file
98 | *.log
99 |
100 | # BlueJ files
101 | *.ctxt
102 |
103 | # Mobile Tools for Java (J2ME)
104 | .mtj.tmp/
105 |
106 | # Package Files #
107 | *.jar
108 | *.war
109 | *.nar
110 | *.ear
111 | *.zip
112 | *.tar.gz
113 | *.rar
114 |
115 | # virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
116 | hs_err_pid*
117 |
118 | ### Gradle ###
119 | .gradle
120 | build/
121 |
122 | # Ignore Gradle GUI config
123 | gradle-app.setting
124 |
125 | # Avoid ignoring Gradle wrapper jar file (.jar files are usually ignored)
126 | !gradle-wrapper.jar
127 |
128 | # Cache of project
129 | .gradletasknamecache
130 |
131 | # # Work around https://youtrack.jetbrains.com/issue/IDEA-116898
132 | # gradle/wrapper/gradle-wrapper.properties
133 |
134 | ### Gradle Patch ###
135 | **/build/
136 |
137 | # End of https://www.gitignore.io/api/java,gradle,intellij
138 | .drone-secrets
139 |
140 | # Frontend
141 | # See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
142 |
143 | # dependencies
144 | /core/src/main/resources/org/jobrunr/dashboard/frontend/node_modules
145 | /.pnp
146 | .pnp.js
147 |
148 | # testing
149 | /core/src/main/resources/org/jobrunr/dashboard/frontend/coverage
150 |
151 | # production
152 | /core/src/main/resources/org/jobrunr/dashboard/frontend/build
153 |
154 | # eclipse stuff
155 | .classpath
156 | .project
157 | .settings
158 | target/
159 |
160 | # misc
161 | .DS_Store
162 | .env.development
163 | .env.development.local
164 | .env.test.local
165 | .env.production.local
166 |
167 | npm-debug.log*
168 | yarn-debug.log*
169 | yarn-error.log*
170 |
--------------------------------------------------------------------------------
/.idea/.gitignore:
--------------------------------------------------------------------------------
1 | # Default ignored files
2 | /workspace.xml
--------------------------------------------------------------------------------
/.idea/.name:
--------------------------------------------------------------------------------
1 | examples
--------------------------------------------------------------------------------
/.idea/codeStyles/Project.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
8 |
9 |
10 |
11 |
12 |
13 |
14 |
15 |
16 |
17 |
18 |
--------------------------------------------------------------------------------
/.idea/codeStyles/codeStyleConfig.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
--------------------------------------------------------------------------------
/.idea/compiler.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
8 |
9 |
10 |
15 |
16 |
--------------------------------------------------------------------------------
/.idea/encodings.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
8 |
9 |
10 |
11 |
12 |
13 |
--------------------------------------------------------------------------------
/.idea/examples.iml:
--------------------------------------------------------------------------------
1 |
2 |
--------------------------------------------------------------------------------
/.idea/jarRepositories.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
8 |
9 |
10 |
11 |
12 |
13 |
14 |
15 |
16 |
17 |
18 |
19 |
20 |
21 |
22 |
23 |
24 |
25 |
26 |
27 |
28 |
29 |
30 |
31 |
32 |
33 |
34 |
35 |
--------------------------------------------------------------------------------
/.idea/libraries-with-intellij-classes.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
64 |
65 |
--------------------------------------------------------------------------------
/.idea/misc.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
8 |
9 |
10 |
11 |
12 |
13 |
14 |
15 |
16 |
17 |
18 |
19 |
20 |
--------------------------------------------------------------------------------
/.idea/modules.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
8 |
--------------------------------------------------------------------------------
/.idea/modules/core/example-spring.core.test.iml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
--------------------------------------------------------------------------------
/.idea/modules/processingapp/example-spring.processingapp.test.iml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
--------------------------------------------------------------------------------
/.idea/modules/webapp/example-spring.webapp.test.iml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
--------------------------------------------------------------------------------
/.idea/vcs.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # JobRunr example
2 |
3 | This repository shows an advanced example how you can integrate JobRunr with [spring.io](https://spring.io/). In this example, Jobs are created via a web frontend (the `webapp` module) and processed in a different JVM (the `processingapp` module).
4 |
5 | An easier example using [spring.io](https://spring.io/) can be found [here](https://github.com/jobrunr/example-java-mag)
6 |
7 | ## About this project
8 | This project exists out of 3 modules:
9 | - **core**: this project contains [MyService](core/src/main/java/org/jobrunr/examples/services/MyService.java), a simple spring service with two example methods which you want to run in a backgroundserver.
10 | - **processingapp**: this app is a Spring Console application and runs indefinitely. It polls for new background jobs
11 | and processes them when they arrive. It contains only a two classes:
12 | - the [JobServerApplication](processingapp/src/main/java/org/jobrunr/examples/processingapp/JobServerApplication.java) which is empty 🙂
13 | - the [JobServerConfiguration](processingapp/src/main/java/org/jobrunr/examples/processingapp/JobServerConfiguration.java) which starts the H2 Database (in server mode) and contains the database information
14 | > the thing to note here is the [`application.properties`](processingapp/src/main/resources/application.properties) where the server and the dashboard are enabled
15 | - **webapp**: this is a Spring Rest Webapp that enqueues new background jobs. It contains a simple `RestController`
16 | called [JobController](webapp/src/main/java/org/jobrunr/examples/webapp/api/JobController.java) which contains some
17 | methods (= endpoints) to enqueue jobs.
18 |
19 | ## How to run this project:
20 | - clone the project and open it in your favorite IDE that supports gradle
21 | - First, run the main method from
22 | the [JobServerApplication](processingapp/src/main/java/org/jobrunr/examples/processingapp/JobServerApplication.java)
23 | in the `processingapp` module and also keep it running
24 | - Run the main method from the [WebApplication](webapp/src/main/java/org/jobrunr/examples/webapp/WebApplication.java) in the `webapp` module and keep it running
25 | - Open your favorite browser:
26 | - Navigate to the JobRunr dashboard located at http://localhost:8000/dashboard. This is running within
27 | the [JobServerApplication](processingapp/src/main/java/org/jobrunr/examples/processingapp/JobServerApplication.java).
28 | - To enqueue a simple job, open a new tab and go to http://localhost:8080/jobs/ and take it from there.
29 | - Visit the dashboard again and see the jobs being processed!
30 |
--------------------------------------------------------------------------------
/build.gradle:
--------------------------------------------------------------------------------
1 | plugins {
2 | id 'java-platform'
3 | }
4 |
5 | javaPlatform {
6 | allowDependencies()
7 | }
8 |
9 | dependencies {
10 | api platform('org.springframework.boot:spring-boot-dependencies:3.3.0')
11 |
12 | constraints {
13 | api 'org.jobrunr:jobrunr-spring-boot-3-starter:7.2.0'
14 | }
15 | }
16 |
17 |
18 | configure(subprojects.findAll {it.name != 'platform'}) {
19 |
20 | apply plugin: 'java'
21 | apply plugin: 'idea'
22 | group = 'org.jobrunr.examples'
23 | version = '1.0'
24 |
25 | sourceCompatibility = JavaVersion.VERSION_17
26 | targetCompatibility = JavaVersion.VERSION_17
27 |
28 | repositories {
29 | mavenLocal()
30 | mavenCentral()
31 | }
32 | }
33 |
34 |
--------------------------------------------------------------------------------
/core/build.gradle:
--------------------------------------------------------------------------------
1 | dependencies {
2 | implementation platform(project(':'))
3 |
4 | implementation 'org.springframework.boot:spring-boot-starter'
5 | implementation 'org.jobrunr:jobrunr-spring-boot-3-starter'
6 | implementation 'com.h2database:h2'
7 | }
--------------------------------------------------------------------------------
/core/pom.xml:
--------------------------------------------------------------------------------
1 |
3 |
4 | org.jobrunr.examples
5 | spring-example
6 | 1.0.0-SNAPSHOT
7 |
8 | 4.0.0
9 |
10 | spring-example-core
11 |
12 |
13 |
14 | org.springframework.boot
15 | spring-boot-starter
16 |
17 |
18 | org.jobrunr
19 | jobrunr-spring-boot-3-starter
20 |
21 |
22 | com.h2database
23 | h2
24 |
25 |
26 | com.fasterxml.jackson.core
27 | jackson-databind
28 |
29 |
30 | com.fasterxml.jackson.datatype
31 | jackson-datatype-jsr310
32 |
33 |
34 |
--------------------------------------------------------------------------------
/core/src/main/java/org/jobrunr/examples/services/MyService.java:
--------------------------------------------------------------------------------
1 | package org.jobrunr.examples.services;
2 |
3 | import org.jobrunr.jobs.annotations.Job;
4 | import org.jobrunr.jobs.annotations.Recurring;
5 | import org.jobrunr.jobs.context.JobContext;
6 | import org.jobrunr.jobs.context.JobDashboardProgressBar;
7 | import org.jobrunr.jobs.context.JobRunrDashboardLogger;
8 | import org.slf4j.Logger;
9 | import org.slf4j.LoggerFactory;
10 | import org.springframework.stereotype.Component;
11 |
12 | /**
13 | * This is a simple spring service
14 | */
15 | @Component
16 | public class MyService implements MyServiceInterface {
17 |
18 | private static final Logger LOGGER = new JobRunrDashboardLogger(LoggerFactory.getLogger(MyService.class));
19 |
20 | @Recurring(id = "my-recurring-job", cron = "0 0/15 * * *")
21 | @Job(name = "My recurring job")
22 | public void doRecurringJob() {
23 | System.out.println("Doing some work without arguments");
24 | }
25 |
26 | public void doSimpleJob(String anArgument) {
27 | System.out.println("Doing some work: " + anArgument);
28 | }
29 |
30 | public void doLongRunningJob(String anArgument) {
31 | try {
32 | for (int i = 0; i < 10; i++) {
33 | System.out.println(String.format("Doing work item %d: %s", i, anArgument));
34 | Thread.sleep(20000);
35 | }
36 | } catch (InterruptedException e) {
37 | Thread.currentThread().interrupt();
38 | }
39 | }
40 |
41 | public void doLongRunningJobWithJobContext(String anArgument, JobContext jobContext) {
42 | try {
43 | LOGGER.warn("Starting long running job...");
44 | final JobDashboardProgressBar progressBar = jobContext.progressBar(10);
45 | for (int i = 0; i < 10; i++) {
46 | LOGGER.info(String.format("Processing item %d: %s", i, anArgument));
47 | System.out.println(String.format("Doing work item %d: %s", i, anArgument));
48 | Thread.sleep(15000);
49 | progressBar.increaseByOne();
50 | }
51 | LOGGER.warn("Finished long running job...");
52 | } catch (InterruptedException e) {
53 | Thread.currentThread().interrupt();
54 | }
55 | }
56 | }
57 |
--------------------------------------------------------------------------------
/core/src/main/java/org/jobrunr/examples/services/MyServiceInterface.java:
--------------------------------------------------------------------------------
1 | package org.jobrunr.examples.services;
2 |
3 | public interface MyServiceInterface {
4 |
5 | void doSimpleJob(String anArgument);
6 |
7 | }
8 |
--------------------------------------------------------------------------------
/gradle/wrapper/gradle-wrapper.jar:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/jobrunr/example-spring/965bf6c978e799a2a203c758acb5c112920f3b89/gradle/wrapper/gradle-wrapper.jar
--------------------------------------------------------------------------------
/gradle/wrapper/gradle-wrapper.properties:
--------------------------------------------------------------------------------
1 | distributionBase=GRADLE_USER_HOME
2 | distributionPath=wrapper/dists
3 | distributionUrl=https\://services.gradle.org/distributions/gradle-8.2.1-bin.zip
4 | networkTimeout=10000
5 | zipStoreBase=GRADLE_USER_HOME
6 | zipStorePath=wrapper/dists
7 |
--------------------------------------------------------------------------------
/gradlew:
--------------------------------------------------------------------------------
1 | #!/bin/sh
2 |
3 | #
4 | # Copyright © 2015-2021 the original authors.
5 | #
6 | # Licensed under the Apache License, Version 2.0 (the "License");
7 | # you may not use this file except in compliance with the License.
8 | # You may obtain a copy of the License at
9 | #
10 | # https://www.apache.org/licenses/LICENSE-2.0
11 | #
12 | # Unless required by applicable law or agreed to in writing, software
13 | # distributed under the License is distributed on an "AS IS" BASIS,
14 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 | # See the License for the specific language governing permissions and
16 | # limitations under the License.
17 | #
18 |
19 | ##############################################################################
20 | #
21 | # Gradle start up script for POSIX generated by Gradle.
22 | #
23 | # Important for running:
24 | #
25 | # (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is
26 | # noncompliant, but you have some other compliant shell such as ksh or
27 | # bash, then to run this script, type that shell name before the whole
28 | # command line, like:
29 | #
30 | # ksh Gradle
31 | #
32 | # Busybox and similar reduced shells will NOT work, because this script
33 | # requires all of these POSIX shell features:
34 | # * functions;
35 | # * expansions «$var», «${var}», «${var:-default}», «${var+SET}»,
36 | # «${var#prefix}», «${var%suffix}», and «$( cmd )»;
37 | # * compound commands having a testable exit status, especially «case»;
38 | # * various built-in commands including «command», «set», and «ulimit».
39 | #
40 | # Important for patching:
41 | #
42 | # (2) This script targets any POSIX shell, so it avoids extensions provided
43 | # by Bash, Ksh, etc; in particular arrays are avoided.
44 | #
45 | # The "traditional" practice of packing multiple parameters into a
46 | # space-separated string is a well documented source of bugs and security
47 | # problems, so this is (mostly) avoided, by progressively accumulating
48 | # options in "$@", and eventually passing that to Java.
49 | #
50 | # Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS,
51 | # and GRADLE_OPTS) rely on word-splitting, this is performed explicitly;
52 | # see the in-line comments for details.
53 | #
54 | # There are tweaks for specific operating systems such as AIX, CygWin,
55 | # Darwin, MinGW, and NonStop.
56 | #
57 | # (3) This script is generated from the Groovy template
58 | # https://github.com/gradle/gradle/blob/HEAD/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
59 | # within the Gradle project.
60 | #
61 | # You can find Gradle at https://github.com/gradle/gradle/.
62 | #
63 | ##############################################################################
64 |
65 | # Attempt to set APP_HOME
66 |
67 | # Resolve links: $0 may be a link
68 | app_path=$0
69 |
70 | # Need this for daisy-chained symlinks.
71 | while
72 | APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path
73 | [ -h "$app_path" ]
74 | do
75 | ls=$( ls -ld "$app_path" )
76 | link=${ls#*' -> '}
77 | case $link in #(
78 | /*) app_path=$link ;; #(
79 | *) app_path=$APP_HOME$link ;;
80 | esac
81 | done
82 |
83 | # This is normally unused
84 | # shellcheck disable=SC2034
85 | APP_BASE_NAME=${0##*/}
86 | APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit
87 |
88 | # Use the maximum available, or set MAX_FD != -1 to use that value.
89 | MAX_FD=maximum
90 |
91 | warn () {
92 | echo "$*"
93 | } >&2
94 |
95 | die () {
96 | echo
97 | echo "$*"
98 | echo
99 | exit 1
100 | } >&2
101 |
102 | # OS specific support (must be 'true' or 'false').
103 | cygwin=false
104 | msys=false
105 | darwin=false
106 | nonstop=false
107 | case "$( uname )" in #(
108 | CYGWIN* ) cygwin=true ;; #(
109 | Darwin* ) darwin=true ;; #(
110 | MSYS* | MINGW* ) msys=true ;; #(
111 | NONSTOP* ) nonstop=true ;;
112 | esac
113 |
114 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
115 |
116 |
117 | # Determine the Java command to use to start the JVM.
118 | if [ -n "$JAVA_HOME" ] ; then
119 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
120 | # IBM's JDK on AIX uses strange locations for the executables
121 | JAVACMD=$JAVA_HOME/jre/sh/java
122 | else
123 | JAVACMD=$JAVA_HOME/bin/java
124 | fi
125 | if [ ! -x "$JAVACMD" ] ; then
126 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
127 |
128 | Please set the JAVA_HOME variable in your environment to match the
129 | location of your Java installation."
130 | fi
131 | else
132 | JAVACMD=java
133 | which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
134 |
135 | Please set the JAVA_HOME variable in your environment to match the
136 | location of your Java installation."
137 | fi
138 |
139 | # Increase the maximum file descriptors if we can.
140 | if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then
141 | case $MAX_FD in #(
142 | max*)
143 | # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked.
144 | # shellcheck disable=SC3045
145 | MAX_FD=$( ulimit -H -n ) ||
146 | warn "Could not query maximum file descriptor limit"
147 | esac
148 | case $MAX_FD in #(
149 | '' | soft) :;; #(
150 | *)
151 | # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked.
152 | # shellcheck disable=SC3045
153 | ulimit -n "$MAX_FD" ||
154 | warn "Could not set maximum file descriptor limit to $MAX_FD"
155 | esac
156 | fi
157 |
158 | # Collect all arguments for the java command, stacking in reverse order:
159 | # * args from the command line
160 | # * the main class name
161 | # * -classpath
162 | # * -D...appname settings
163 | # * --module-path (only if needed)
164 | # * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables.
165 |
166 | # For Cygwin or MSYS, switch paths to Windows format before running java
167 | if "$cygwin" || "$msys" ; then
168 | APP_HOME=$( cygpath --path --mixed "$APP_HOME" )
169 | CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" )
170 |
171 | JAVACMD=$( cygpath --unix "$JAVACMD" )
172 |
173 | # Now convert the arguments - kludge to limit ourselves to /bin/sh
174 | for arg do
175 | if
176 | case $arg in #(
177 | -*) false ;; # don't mess with options #(
178 | /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath
179 | [ -e "$t" ] ;; #(
180 | *) false ;;
181 | esac
182 | then
183 | arg=$( cygpath --path --ignore --mixed "$arg" )
184 | fi
185 | # Roll the args list around exactly as many times as the number of
186 | # args, so each arg winds up back in the position where it started, but
187 | # possibly modified.
188 | #
189 | # NB: a `for` loop captures its iteration list before it begins, so
190 | # changing the positional parameters here affects neither the number of
191 | # iterations, nor the values presented in `arg`.
192 | shift # remove old arg
193 | set -- "$@" "$arg" # push replacement arg
194 | done
195 | fi
196 |
197 |
198 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
199 | DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
200 |
201 | # Collect all arguments for the java command;
202 | # * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of
203 | # shell script including quotes and variable substitutions, so put them in
204 | # double quotes to make sure that they get re-expanded; and
205 | # * put everything else in single quotes, so that it's not re-expanded.
206 |
207 | set -- \
208 | "-Dorg.gradle.appname=$APP_BASE_NAME" \
209 | -classpath "$CLASSPATH" \
210 | org.gradle.wrapper.GradleWrapperMain \
211 | "$@"
212 |
213 | # Stop when "xargs" is not available.
214 | if ! command -v xargs >/dev/null 2>&1
215 | then
216 | die "xargs is not available"
217 | fi
218 |
219 | # Use "xargs" to parse quoted args.
220 | #
221 | # With -n1 it outputs one arg per line, with the quotes and backslashes removed.
222 | #
223 | # In Bash we could simply go:
224 | #
225 | # readarray ARGS < <( xargs -n1 <<<"$var" ) &&
226 | # set -- "${ARGS[@]}" "$@"
227 | #
228 | # but POSIX shell has neither arrays nor command substitution, so instead we
229 | # post-process each arg (as a line of input to sed) to backslash-escape any
230 | # character that might be a shell metacharacter, then use eval to reverse
231 | # that process (while maintaining the separation between arguments), and wrap
232 | # the whole thing up as a single "set" statement.
233 | #
234 | # This will of course break if any of these variables contains a newline or
235 | # an unmatched quote.
236 | #
237 |
238 | eval "set -- $(
239 | printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" |
240 | xargs -n1 |
241 | sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' |
242 | tr '\n' ' '
243 | )" '"$@"'
244 |
245 | exec "$JAVACMD" "$@"
246 |
--------------------------------------------------------------------------------
/gradlew.bat:
--------------------------------------------------------------------------------
1 | @rem
2 | @rem Copyright 2015 the original author or authors.
3 | @rem
4 | @rem Licensed under the Apache License, Version 2.0 (the "License");
5 | @rem you may not use this file except in compliance with the License.
6 | @rem You may obtain a copy of the License at
7 | @rem
8 | @rem https://www.apache.org/licenses/LICENSE-2.0
9 | @rem
10 | @rem Unless required by applicable law or agreed to in writing, software
11 | @rem distributed under the License is distributed on an "AS IS" BASIS,
12 | @rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | @rem See the License for the specific language governing permissions and
14 | @rem limitations under the License.
15 | @rem
16 |
17 | @if "%DEBUG%"=="" @echo off
18 | @rem ##########################################################################
19 | @rem
20 | @rem Gradle startup script for Windows
21 | @rem
22 | @rem ##########################################################################
23 |
24 | @rem Set local scope for the variables with windows NT shell
25 | if "%OS%"=="Windows_NT" setlocal
26 |
27 | set DIRNAME=%~dp0
28 | if "%DIRNAME%"=="" set DIRNAME=.
29 | @rem This is normally unused
30 | set APP_BASE_NAME=%~n0
31 | set APP_HOME=%DIRNAME%
32 |
33 | @rem Resolve any "." and ".." in APP_HOME to make it shorter.
34 | for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi
35 |
36 | @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
37 | set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m"
38 |
39 | @rem Find java.exe
40 | if defined JAVA_HOME goto findJavaFromJavaHome
41 |
42 | set JAVA_EXE=java.exe
43 | %JAVA_EXE% -version >NUL 2>&1
44 | if %ERRORLEVEL% equ 0 goto execute
45 |
46 | echo.
47 | echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
48 | echo.
49 | echo Please set the JAVA_HOME variable in your environment to match the
50 | echo location of your Java installation.
51 |
52 | goto fail
53 |
54 | :findJavaFromJavaHome
55 | set JAVA_HOME=%JAVA_HOME:"=%
56 | set JAVA_EXE=%JAVA_HOME%/bin/java.exe
57 |
58 | if exist "%JAVA_EXE%" goto execute
59 |
60 | echo.
61 | echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME%
62 | echo.
63 | echo Please set the JAVA_HOME variable in your environment to match the
64 | echo location of your Java installation.
65 |
66 | goto fail
67 |
68 | :execute
69 | @rem Setup the command line
70 |
71 | set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
72 |
73 |
74 | @rem Execute Gradle
75 | "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %*
76 |
77 | :end
78 | @rem End local scope for the variables with windows NT shell
79 | if %ERRORLEVEL% equ 0 goto mainEnd
80 |
81 | :fail
82 | rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
83 | rem the _cmd.exe /c_ return code!
84 | set EXIT_CODE=%ERRORLEVEL%
85 | if %EXIT_CODE% equ 0 set EXIT_CODE=1
86 | if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE%
87 | exit /b %EXIT_CODE%
88 |
89 | :mainEnd
90 | if "%OS%"=="Windows_NT" endlocal
91 |
92 | :omega
93 |
--------------------------------------------------------------------------------
/pom.xml:
--------------------------------------------------------------------------------
1 |
4 | 4.0.0
5 | org.jobrunr.examples
6 | spring-example
7 | 1.0.0-SNAPSHOT
8 |
9 | pom
10 |
11 | jobrunr-spring-example
12 | JobRunr Spring Example
13 |
14 |
15 | org.springframework.boot
16 | spring-boot-starter-parent
17 | 3.3.0
18 |
19 |
20 |
21 |
22 | core
23 | processingapp
24 | webapp
25 |
26 |
27 |
28 | 7.2.0
29 |
30 | 17
31 | 17
32 | UTF-8
33 | UTF-8
34 | 17
35 |
36 |
37 |
38 |
39 |
40 | org.jobrunr.examples
41 | spring-example-core
42 | ${project.parent.version}
43 |
44 |
45 | org.jobrunr.examples
46 | spring-example-processingapp
47 | ${project.parent.version}
48 |
49 |
50 | org.jobrunr.examples
51 | spring-example-webapp
52 | ${project.parent.version}
53 |
54 |
55 |
56 | org.jobrunr
57 | jobrunr-spring-boot-3-starter
58 | ${jobrunr.version}
59 |
60 |
61 |
62 |
63 |
--------------------------------------------------------------------------------
/processingapp/build.gradle:
--------------------------------------------------------------------------------
1 | plugins {
2 | id 'org.springframework.boot' version '3.1.1'
3 | }
4 |
5 | dependencies {
6 | implementation platform(project(':'))
7 |
8 | implementation project(':core')
9 | implementation 'org.springframework.boot:spring-boot-starter'
10 | implementation 'org.jobrunr:jobrunr-spring-boot-3-starter'
11 | implementation 'com.h2database:h2'
12 | implementation 'com.fasterxml.jackson.core:jackson-databind'
13 | implementation 'com.fasterxml.jackson.datatype:jackson-datatype-jsr310'
14 | }
15 |
16 | springBoot {
17 | mainClass.set('org.jobrunr.examples.processingapp.JobServerApplication')
18 | }
--------------------------------------------------------------------------------
/processingapp/pom.xml:
--------------------------------------------------------------------------------
1 |
3 |
4 | org.jobrunr.examples
5 | spring-example
6 | 1.0.0-SNAPSHOT
7 |
8 | 4.0.0
9 |
10 | spring-example-processingapp
11 |
12 |
13 |
14 | org.jobrunr.examples
15 | spring-example-core
16 |
17 |
18 |
--------------------------------------------------------------------------------
/processingapp/src/main/java/org/jobrunr/examples/processingapp/JobServerApplication.java:
--------------------------------------------------------------------------------
1 | package org.jobrunr.examples.processingapp;
2 |
3 | import org.springframework.boot.SpringApplication;
4 | import org.springframework.boot.autoconfigure.SpringBootApplication;
5 | import org.springframework.context.annotation.Import;
6 |
7 | @SpringBootApplication
8 | @Import(value = {JobServerConfiguration.class})
9 | public class JobServerApplication {
10 |
11 | public static void main(String[] args) {
12 | SpringApplication.run(JobServerApplication.class, args);
13 | }
14 | }
15 |
--------------------------------------------------------------------------------
/processingapp/src/main/java/org/jobrunr/examples/processingapp/JobServerConfiguration.java:
--------------------------------------------------------------------------------
1 | package org.jobrunr.examples.processingapp;
2 |
3 | import org.h2.jdbcx.JdbcDataSource;
4 | import org.h2.tools.Server;
5 | import org.springframework.context.annotation.Bean;
6 | import org.springframework.context.annotation.ComponentScan;
7 | import org.springframework.context.annotation.Configuration;
8 | import org.springframework.context.annotation.DependsOn;
9 |
10 | import java.sql.SQLException;
11 |
12 | @Configuration
13 | @ComponentScan(basePackages = "org.jobrunr.examples.services")
14 | public class JobServerConfiguration {
15 |
16 | @Bean
17 | @DependsOn("inMemoryH2DatabaseServer")
18 | public JdbcDataSource dataSource() {
19 | final JdbcDataSource dataSource = new JdbcDataSource();
20 | dataSource.setUrl("jdbc:h2:tcp://localhost:9090/mem:jobrunr-db;DB_CLOSE_DELAY=-1");
21 | return dataSource;
22 | }
23 |
24 | @Bean(initMethod = "start", destroyMethod = "stop")
25 | public Server inMemoryH2DatabaseServer() throws SQLException {
26 | return Server.createTcpServer("-tcp", "-ifNotExists", "-tcpAllowOthers", "-tcpPort", "9090");
27 | }
28 | }
29 |
--------------------------------------------------------------------------------
/processingapp/src/main/resources/application.properties:
--------------------------------------------------------------------------------
1 | spring.main.web-application-type=none
2 |
3 | org.jobrunr.dashboard.enabled=true
4 | org.jobrunr.background-job-server.enabled=true
5 | org.jobrunr.background-job-server.worker-count=4
--------------------------------------------------------------------------------
/settings.gradle:
--------------------------------------------------------------------------------
1 | rootProject.name="example-jobrunr-spring"
2 | include ':core'
3 | include ':webapp'
4 | include ':processingapp'
5 |
6 |
--------------------------------------------------------------------------------
/webapp/build.gradle:
--------------------------------------------------------------------------------
1 | plugins {
2 | id 'org.springframework.boot' version '3.1.1'
3 | }
4 |
5 | dependencies {
6 | implementation platform(project(':'))
7 | implementation project(':core')
8 | implementation 'org.springframework.boot:spring-boot-starter-web'
9 | implementation 'org.jobrunr:jobrunr-spring-boot-3-starter'
10 | implementation 'com.h2database:h2'
11 | }
--------------------------------------------------------------------------------
/webapp/pom.xml:
--------------------------------------------------------------------------------
1 |
3 |
4 | org.jobrunr.examples
5 | spring-example
6 | 1.0.0-SNAPSHOT
7 |
8 | 4.0.0
9 |
10 | spring-example-webapp
11 |
12 |
13 |
14 | org.jobrunr.examples
15 | spring-example-core
16 |
17 |
18 | org.springframework.boot
19 | spring-boot-starter-web
20 |
21 |
22 |
--------------------------------------------------------------------------------
/webapp/src/main/java/org/jobrunr/examples/webapp/WebApplication.java:
--------------------------------------------------------------------------------
1 | package org.jobrunr.examples.webapp;
2 |
3 | import org.springframework.boot.SpringApplication;
4 | import org.springframework.boot.autoconfigure.SpringBootApplication;
5 | import org.springframework.context.annotation.Import;
6 |
7 | @SpringBootApplication
8 | @Import(WebConfiguration.class)
9 | public class WebApplication {
10 |
11 | public static void main(String[] args) {
12 | SpringApplication.run(WebApplication.class, args);
13 | }
14 | }
15 |
--------------------------------------------------------------------------------
/webapp/src/main/java/org/jobrunr/examples/webapp/WebConfiguration.java:
--------------------------------------------------------------------------------
1 | package org.jobrunr.examples.webapp;
2 |
3 | import org.h2.jdbcx.JdbcDataSource;
4 | import org.h2.tools.Server;
5 | import org.springframework.context.annotation.Bean;
6 | import org.springframework.context.annotation.ComponentScan;
7 | import org.springframework.context.annotation.Configuration;
8 | import org.springframework.context.annotation.DependsOn;
9 |
10 | import java.sql.SQLException;
11 |
12 | @Configuration
13 | @ComponentScan(basePackages = "org.jobrunr.examples.services")
14 | public class WebConfiguration {
15 |
16 | @Bean
17 | public JdbcDataSource dataSource() {
18 | final JdbcDataSource dataSource = new JdbcDataSource();
19 | dataSource.setUrl("jdbc:h2:tcp://localhost:9090/mem:jobrunr-db;DB_CLOSE_DELAY=-1");
20 | return dataSource;
21 | }
22 | }
23 |
--------------------------------------------------------------------------------
/webapp/src/main/java/org/jobrunr/examples/webapp/api/JobController.java:
--------------------------------------------------------------------------------
1 | package org.jobrunr.examples.webapp.api;
2 |
3 | import org.jobrunr.examples.services.MyService;
4 | import org.jobrunr.examples.services.MyServiceInterface;
5 | import org.jobrunr.jobs.JobId;
6 | import org.jobrunr.jobs.context.JobContext;
7 | import org.jobrunr.scheduling.JobScheduler;
8 | import org.springframework.http.MediaType;
9 | import org.springframework.web.bind.annotation.GetMapping;
10 | import org.springframework.web.bind.annotation.RequestMapping;
11 | import org.springframework.web.bind.annotation.RequestParam;
12 | import org.springframework.web.bind.annotation.RestController;
13 |
14 | import java.time.Duration;
15 | import java.util.UUID;
16 |
17 | import static java.time.Instant.now;
18 |
19 | @RestController
20 | @RequestMapping("/jobs")
21 | public class JobController {
22 |
23 | private final JobScheduler jobScheduler;
24 | private final MyServiceInterface myService;
25 |
26 | public JobController(JobScheduler jobScheduler, MyServiceInterface myService) {
27 | this.jobScheduler = jobScheduler;
28 | this.myService = myService;
29 | }
30 |
31 | @GetMapping(produces = {MediaType.TEXT_HTML_VALUE})
32 | public String index() {
33 | return """
34 | Hello World from JobController!
\
35 | You can:
\
36 | - Enqueue a simple job
\
37 | - Enqueue a simple job using a service instance
\
38 | - Schedule a simple job 3 hours from now using a service instance
\
39 | - Enqueue a long-running job
\
40 | - Enqueue a long-running job using a JobContext to log progress
\
41 | - Learn more on www.jobrunr.io
\
42 | """
43 | ;
44 | }
45 |
46 | @GetMapping(value = "/simple-job", produces = {MediaType.TEXT_PLAIN_VALUE})
47 | public String simpleJob(@RequestParam(defaultValue = "World") String name) {
48 | final JobId enqueuedJobId = jobScheduler.enqueue(myService -> myService.doSimpleJob("Hello " + name));
49 | return "Job Enqueued: " + enqueuedJobId;
50 | }
51 |
52 | @GetMapping(value = "/simple-job-instance", produces = {MediaType.TEXT_PLAIN_VALUE})
53 | public String simpleJobUsingInstance(@RequestParam(defaultValue = "World") String name) {
54 | final JobId enqueuedJobId = jobScheduler.enqueue(() -> myService.doSimpleJob("Hello " + name));
55 | return "Job Enqueued: " + enqueuedJobId;
56 | }
57 |
58 | @GetMapping(value = "/schedule-simple-job", produces = {MediaType.TEXT_PLAIN_VALUE})
59 | public String scheduleSimpleJob(
60 | @RequestParam(defaultValue = "Hello world") String value,
61 | @RequestParam(defaultValue = "PT3H") String when) {
62 | final JobId scheduledJobId = jobScheduler.schedule(now().plus(Duration.parse(when)), () -> myService.doSimpleJob(value));
63 | return "Job Scheduled: " + scheduledJobId;
64 | }
65 |
66 | @GetMapping(value = "/long-running-job", produces = {MediaType.TEXT_PLAIN_VALUE})
67 | public String longRunningJob(@RequestParam(defaultValue = "World") String name) {
68 | final JobId enqueuedJobId = jobScheduler.enqueue(myService -> myService.doLongRunningJob("Hello " + name));
69 | return "Job Enqueued: " + enqueuedJobId;
70 | }
71 |
72 | @GetMapping(value = "/long-running-job-with-job-context", produces = {MediaType.TEXT_PLAIN_VALUE})
73 | public String longRunningJobWithJobContext(@RequestParam(defaultValue = "World") String name) {
74 | final JobId enqueuedJobId = jobScheduler.enqueue(myService -> myService.doLongRunningJobWithJobContext("Hello " + name, JobContext.Null));
75 | return "Job Enqueued: " + enqueuedJobId;
76 | }
77 |
78 | @GetMapping(value = "/delete-job", produces = {MediaType.TEXT_PLAIN_VALUE})
79 | public String deleteJob(@RequestParam UUID jobId) {
80 | jobScheduler.delete(jobId);
81 | return "Job Deleted: " + jobId;
82 | }
83 | }
84 |
--------------------------------------------------------------------------------