Skip to content

Commit

Permalink
remove references to edison-jobtrigger since the project is archived …
Browse files Browse the repository at this point in the history
…and add note to README of edison-jobs

Co-authored-by: Matthias Geißendörfer <matthias.geissendoerfer@otto.de>
  • Loading branch information
mgeissen committed Feb 7, 2025
1 parent 2fc35bc commit bfc0b31
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 11 deletions.
17 changes: 10 additions & 7 deletions edison-jobs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,20 +7,22 @@ Simple addon library to support background jobs for Edison Microservices.
This library offers the possibility to execute background jobs like, for example, importing data from other services
on a regular basis.

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

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

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

The scheduling of the jobs is not part of this framework. External triggering is implemented by
[Edison JobTrigger](https://github.com/otto-de/edison-jobtrigger), but also internal triggers are easy to implement
using Spring's @EnableScheduling and @Scheduled annotations.
The scheduling of the jobs is not part of this framework.

A former implementation of an external triggering is implemented by the
archived [Edison JobTrigger](https://github.com/otto-de/edison-jobtrigger). We recommend the usage of internal triggers by
using Spring's @EnableScheduling and @Scheduled annotations.

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

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

### JobMutexHandler

You can define JobMutex-Groups to define, that certain jobs may not be executed, while other specific jobs are running.

To define a mutex group you need to define a bean of type JobMutexGroup
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,11 @@
/**
* Definition about how often and when a job expects to be triggered, restarted, and so on.
*
* This information is used by external triggers like Edison JobTrigger, and during execution
* This information could be used by external triggers and during execution
* of jobs.
*
* @author Guido Steinacker
* @since 25.08.15
* @see <a href="https://github.com/otto-de/edison-jobtrigger">Edison JobTrigger</a>
*/
public interface JobDefinition {

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

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

0 comments on commit bfc0b31

Please sign in to comment.