Package org.jobrunr.scheduling

Class BackgroundJobRequest

  • public class BackgroundJobRequest
extends java.lang.Object
    Provides static methods for creating fire-and-forget, delayed and recurring jobs as well as to delete existing background jobs. If you prefer not to use a static accessor, you can inject the JobRequestScheduler which exposes the same methods.

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static void delete​(java.lang.String id)
      Deletes the recurring job based on the given id.
      static void delete​(java.util.UUID id)
      Deletes a job and sets its state to DELETED.
      static void delete​(JobId jobId)  
      static void enqueue​(java.util.stream.Stream<? extends JobRequest> input)
      Creates new fire-and-forget jobs for each item in the input stream.
      static JobId enqueue​(java.util.UUID id, JobRequest jobRequest)
      Creates a new fire-and-forget job based on a given jobRequest.
      static JobId enqueue​(JobRequest jobRequest)
      Creates a new fire-and-forget job based on a given jobRequest.
      static JobId schedule​(java.time.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.
      static JobId schedule​(java.time.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.
      static JobId schedule​(java.time.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.
      static JobId schedule​(java.time.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.
      static JobId schedule​(java.util.UUID id, java.time.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.
      static JobId schedule​(java.util.UUID id, java.time.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.
      static JobId schedule​(java.util.UUID id, java.time.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.
      static JobId schedule​(java.util.UUID id, java.time.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.
      static java.lang.String scheduleRecurrently​(java.lang.String id, java.lang.String cron, java.time.ZoneId zoneId, JobRequest jobRequest)
      Creates a new or alters the existing recurring job based on the given id, cron expression, ZoneId and jobRequest.
      static java.lang.String scheduleRecurrently​(java.lang.String id, java.lang.String cron, JobRequest jobRequest)
      Creates a new or alters the existing recurring job based on the given id, cron expression and jobRequest.
      static java.lang.String scheduleRecurrently​(java.lang.String cron, JobRequest jobRequest)
      Creates a new recurring job based on the given cron expression and the given jobRequest.
      static void setJobRequestScheduler​(JobRequestScheduler jobRequestScheduler)  

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Method Detail

      • enqueue

        public static JobId enqueue​(JobRequest jobRequest)
        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:
        
            BackgroundJobRequest.enqueue(new MyJobRequest());
        Parameters:
        jobRequest - the jobRequest which defines the fire-and-forget job.
        Returns:
        the id of the job

      • enqueue

        public static JobId enqueue​(java.util.UUID id,
                            JobRequest jobRequest)
        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:
        
            BackgroundJobRequest.enqueueJobRequest(id, new MyJobRequest());
        Parameters:
        id - the uuid with which to save the job
        jobRequest - the jobRequest which defines the fire-and-forget job.
        Returns:
        the id of the job

      • enqueue

        public static void enqueue​(java.util.stream.Stream<? extends JobRequest> input)
        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();
      BackgroundJobRequest.enqueue(workStream);
        Parameters:
        input - the stream of jobRequests for which to create fire-and-forget jobs

      • schedule

        public static JobId schedule​(java.time.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. 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:
        
      BackgroundJobRequest.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

        public static JobId schedule​(java.util.UUID id,
                             java.time.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. 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:
        
      BackgroundJobRequest.schedule(id, ZonedDateTime.now().plusHours(5), new MyJobRequest());
        Parameters:
        id - the uuid with which to save the job
        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

        public static JobId schedule​(java.time.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. 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:
        
      BackgroundJobRequest.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

        public static JobId schedule​(java.util.UUID id,
                             java.time.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. 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:
        
      BackgroundJobRequest.schedule(id, OffsetDateTime.now().plusHours(5), new MyJobRequest());
        Parameters:
        id - the uuid with which to save the job
        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

        public static JobId schedule​(java.time.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. 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:
        
      BackgroundJobRequest.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 Instant
        jobRequest - the jobRequest which defines the fire-and-forget job
        Returns:
        the id of the Job

      • schedule

        public static JobId schedule​(java.util.UUID id,
                             java.time.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. 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:
        
      BackgroundJobRequest.schedule(id, LocalDateTime.now().plusHours(5), new MyJobRequest());
        Parameters:
        id - the uuid with which to save the job
        localDateTime - the moment in time at which the job will be enqueued. It will use the systemDefault ZoneId to transform it to an UTC Instant
        jobRequest - the jobRequest which defines the fire-and-forget job
        Returns:
        the id of the Job

      • schedule

        public static JobId schedule​(java.time.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. 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:
        
      BackgroundJobRequest.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

        public static JobId schedule​(java.util.UUID id,
                             java.time.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. 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:
        
      BackgroundJobRequest.schedule(id, Instant.now().plusHours(5), new MyJobRequest());
        Parameters:
        id - the uuid with which to save the job
        instant - 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

      • delete

        public static void delete​(java.util.UUID id)
        Deletes a job and sets its state to DELETED. If the job is being processed, it will be interrupted.
        Parameters:
        id - the id of the job

      • scheduleRecurrently

        public static java.lang.String scheduleRecurrently​(java.lang.String cron,
                                                   JobRequest jobRequest)
        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:
        
      BackgroundJobRequest.scheduleRecurrently(Cron.daily(), new MyJobRequest());
        Parameters:
        cron - The cron expression defining when to run this recurring job
        jobRequest - the jobRequest which defines the fire-and-forget job
        Returns:
        the id of this recurring job which can be used to alter or delete it
        See Also:
        Cron

      • scheduleRecurrently

        public static java.lang.String scheduleRecurrently​(java.lang.String id,
                                                   java.lang.String cron,
                                                   JobRequest jobRequest)
        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 timezone
        An example:
        
      BackgroundJobRequest.scheduleRecurrently("my-recurring-job", Cron.daily(), new MyJobRequest());
        Parameters:
        id - the id of this recurring job which can be used to alter or delete it
        cron - The cron expression defining when to run this recurring job
        jobRequest - the jobRequest which defines the fire-and-forget job
        Returns:
        the id of this recurring job which can be used to alter or delete it
        See Also:
        Cron

      • scheduleRecurrently

        public static java.lang.String scheduleRecurrently​(java.lang.String id,
                                                   java.lang.String cron,
                                                   java.time.ZoneId zoneId,
                                                   JobRequest jobRequest)
        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:
        
      BackgroundJobRequest.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 it
        cron - The cron expression defining when to run this recurring job
        zoneId - The zoneId (timezone) of when to run this recurring job
        jobRequest - the jobRequest which defines the fire-and-forget job
        Returns:
        the id of this recurring job which can be used to alter or delete it
        See Also:
        Cron

      • delete

        public static void delete​(java.lang.String id)
        Deletes the recurring job based on the given id.
        An example:
        
      BackgroundJobRequest.delete("my-recurring-job"));
        Parameters:
        id - the id of the recurring job to delete

      • setJobRequestScheduler

        public static void setJobRequestScheduler​(JobRequestScheduler jobRequestScheduler)