Package org.nuxeo.ecm.core.scheduler

Interface SchedulerService

All Known Implementing Classes:
SchedulerServiceImpl
public interface SchedulerService
Scheduler service.

  • Method Details

    • registerSchedule

      void registerSchedule(Schedule schedule)
      Registers a schedule.
      Parameters:
      schedule - the schedule

    • registerSchedule

      void registerSchedule(Schedule schedule, Map<String,Serializable> parameters)
      Registers a schedule. Add all parameters to eventContext.

    • unregisterSchedule

      boolean unregisterSchedule(String scheduleId)
      UnRegisters a schedule.
      Parameters:
      scheduleId - the schedule id
      Returns:
      true if schedule has been successfully removed.

    • unregisterSchedule

      boolean unregisterSchedule(Schedule schedule)
      UnRegisters a schedule.
      Parameters:
      schedule - to be unregistered
      Returns:
      true if schedule has been successfully removed.

    • hasApplicationStarted

      boolean hasApplicationStarted()
      Checks if the framework has fully started.

      Used to delay job execution until the framework has fully started.

      Returns:
      true if the framework has started
      Since:
      5.6

    • getSchedules

      List<Schedule> getSchedules()
      Gets the list of the registered schedules.
      Returns:
      the schedules list
      Since:
      2023.3

    • pause

      void pause()
      Pause the scheduler service. The pause is cluster-wide and survives a node restart. See resume() to resume the schedules service.
      Since:
      2023.3

    • resume

      void resume()
      Resume the scheduler service.
      Since:
      2023.3