org.apache.syncope.common.services

Interface TaskService

All Superinterfaces:

JAXRSService

@Path(value="tasks")
public interface TaskService
extends JAXRSService

REST operations for tasks.

Field Summary

Fields inherited from interface org.apache.syncope.common.services.JAXRSService

DEFAULT_PARAM_PAGE, DEFAULT_PARAM_PAGE_VALUE, DEFAULT_PARAM_SIZE, DEFAULT_PARAM_SIZE_VALUE, PARAM_DETAILS, PARAM_FIQL, PARAM_ORDERBY, PARAM_PAGE, PARAM_SIZE

Method Summary

Methods

Modifier and Type	Method and Description
void	actionJob(Long taskId, JobAction action) Execute a control action on an existing task
BulkActionResult	bulk(BulkAction bulkAction) Executes the provided bulk action.
<T extends SchedTaskTO> javax.ws.rs.core.Response	create(T taskTO) Creates a new task.
void	delete(Long taskId) Deletes the task matching the provided id.
void	deleteExecution(Long executionId) Deletes the task execution matching the provided id.
BulkActionResult	deleteExecutions(Long taskId, Date startedBefore, Date startedAfter, Date endedBefore, Date endedAfter) Deletes the task executions belonging to the given task and matching the date conditions.
TaskExecTO	execute(Long taskId, boolean dryRun) Executes the task matching the given id.
List<JobClass>	getJobClasses() Returns a list of classes to be used for jobs.
List<PushActionClass>	getPushActionsClasses() Returns a list of classes to be used as push actions.
List<SyncActionClass>	getSyncActionsClasses() Returns a list of classes to be used as synchronization actions.
<T extends AbstractTaskTO> PagedResult<T>	list(TaskType taskType) Returns a list of tasks with matching type.
<T extends AbstractTaskTO> PagedResult<T>	list(TaskType taskType, Integer page, Integer size) Returns a paged list of existing tasks matching type and page/size conditions.
<T extends AbstractTaskTO> PagedResult<T>	list(TaskType taskType, Integer page, Integer size, String orderBy, boolean details) Returns a paged list of existing tasks matching type and page/size conditions.
<T extends AbstractTaskTO> PagedResult<T>	list(TaskType taskType, String orderBy) Returns a list of tasks with matching type.
PagedResult<TaskExecTO>	listExecutions(Long taskId, Integer page, Integer size) Returns the task executions for the given task.
List<TaskExecTO>	listJobs(JobStatusType type) List task jobs of the given type
<T extends AbstractTaskTO> T	read(Long taskId, boolean details) Returns the task matching the given id.
TaskExecTO	readExecution(Long executionId) Returns the task execution with the given id.
void	report(Long executionId, ReportExecTO reportExec) Reports task execution result.
void	update(Long taskId, AbstractTaskTO taskTO) Updates the task matching the provided id.

Method Detail

getJobClasses

@GET
@Path(value="jobClasses")
@Produces(value={"application/xml","application/json"})
List<JobClass> getJobClasses()

Returns a list of classes to be used for jobs.

Returns:

list of classes to be used for jobs

getSyncActionsClasses

@GET
@Path(value="syncActionsClasses")
@Produces(value={"application/xml","application/json"})
List<SyncActionClass> getSyncActionsClasses()

Returns a list of classes to be used as synchronization actions.

Returns:

list of classes to be used as synchronization actions

getPushActionsClasses

@GET
@Path(value="pushActionsClasses")
@Produces(value={"application/xml","application/json"})
List<PushActionClass> getPushActionsClasses()

Returns a list of classes to be used as push actions.

Returns:

list of classes to be used as push actions

read

@GET
@Path(value="{taskId}")
@Produces(value={"application/xml","application/json"})
<T extends AbstractTaskTO> T read(@NotNull@PathParam(value="taskId")
                                                  Long taskId,
                                                  @QueryParam(value="details")@DefaultValue(value="true")
                                                  boolean details)

Returns the task matching the given id.

Type Parameters:

T - type of taskTO

Parameters:

taskId - id of task to be read

details - whether include executions or not, defaults to true

Returns:

task with matching id

readExecution

@GET
@Path(value="executions/{executionId}")
@Produces(value={"application/xml","application/json"})
TaskExecTO readExecution(@NotNull@PathParam(value="executionId")
                                         Long executionId)

Returns the task execution with the given id.

Parameters:

executionId - id of task execution to be read

Returns:

task execution with matching Id

list

@GET
@Produces(value={"application/xml","application/json"})
<T extends AbstractTaskTO> PagedResult<T> list(@NotNull@MatrixParam(value="type")
                                                          TaskType taskType)

Returns a list of tasks with matching type.

Type Parameters:

T - type of taskTO

Parameters:

taskType - type of tasks to be listed

Returns:

list of tasks with matching type

list

@GET
@Produces(value={"application/xml","application/json"})
<T extends AbstractTaskTO> PagedResult<T> list(@NotNull@MatrixParam(value="type")
                                                          TaskType taskType,
                                                          @QueryParam(value="orderby")
                                                          String orderBy)

Returns a list of tasks with matching type.

Type Parameters:

T - type of taskTO

Parameters:

taskType - type of tasks to be listed

orderBy - list of ordering clauses, separated by comma

Returns:

list of tasks with matching type

list

@GET
@Produces(value={"application/xml","application/json"})
<T extends AbstractTaskTO> PagedResult<T> list(@NotNull@MatrixParam(value="type")
                                                          TaskType taskType,
                                                          @NotNull@Min(value=1L)@QueryParam(value="page")@DefaultValue(value="1")
                                                          Integer page,
                                                          @NotNull@Min(value=1L)@QueryParam(value="size")@DefaultValue(value="25")
                                                          Integer size,
                                                          @QueryParam(value="orderby")
                                                          String orderBy,
                                                          @QueryParam(value="details")@DefaultValue(value="true")
                                                          boolean details)

Returns a paged list of existing tasks matching type and page/size conditions.

Type Parameters:

T - type of taskTO

Parameters:

taskType - type of tasks to be listed

page - page number of tasks in relation to page size

size - number of tasks listed per page

orderBy - list of ordering clauses, separated by comma

details - whether include executions or not, defaults to true

Returns:

paged list of existing tasks matching type and page/size conditions

list

@GET
@Produces(value={"application/xml","application/json"})
<T extends AbstractTaskTO> PagedResult<T> list(@MatrixParam(value="type")
                                                          TaskType taskType,
                                                          @NotNull@Min(value=1L)@QueryParam(value="page")@DefaultValue(value="1")
                                                          Integer page,
                                                          @NotNull@Min(value=1L)@QueryParam(value="size")@DefaultValue(value="25")
                                                          Integer size)

Returns a paged list of existing tasks matching type and page/size conditions.

Type Parameters:

T - type of taskTO

Parameters:

taskType - type of tasks to be listed

page - page number of tasks in relation to page size

size - number of tasks listed per page

Returns:

paged list of existing tasks matching type and page/size conditions

listExecutions

@GET
@Path(value="{taskId}/executions")
@Produces(value={"application/xml","application/json"})
PagedResult<TaskExecTO> listExecutions(@NotNull@PathParam(value="taskId")
                                                       Long taskId,
                                                       @NotNull@Min(value=1L)@QueryParam(value="page")@DefaultValue(value="1")
                                                       Integer page,
                                                       @NotNull@Min(value=1L)@QueryParam(value="size")@DefaultValue(value="25")
                                                       Integer size)

Returns the task executions for the given task.

Parameters:

taskId - task to which executions belong

page - page number of executions in relation to page size

size - number of executions listed per page

Returns:

list of task executions for the given task

create

@POST
@Consumes(value={"application/xml","application/json"})
<T extends SchedTaskTO> javax.ws.rs.core.Response create(@NotNull
                                                                     T taskTO)

Creates a new task.

Type Parameters:

T - type of taskTO

Parameters:

taskTO - task to be created

Returns:

Response object featuring Location header of created task

update

@PUT
@Path(value="{taskId}")
@Consumes(value={"application/xml","application/json"})
void update(@NotNull@PathParam(value="taskId")
                            Long taskId,
                            @NotNull
                            AbstractTaskTO taskTO)

Updates the task matching the provided id.

Parameters:

taskId - id of task to be updated

taskTO - updated task to be stored

delete

@DELETE
@Path(value="{taskId}")
void delete(@NotNull@PathParam(value="taskId")
                      Long taskId)

Deletes the task matching the provided id.

Parameters:

taskId - id of task to be deleted

deleteExecution

@DELETE
@Path(value="executions/{executionId}")
void deleteExecution(@NotNull@PathParam(value="executionId")
                               Long executionId)

Deletes the task execution matching the provided id.

Parameters:

executionId - id of task execution to be deleted

deleteExecutions

@DELETE
@Path(value="{taskId}/executions")
@Produces(value={"application/xml","application/json"})
BulkActionResult deleteExecutions(@NotNull@PathParam(value="taskId")
                                                     Long taskId,
                                                     @QueryParam(value="startedBefore")
                                                     Date startedBefore,
                                                     @QueryParam(value="startedAfter")
                                                     Date startedAfter,
                                                     @QueryParam(value="endedBefore")
                                                     Date endedBefore,
                                                     @QueryParam(value="endedAfter")
                                                     Date endedAfter)

Deletes the task executions belonging to the given task and matching the date conditions.

Parameters:

taskId - task to which executions belong

startedBefore - selects executions started before this timestamp

startedAfter - selects executions started after this timestamp

endedBefore - selects executions ended before this timestamp

endedAfter - selects executions ended after this timestamp

Returns:

bulk action result

execute

@POST
@Path(value="{taskId}/execute")
@Produces(value={"application/xml","application/json"})
TaskExecTO execute(@NotNull@PathParam(value="taskId")
                                    Long taskId,
                                    @QueryParam(value="dryRun")@DefaultValue(value="false")
                                    boolean dryRun)

Executes the task matching the given id.

Parameters:

taskId - id of task to be executed

dryRun - if true, task will only be simulated

Returns:

execution report for the task matching the given id

report

@POST
@Path(value="executions/{executionId}/report")
@Consumes(value={"application/xml","application/json"})
void report(@NotNull@PathParam(value="executionId")
                             Long executionId,
                             @NotNull
                             ReportExecTO reportExec)

Reports task execution result.

Parameters:

executionId - id of task execution being reported

reportExec - execution being reported

bulk

@POST
@Path(value="bulk")
@Produces(value={"application/xml","application/json"})
@Consumes(value={"application/xml","application/json"})
BulkActionResult bulk(@NotNull
                                                BulkAction bulkAction)

Executes the provided bulk action.

Parameters:

bulkAction - list of task ids against which the bulk action will be performed.

Returns:

bulk action result

listJobs

@GET
@Path(value="jobs")
@Produces(value={"application/xml","application/json"})
List<TaskExecTO> listJobs(@MatrixParam(value="type")
                                          JobStatusType type)

List task jobs of the given type

Parameters:

type - of task job

Returns:

List of TaskExecTO

actionJob

@POST
@Path(value="{taskId}")
void actionJob(@PathParam(value="taskId")
                       Long taskId,
                       @QueryParam(value="action")
                       JobAction action)

Execute a control action on an existing task

Parameters:

taskId - id of task

action - action to execute