org.apache.syncope.common.rest.api.service

Interface TaskService

All Superinterfaces:

ExecutableService, JAXRSService

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

REST operations for tasks.

Field Summary

Fields inherited from interface org.apache.syncope.common.rest.api.service.JAXRSService

PARAM_ANYTYPE_KIND, PARAM_CONNID_PAGED_RESULTS_COOKIE, PARAM_DETAILS, PARAM_ENTITY_KEY, PARAM_FIQL, PARAM_MAX, PARAM_NOTIFICATION, PARAM_ORDERBY, PARAM_PAGE, PARAM_RESOURCE, PARAM_SIZE

Method Summary

Modifier and Type	Method and Description
BulkActionResult	bulk(BulkAction bulkAction) Executes the provided bulk action.
javax.ws.rs.core.Response	create(TaskType type, SchedTaskTO taskTO) Creates a new task.
void	delete(TaskType type, String key) Deletes the task matching the provided key.
<T extends TaskTO> T	read(TaskType type, String key, boolean details) Returns the task matching the given key.
<T extends TaskTO> PagedResult<T>	search(TaskQuery query) Returns a paged list of existing tasks matching the given query.
void	update(TaskType type, SchedTaskTO taskTO) Updates the task matching the provided key.

Methods inherited from interface org.apache.syncope.common.rest.api.service.ExecutableService

actionJob, deleteExecution, deleteExecutions, execute, getJob, listExecutions, listJobs, listRecentExecutions

Method Detail

read

@GET
 @Path(value="{type}/{key}")
 @Produces(value={"application/json","application/yaml","application/xml"})
<T extends TaskTO> T read(@NotNull @PathParam(value="type")
                                                                                                                                        TaskType type,
                                                                                                                                        @NotNull @PathParam(value="key")
                                                                                                                                        String key,
                                                                                                                                        @QueryParam(value="details") @DefaultValue(value="true")
                                                                                                                                        boolean details)

Returns the task matching the given key.

Type Parameters:

T - type of taskTO

Parameters:

type - task type

key - key of task to be read

details - whether include executions or not, defaults to true

Returns:

task with matching id

search

@GET
 @Path(value="{type}")
 @Produces(value={"application/json","application/yaml","application/xml"})
<T extends TaskTO> PagedResult<T> search(@BeanParam
                                                                                                                                                 TaskQuery query)

Returns a paged list of existing tasks matching the given query.

Type Parameters:

T - type of taskTO

Parameters:

query - query conditions

Returns:

paged list of existing tasks matching the given query

create

@POST
 @Path(value="{type}")
 @Consumes(value={"application/json","application/yaml","application/xml"})
 @Produces(value={"application/json","application/yaml","application/xml"})
javax.ws.rs.core.Response create(@NotNull @PathParam(value="type")
                                                                                                                                                                                                                      TaskType type,
                                                                                                                                                                                                                      @NotNull
                                                                                                                                                                                                                      SchedTaskTO taskTO)

Creates a new task.

Parameters:

type - task type

taskTO - task to be created

Returns:

Response object featuring Location header of created task

update

@PUT
 @Path(value="{type}/{key}")
 @Consumes(value={"application/json","application/yaml","application/xml"})
 @Produces(value={"application/json","application/yaml","application/xml"})
void update(@NotNull @PathParam(value="type")
                                                                                                                                                                                                      TaskType type,
                                                                                                                                                                                                      @NotNull
                                                                                                                                                                                                      SchedTaskTO taskTO)

Updates the task matching the provided key.

Parameters:

type - task type

taskTO - updated task to be stored

delete

@DELETE
 @Path(value="{type}/{key}")
 @Produces(value={"application/json","application/yaml","application/xml"})
void delete(@NotNull @PathParam(value="type")
                                                                                                                             TaskType type,
                                                                                                                             @NotNull @PathParam(value="key")
                                                                                                                             String key)

Deletes the task matching the provided key.

Parameters:

type - task type

key - key of task to be deleted

bulk

@POST
 @Path(value="bulk")
 @Produces(value={"application/json","application/yaml","application/xml"})
 @Consumes(value={"application/json","application/yaml","application/xml"})
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