Package com.almis.awe.scheduler.feign

Interface RemoteScheduler

@FeignClient(name="remote-scheduler", url="${awe.scheduler.remote-scheduler-url:http://localhost:8000/scheduler/api/v1}") public interface RemoteScheduler

  • Method Details

    • getTaskList

      @PostMapping("/tasks") ServiceData getTaskList(@RequestBody TaskListCriteria taskListCriteria)

    • getNextFireTimes

      @PostMapping("/tasks/executions") ServiceData getNextFireTimes(@RequestParam("numberOfFireTimes") int numberOfFireTimes, @RequestBody Schedule schedule)

    • getTaskExecutionList

      @GetMapping("/task/{taskId}/executions") ServiceData getTaskExecutionList(@PathVariable int taskId)
      Retrieve the task progress status
      Returns:
      Service Data

    • pauseTask

      @PostMapping("/task/{taskId}/pause") ServiceData pauseTask(@PathVariable int taskId)
      Pause the selected task
      Parameters:
      taskId - Task identifier
      Returns:
      Service Data

    • resumeTask

      @PostMapping("/task/{taskId}/resume") ServiceData resumeTask(@PathVariable int taskId)
      Resume the selected task
      Parameters:
      taskId - Task identifier
      Returns:
      Service Data

    • executeTaskNow

      @PostMapping("/task/{taskId}/execute") ServiceData executeTaskNow(@PathVariable int taskId, @RequestParam String user)
      Execute the selected task now
      Parameters:
      taskId - Task identifier
      user - Launch user
      Returns:
      Service Data

    • scheduleTask

      @PutMapping("/task/{taskId}/schedule") ServiceData scheduleTask(@PathVariable int taskId)
      Insert and schedule a new task
      Parameters:
      taskId - Task identifier
      Returns:
      Service Data

    • rescheduleTask

      @PostMapping("/task/{taskId}/schedule") ServiceData rescheduleTask(@PathVariable int taskId)
      Update and reschedule a task
      Parameters:
      taskId - Task identifier list
      Returns:
      Service Data

    • unscheduleTask

      @DeleteMapping("/tasks/schedule") ServiceData unscheduleTask(@RequestParam List<Integer> taskIdList)
      Delete some tasks from scheduler
      Parameters:
      taskIdList - Task identifier list
      Returns:
      Service Data

    • purgeExecutions

      @DeleteMapping("/task/{taskId}/executions") ServiceData purgeExecutions(@PathVariable int taskId, @RequestParam("keep") int keep)
      Purge execution logs
      Parameters:
      taskId - Task identifier
      keep - Number of executions to keep
      Returns:
      Service Data

    • getExecutingJobs

      @GetMapping("/jobs/executing") ServiceData getExecutingJobs()
      Get currently executing jobs from the scheduler instance
      Returns:
      Service Data

    • getConfiguredJobs

      @GetMapping("/jobs/configured") ServiceData getConfiguredJobs()
      Get configured
      Returns:
      Service Data

    • insertCalendar

      @PutMapping("/calendar/{calendarId}") ServiceData insertCalendar(@PathVariable int calendarId)
      Insert and schedule a new calendar
      Parameters:
      calendarId - Calendar identifier
      Returns:
      Service Data

    • updateCalendar

      @PostMapping("/calendar/{calendarId}") ServiceData updateCalendar(@PathVariable int calendarId)
      Update and schedule a new calendar
      Parameters:
      calendarId - Calendar identifier
      Returns:
      Service Data

    • deleteCalendars

      @DeleteMapping("/calendar") ServiceData deleteCalendars(@RequestParam("calendarList") List<Integer> calendarIdList)
      Delete a calendar from scheduler
      Parameters:
      calendarIdList - Calendar identifier list
      Returns:
      Service Data

    • checkCalendarInTriggers

      @GetMapping("/calendar/check") ServiceData checkCalendarInTriggers(@RequestParam("calendarList") List<Integer> calendarIdList)
      Check if the scheduler contains the selected calendar
      Parameters:
      calendarIdList - Calendar identifier list
      Returns:
      Service Data

    • activateCalendar

      @PostMapping("/calendar/activate") ServiceData activateCalendar(@RequestParam("calendarList") List<Integer> calendarIdList)
      Resume the selected calendar
      Parameters:
      calendarIdList - Calendar identifier list
      Returns:
      Service Data

    • deactivateCalendar

      @PostMapping("/calendar/deactivate") ServiceData deactivateCalendar(@RequestParam("calendarList") List<Integer> calendarIdList)
      Pause the selected calendar
      Parameters:
      calendarIdList - Calendar identifier list
      Returns:
      Service Data

    • startScheduler

      @PostMapping("/start") ServiceData startScheduler()
      Start the scheduler service
      Returns:
      Service Data

    • stopScheduler

      @PostMapping("/stop") ServiceData stopScheduler()
      Stop the scheduler service
      Returns:
      Service Data

    • restartScheduler

      @PostMapping("/restart") ServiceData restartScheduler()
      Scheduler's emergency reboot method
      Returns:
      Service Data

    • clearAndStopScheduler

      @PostMapping("/clearAndStop") ServiceData clearAndStopScheduler()
      Clear all scheduled tasks and stop the scheduler.
      Returns:
      Service Data

    • getSchedulerMetadata

      @GetMapping("/metadata") ServiceData getSchedulerMetadata()
      Returns information about the configured scheduler
      Returns:
      Service Data