Skip to content

Commit bfc0b31

Browse files
committed
remove references to edison-jobtrigger since the project is archived and add note to README of edison-jobs
Co-authored-by: Matthias Geißendörfer <[email protected]>
1 parent 2fc35bc commit bfc0b31

File tree

2 files changed

+11
-11
lines changed

2 files changed

+11
-11
lines changed

edison-jobs/README.md

+10-7
Original file line numberDiff line numberDiff line change
@@ -7,20 +7,22 @@ Simple addon library to support background jobs for Edison Microservices.
77
This library offers the possibility to execute background jobs like, for example, importing data from other services
88
on a regular basis.
99

10-
Job information can automatically be persisted in a MongoDB if you use edison-mongo. Otherwise they are only persisted
10+
Job information can automatically be persisted in a MongoDB if you use edison-mongo. Otherwise they are only persisted
1111
in memory. In clustered environments (multiple instances of a single service) it is generally a good idea to use some
12-
kind of persistence.
12+
kind of persistence.
1313

14-
It is possible to persist job information in different data stores. In this case, a `JobRepository` must be implemented
14+
It is possible to persist job information in different data stores. In this case, a `JobRepository` must be implemented
1515
and exposed as a Spring Bean.
1616

17-
Beside of starting a job programmatically via the `Jobservice` you can also use the graphical user interface which
17+
Beside of starting a job programmatically via the `Jobservice` you can also use the graphical user interface which
1818
comes with this library. Links to this UI are automatically added to the service´s /internal pages menu bar if
1919
edison-jobs is added to the classpath.
2020

21-
The scheduling of the jobs is not part of this framework. External triggering is implemented by
22-
[Edison JobTrigger](https://github.com/otto-de/edison-jobtrigger), but also internal triggers are easy to implement
23-
using Spring's @EnableScheduling and @Scheduled annotations.
21+
The scheduling of the jobs is not part of this framework.
22+
23+
A former implementation of an external triggering is implemented by the
24+
archived [Edison JobTrigger](https://github.com/otto-de/edison-jobtrigger). We recommend the usage of internal triggers by
25+
using Spring's @EnableScheduling and @Scheduled annotations.
2426

2527
For the usage of edison-jobs take a look at example-jobs.
2628

@@ -29,6 +31,7 @@ For the usage of edison-jobs take a look at example-jobs.
2931
*PENDING*
3032

3133
### JobMutexHandler
34+
3235
You can define JobMutex-Groups to define, that certain jobs may not be executed, while other specific jobs are running.
3336

3437
To define a mutex group you need to define a bean of type JobMutexGroup

edison-jobs/src/main/java/de/otto/edison/jobs/definition/JobDefinition.java

+1-4
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,11 @@
66
/**
77
* Definition about how often and when a job expects to be triggered, restarted, and so on.
88
*
9-
* This information is used by external triggers like Edison JobTrigger, and during execution
9+
* This information could be used by external triggers and during execution
1010
* of jobs.
1111
*
1212
* @author Guido Steinacker
1313
* @since 25.08.15
14-
* @see <a href="https://github.com/otto-de/edison-jobtrigger">Edison JobTrigger</a>
1514
*/
1615
public interface JobDefinition {
1716

@@ -75,7 +74,6 @@ public interface JobDefinition {
7574
* the job failed to start.
7675
*
7776
* @return number of retries
78-
* @see <a href="https://github.com/otto-de/edison-jobtrigger">Edison JobTrigger</a>
7977
*/
8078
public default int retries() { return 0; }
8179

@@ -85,7 +83,6 @@ public interface JobDefinition {
8583
* This information is used by a job trigger to determine, how long a retry should be delayed.
8684
*
8785
* @return optional delay before retrying
88-
* @see <a href="https://github.com/otto-de/edison-jobtrigger">Edison JobTrigger</a>
8986
*/
9087
public default Optional<Duration> retryDelay() { return Optional.empty(); }
9188
}

0 commit comments

Comments
 (0)