com.gentics.contentnode.rest.resource.scheduler

Interface SchedulerResource

@Path(value="scheduler")
public interface SchedulerResource

Resource for managing the scheduler

Method Summary

Modifier and Type	Method and Description
ScheduleResponse	createSchedule(ScheduleModel schedule) Create a new Schedule
TaskResponse	createTask(TaskModel task) Create a new task
GenericResponse	deleteSchedule(String scheduleId) Delete a schedule
GenericResponse	deleteTask(String taskId) Delete a task
GenericResponse	executeSchedule(String scheduleId) Execute the specified schedule now.
ExecutionResponse	getExecution(String executionId) Load an execution
ScheduleResponse	getSchedule(String scheduleId) Load a schedule
TaskResponse	getTask(String taskId) Load a task
JobsResponse	jobs(FilterParameterBean filter, SortParameterBean sorting, PagingParameterBean paging, SchedulerJobFilterParameterBean jobFilter) List scheduler jobs
ExecutionListResponse	listExecutions(String scheduleId, FilterParameterBean filter, SortParameterBean sorting, PagingParameterBean paging, ExecutionFilterParameterBean executionFilterParameterBean) List all executions of the given schedule which match the filters. The result can be filtered by id scheduleId log and sorted by id startTime endTime duration result
ScheduleListResponse	listSchedules(FilterParameterBean filter, SortParameterBean sorting, PagingParameterBean paging, PermsParameterBean perms) List scheduler schedules. The result can be filtered by id name description taskId and sorted by id name description taskId cdate edate
TaskListResponse	listTasks(FilterParameterBean filter, SortParameterBean sorting, PagingParameterBean paging, PermsParameterBean perms) List scheduler tasks. The result can be filtered by id name description command and sorted by id name description command cdate edate
SchedulerStatusResponse	resume() Resume the scheduler
SchedulerStatusResponse	status(boolean fixExecutor) Get the scheduler status and optionally restart the scheduler executor if it is not running.
SchedulerStatusResponse	suspend(SuspendRequest request) Suspend the scheduler
ScheduleResponse	updateSchedule(String scheduleId, ScheduleModel schedule) Update a schedule
TaskResponse	updateTask(String taskId, TaskModel task) Update a task

Method Detail

status

@GET
 @Path(value="/status")
SchedulerStatusResponse status(@QueryParam(value="fixExecutor")
                                                            boolean fixExecutor)
                                                     throws Exception

Get the scheduler status and optionally restart the scheduler executor if it is not running.

Parameters:

fixExecutor - Whether to restart the scheduler executor if it is not running currently.

Returns:

status

Throws:

Exception

suspend

@PUT
 @Path(value="/suspend")
SchedulerStatusResponse suspend(SuspendRequest request)
                                                       throws Exception

Suspend the scheduler

Parameters:

request - suspend request

Returns:

status

Throws:

Exception

resume

@PUT
 @Path(value="/resume")
SchedulerStatusResponse resume()
                                                     throws Exception

Resume the scheduler

Returns:

status

Throws:

Exception

jobs

@GET
 @Path(value="/jobs")
JobsResponse jobs(@BeanParam
                                             FilterParameterBean filter,
                                             @BeanParam
                                             SortParameterBean sorting,
                                             @BeanParam
                                             PagingParameterBean paging,
                                             @BeanParam
                                             SchedulerJobFilterParameterBean jobFilter)
                                      throws Exception

List scheduler jobs

Parameters:

filter - filter parameter bean

sorting - sorting parameter bean

paging - paging parameter bean

jobFilter - job filter parameter bean

Returns:

list of jobs

Throws:

Exception

listTasks

@GET
 @Path(value="/task")
TaskListResponse listTasks(@BeanParam
                                                      FilterParameterBean filter,
                                                      @BeanParam
                                                      SortParameterBean sorting,
                                                      @BeanParam
                                                      PagingParameterBean paging,
                                                      @BeanParam
                                                      PermsParameterBean perms)
                                               throws Exception

List scheduler tasks.
The result can be filtered by

• id
• name
• description
• command

and sorted by

• id
• name
• description
• command
• cdate
• edate

Parameters:

filter - filter parameter bean

sorting - sorting parameter bean

paging - paging parameter bean

perms - permissions parameter bean

Returns:

response containing a list of tasks

Throws:

Exception

createTask

@POST
 @Path(value="/task")
TaskResponse createTask(TaskModel task)
                                             throws Exception

Create a new task

Parameters:

task - task

Returns:

response containing the created task

Throws:

Exception

getTask

@GET
 @Path(value="/task/{id}")
TaskResponse getTask(@PathParam(value="id")
                                                     String taskId)
                                              throws Exception

Load a task

Parameters:

taskId - task ID

Returns:

response containing the task

Throws:

Exception

updateTask

@PUT
 @Path(value="/task/{id}")
TaskResponse updateTask(@PathParam(value="id")
                                                        String taskId,
                                                        TaskModel task)
                                                 throws Exception

Update a task

Parameters:

taskId - task ID

task - task data to update

Returns:

updated task

Throws:

Exception

deleteTask

@DELETE
 @Path(value="/task/{id}")
GenericResponse deleteTask(@PathParam(value="id")
                                                              String taskId)
                                                       throws Exception

Delete a task

Parameters:

taskId - task ID

Returns:

response

Throws:

Exception

listSchedules

@GET
 @Path(value="/schedule")
ScheduleListResponse listSchedules(@BeanParam
                                                                  FilterParameterBean filter,
                                                                  @BeanParam
                                                                  SortParameterBean sorting,
                                                                  @BeanParam
                                                                  PagingParameterBean paging,
                                                                  @BeanParam
                                                                  PermsParameterBean perms)
                                                           throws Exception

List scheduler schedules.
The result can be filtered by

• id
• name
• description
• taskId

and sorted by

• id
• name
• description
• taskId
• cdate
• edate

Parameters:

filter - filter parameter bean

sorting - sorting parameter bean

paging - paging parameter bean

perms - permissions parameter bean

Returns:

response containing a list of schedules

Throws:

Exception

createSchedule

@POST
 @Path(value="/schedule")
ScheduleResponse createSchedule(ScheduleModel schedule)
                                                         throws Exception

Create a new Schedule

Parameters:

schedule - schedule

Returns:

response containing the created schedule

Throws:

Exception

getSchedule

@GET
 @Path(value="/schedule/{id}")
ScheduleResponse getSchedule(@PathParam(value="id")
                                                                 String scheduleId)
                                                          throws Exception

Load a schedule

Parameters:

scheduleId - schedule ID

Returns:

response containing the schedule

Throws:

Exception

updateSchedule

@PUT
 @Path(value="/schedule/{id}")
ScheduleResponse updateSchedule(@PathParam(value="id")
                                                                    String scheduleId,
                                                                    ScheduleModel schedule)
                                                             throws Exception

Update a schedule

Parameters:

scheduleId - schedule ID

schedule - schedule to update

Returns:

updated task

Throws:

Exception

deleteSchedule

@DELETE
 @Path(value="/schedule/{id}")
GenericResponse deleteSchedule(@PathParam(value="id")
                                                                      String scheduleId)
                                                               throws Exception

Delete a schedule

Parameters:

scheduleId - schedule ID

Returns:

response

Throws:

Exception

executeSchedule

@POST
 @Path(value="/schedule/{id}/execute")
GenericResponse executeSchedule(@PathParam(value="id")
                                                                             String scheduleId)
                                                                      throws Exception

Execute the specified schedule now.

There is no check if the schedule schould be executed, besides a check if it is active.

Parameters:

scheduleId - The schedule to execute

Returns:

response

Throws:

Exception

listExecutions

@GET
 @Path(value="/schedule/{id}/execution")
ExecutionListResponse listExecutions(@PathParam(value="id")
                                                                                   String scheduleId,
                                                                                   @BeanParam
                                                                                   FilterParameterBean filter,
                                                                                   @BeanParam
                                                                                   SortParameterBean sorting,
                                                                                   @BeanParam
                                                                                   PagingParameterBean paging,
                                                                                   @BeanParam
                                                                                   ExecutionFilterParameterBean executionFilterParameterBean)
                                                                            throws Exception

List all executions of the given schedule which match the filters.
The result can be filtered by

• id
• scheduleId
• log

and sorted by

• id
• startTime
• endTime
• duration
• result

Parameters:

scheduleId - schedule ID

filter - filter parameter bean

sorting - sorting parameter bean

paging - paging parameter bean

executionFilterParameterBean - execution specific filter parameter bean

Returns:

Response containing the list of executions

Throws:

Exception

getExecution

@GET
 @Path(value="/execution/{id}")
ExecutionResponse getExecution(@PathParam(value="id")
                                                                    String executionId)
                                                             throws Exception

Load an execution

Parameters:

executionId - execution ID

Returns:

response containing the execution

Throws:

Exception