Package org.jobrunr.scheduling
Class JobRequestScheduler
java.lang.Object
org.jobrunr.scheduling.AbstractJobScheduler
org.jobrunr.scheduling.JobRequestScheduler
Provides methods for creating fire-and-forget, delayed and recurring jobs as well as to delete existing background jobs.
This JobRequestScheduler
allows to schedule jobs by means of an implementation of a JobRequest
.
-
Constructor Summary
ConstructorDescriptionJobRequestScheduler
(StorageProvider storageProvider) Creates a new JobRequestScheduler using the provided storageProviderJobRequestScheduler
(StorageProvider storageProvider, List<JobFilter> jobFilters) Creates a new JobRequestScheduler using the provided storageProvider and the list of JobFilters that will be used for every background job -
Method Summary
Modifier and TypeMethodDescriptionvoid
create
(Stream<JobBuilder> jobBuilderStream) Creates a newJob
for eachJobBuilder
and provides an alternative to the job annotation.create
(JobBuilder jobBuilder) Creates a newJob
using aJobBuilder
that can be enqueued or scheduled and provides an alternative to the job annotation.createRecurrently
(RecurringJobBuilder recurringJobBuilder) Creates a new or alters the existing recurring job based on the recurringJobBuilder (using id, cron expression and jobRequest).void
enqueue
(Stream<? extends JobRequest> input) Creates new fire-and-forget jobs for each item in the input stream.enqueue
(UUID id, JobRequest jobRequest) Creates a new fire-and-forget job based on a given jobRequest.enqueue
(JobRequest jobRequest) Creates a new fire-and-forget job based on a given jobRequest.schedule
(Instant instant, JobRequest jobRequest) Creates a new fire-and-forget job based on the given jobRequest and schedules it to be enqueued at the given moment of time.schedule
(LocalDateTime localDateTime, JobRequest jobRequest) Creates a new fire-and-forget job based on the given jobRequest and schedules it to be enqueued at the given moment of time.schedule
(OffsetDateTime offsetDateTime, JobRequest jobRequest) Creates a new fire-and-forget job based on the given jobRequest and schedules it to be enqueued at the given moment of time.schedule
(ZonedDateTime zonedDateTime, JobRequest jobRequest) Creates a new fire-and-forget job based on the given jobRequest and schedules it to be enqueued at the given moment of time.schedule
(UUID id, Instant instant, JobRequest jobRequest) Creates a new fire-and-forget job based on the given jobRequest and schedules it to be enqueued at the given moment of time.schedule
(UUID id, LocalDateTime localDateTime, JobRequest jobRequest) Creates a new fire-and-forget job based on the given jobRequest and schedules it to be enqueued at the given moment of time.schedule
(UUID id, OffsetDateTime offsetDateTime, JobRequest jobRequest) Creates a new fire-and-forget job based on the given jobRequest and schedules it to be enqueued at the given moment of time.schedule
(UUID id, ZonedDateTime zonedDateTime, JobRequest jobRequest) Creates a new fire-and-forget job based on the given jobRequest and schedules it to be enqueued at the given moment of time.scheduleRecurrently
(String id, String cron, ZoneId zoneId, JobRequest jobRequest) Creates a new or alters the existing recurring job based on the given id, cron expression,ZoneId
and jobRequest.scheduleRecurrently
(String id, String cron, JobRequest jobRequest) Creates a new or alters the existing recurring job based on the given id, cron expression and jobRequest.scheduleRecurrently
(String id, Duration duration, JobRequest jobRequest) Creates a new or alters the existing recurring job based on the given id, duration and jobRequest.scheduleRecurrently
(String cron, JobRequest jobRequest) Creates a new recurring job based on the given cron expression and the given jobRequest.scheduleRecurrently
(Duration duration, JobRequest jobRequest) Creates a new recurring job based on the given duration and the given jobRequest.
-
Constructor Details
-
JobRequestScheduler
Creates a new JobRequestScheduler using the provided storageProvider- Parameters:
storageProvider
- the storageProvider to use
-
JobRequestScheduler
Creates a new JobRequestScheduler using the provided storageProvider and the list of JobFilters that will be used for every background job- Parameters:
storageProvider
- the storageProvider to usejobFilters
- list of jobFilters that will be used for every job
-
-
Method Details
-
create
Creates a newJob
using aJobBuilder
that can be enqueued or scheduled and provides an alternative to the job annotation.- Parameters:
jobBuilder
- the jobBuilder with all the details of the job- Returns:
- the id of the job
-
create
Creates a newJob
for eachJobBuilder
and provides an alternative to the job annotation.- Parameters:
jobBuilderStream
- the jobBuilders for which to create jobs.
-
enqueue
Creates a new fire-and-forget job based on a given jobRequest. JobRunr will try to find the JobRequestHandler in the IoC container or else it will try to create the handler by calling the default no-arg constructor.An example:
jobScheduler.enqueue(new MyJobRequest());
- Parameters:
jobRequest
- the jobRequest which defines the fire-and-forget job.- Returns:
- the id of the job
-
enqueue
Creates a new fire-and-forget job based on a given jobRequest. JobRunr will try to find the JobRequestHandler in the IoC container or else it will try to create the handler by calling the default no-arg constructor.An example:
jobScheduler.enqueue(id, new MyJobRequest());
- Parameters:
id
- the uuid with which to save the jobjobRequest
- the jobRequest which defines the fire-and-forget job.- Returns:
- the id of the job
-
enqueue
Creates new fire-and-forget jobs for each item in the input stream. JobRunr will try to find the JobRequestHandler in the IoC container or else it will try to create the handler by calling the default no-arg constructor.An example:
Stream<MyJobRequest> workStream = getWorkStream(); jobScheduler.enqueue(workStream);
- Parameters:
input
- the stream of jobRequests for which to create fire-and-forget jobs
-
schedule
Creates a new fire-and-forget job based on the given jobRequest and schedules it to be enqueued at the given moment of time. JobRunr will try to find the JobRequestHandler in the IoC container or else it will try to create the handler by calling the default no-arg constructor.An example:
jobScheduler.schedule(ZonedDateTime.now().plusHours(5), new MyJobRequest());
- Parameters:
zonedDateTime
- the moment in time at which the job will be enqueued.jobRequest
- the jobRequest which defines the fire-and-forget job- Returns:
- the id of the Job
-
schedule
Creates a new fire-and-forget job based on the given jobRequest and schedules it to be enqueued at the given moment of time. JobRunr will try to find the JobRequestHandler in the IoC container or else it will try to create the handler by calling the default no-arg constructor. If a job with that id already exists, JobRunr will not save it again.An example:
jobScheduler.schedule(id, ZonedDateTime.now().plusHours(5), new MyJobRequest());
- Parameters:
id
- the uuid with which to save the jobzonedDateTime
- the moment in time at which the job will be enqueued.jobRequest
- the jobRequest which defines the fire-and-forget job- Returns:
- the id of the Job
-
schedule
Creates a new fire-and-forget job based on the given jobRequest and schedules it to be enqueued at the given moment of time. JobRunr will try to find the JobRequestHandler in the IoC container or else it will try to create the handler by calling the default no-arg constructor.An example:
jobScheduler.schedule(OffsetDateTime.now().plusHours(5), new MyJobRequest());
- Parameters:
offsetDateTime
- the moment in time at which the job will be enqueued.jobRequest
- the jobRequest which defines the fire-and-forget job- Returns:
- the id of the Job
-
schedule
Creates a new fire-and-forget job based on the given jobRequest and schedules it to be enqueued at the given moment of time. JobRunr will try to find the JobRequestHandler in the IoC container or else it will try to create the handler by calling the default no-arg constructor. If a job with that id already exists, JobRunr will not save it again.An example:
jobScheduler.schedule(id, OffsetDateTime.now().plusHours(5), new MyJobRequest());
- Parameters:
id
- the uuid with which to save the joboffsetDateTime
- the moment in time at which the job will be enqueued.jobRequest
- the jobRequest which defines the fire-and-forget job- Returns:
- the id of the Job
-
schedule
Creates a new fire-and-forget job based on the given jobRequest and schedules it to be enqueued at the given moment of time. JobRunr will try to find the JobRequestHandler in the IoC container or else it will try to create the handler by calling the default no-arg constructor.An example:
jobScheduler.schedule(LocalDateTime.now().plusHours(5), new MyJobRequest());
- Parameters:
localDateTime
- the moment in time at which the job will be enqueued. It will use the systemDefault ZoneId to transform it to an UTC InstantjobRequest
- the jobRequest which defines the fire-and-forget job- Returns:
- the id of the Job
-
schedule
Creates a new fire-and-forget job based on the given jobRequest and schedules it to be enqueued at the given moment of time. JobRunr will try to find the JobRequestHandler in the IoC container or else it will try to create the handler by calling the default no-arg constructor. If a job with that id already exists, JobRunr will not save it again.An example:
jobScheduler.schedule(id, LocalDateTime.now().plusHours(5), new MyJobRequest());
- Parameters:
id
- the uuid with which to save the joblocalDateTime
- the moment in time at which the job will be enqueued. It will use the systemDefault ZoneId to transform it to an UTC InstantjobRequest
- the jobRequest which defines the fire-and-forget job- Returns:
- the id of the Job
-
schedule
Creates a new fire-and-forget job based on the given jobRequest and schedules it to be enqueued at the given moment of time. JobRunr will try to find the JobRequestHandler in the IoC container or else it will try to create the handler by calling the default no-arg constructor.An example:
jobScheduler.schedule(Instant.now().plusHours(5), new MyJobRequest());
- Parameters:
instant
- the moment in time at which the job will be enqueued.jobRequest
- the lambda which defines the fire-and-forget job- Returns:
- the id of the Job
-
schedule
Creates a new fire-and-forget job based on the given jobRequest and schedules it to be enqueued at the given moment of time. JobRunr will try to find the JobRequestHandler in the IoC container or else it will try to create the handler by calling the default no-arg constructor. If a job with that id already exists, JobRunr will not save it again.An example:
jobScheduler.schedule(id, Instant.now().plusHours(5), new MyJobRequest());
- Parameters:
id
- the uuid with which to save the jobinstant
- the moment in time at which the job will be enqueued.jobRequest
- the jobRequest which defines the fire-and-forget job- Returns:
- the id of the Job
-
createRecurrently
Creates a new or alters the existing recurring job based on the recurringJobBuilder (using id, cron expression and jobRequest). JobRunr will try to find the JobRequestHandler in the IoC container or else it will try to create the handler by calling the default no-arg constructor. If no zoneId is set on the builder the jobs will be scheduled using the systemDefault timezone.An example:
jobRequestScheduler.createRecurrently(aRecurringJob() .withCron("* * 0 * * *") .withJobRequest(new SendMailRequest(toRequestParam, subjectRequestParam, bodyRequestParam));
- Parameters:
recurringJobBuilder
- the builder describing your recurring job.- Returns:
- the id of this recurring job which can be used to alter or delete it
- See Also:
-
scheduleRecurrently
Creates a new recurring job based on the given cron expression and the given jobRequest. JobRunr will try to find the JobRequestHandler in the IoC container or else it will try to create the handler by calling the default no-arg constructor. The jobs will be scheduled using the systemDefault timezone.An example:
jobScheduler.scheduleRecurrently(Cron.daily(), new MyJobRequest());
- Parameters:
cron
- The cron expression defining when to run this recurring jobjobRequest
- the jobRequest which defines the recurring job- Returns:
- the id of this recurring job which can be used to alter or delete it
- See Also:
-
scheduleRecurrently
Creates a new or alters the existing recurring job based on the given id, cron expression and jobRequest. JobRunr will try to find the JobRequestHandler in the IoC container or else it will try to create the handler by calling the default no-arg constructor. The jobs will be scheduled using the systemDefault timezoneAn example:
jobScheduler.scheduleRecurrently("my-recurring-job", Cron.daily(), new MyJobRequest());
- Parameters:
id
- the id of this recurring job which can be used to alter or delete itcron
- The cron expression defining when to run this recurring jobjobRequest
- the jobRequest which defines the recurring job- Returns:
- the id of this recurring job which can be used to alter or delete it
- See Also:
-
scheduleRecurrently
Creates a new or alters the existing recurring job based on the given id, cron expression,ZoneId
and jobRequest. JobRunr will try to find the JobRequestHandler in the IoC container or else it will try to create the handler by calling the default no-arg constructor.An example:
jobScheduler.scheduleRecurrently("my-recurring-job", Cron.daily(), ZoneId.of("Europe/Brussels"), new MyJobRequest());
- Parameters:
id
- the id of this recurring job which can be used to alter or delete itcron
- The cron expression defining when to run this recurring jobzoneId
- The zoneId (timezone) of when to run this recurring jobjobRequest
- the jobRequest which defines the recurring job- Returns:
- the id of this recurring job which can be used to alter or delete it
- See Also:
-
scheduleRecurrently
Creates a new recurring job based on the given duration and the given jobRequest. JobRunr will try to find the JobRequestHandler in the IoC container or else it will try to create the handler by calling the default no-arg constructor. The first run of this recurring job will happen after the given duration unless your duration is smaller or equal than your backgroundJobServer pollInterval.An example:
MyService service = new MyService(); BackgroundJob.scheduleRecurrently(Duration.parse("P5D"), new MyJobRequest());
- Parameters:
duration
- the duration defining the time between each instance of this recurring job.jobRequest
- the jobRequest which defines the recurring job- Returns:
- the id of this recurring job which can be used to alter or delete it
-
scheduleRecurrently
Creates a new or alters the existing recurring job based on the given id, duration and jobRequest. JobRunr will try to find the JobRequestHandler in the IoC container or else it will try to create the handler by calling the default no-arg constructor. The first run of this recurring job will happen after the given duration unless your duration is smaller or equal than your backgroundJobServer pollInterval.An example:
MyService service = new MyService(); BackgroundJob.scheduleRecurrently("my-recurring-job", Duration.parse("P5D"), new MyJobRequest());
- Parameters:
id
- the id of this recurring job which can be used to alter or delete itduration
- the duration defining the time between each instance of this recurring jobjobRequest
- the jobRequest which defines the recurring job- Returns:
- the id of this recurring job which can be used to alter or delete it
-