Package org.apache.syncope.core.rest.cxf.service

Class TaskServiceImpl

java.lang.Object

org.apache.syncope.core.rest.cxf.service.AbstractService

org.apache.syncope.core.rest.cxf.service.AbstractExecutableService

org.apache.syncope.core.rest.cxf.service.TaskServiceImpl

All Implemented Interfaces:

ExecutableService, JAXRSService, TaskService

@Service
public class TaskServiceImpl
extends AbstractExecutableService
implements TaskService

Field Summary

Fields

Modifier and Type	Field	Description
protected TaskLogic	logic

Fields inherited from class org.apache.syncope.core.rest.cxf.service.AbstractService

LOG, messageContext, OPTIONS_ALLOW, searchContext, uriInfo

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

CRLF, DOUBLE_DASH, PARAM_ANYTYPE_KIND, PARAM_ANYTYPEKEY, PARAM_CONNID_PAGED_RESULTS_COOKIE, PARAM_DETAILS, PARAM_ENTITY_KEY, PARAM_FIQL, PARAM_KEYWORD, PARAM_MAX, PARAM_NOTIFICATION, PARAM_ORDERBY, PARAM_PAGE, PARAM_REALM, PARAM_RECURSIVE, PARAM_RESOURCE, PARAM_SIZE, PARAM_USER

Constructor Summary

Constructors

Constructor	Description
TaskServiceImpl(TaskLogic logic)

Method Summary

Modifier and Type	Method	Description
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.
ExecTO	execute(ExecSpecs specs, SyncopeForm macroTaskForm)	Executes the macro task matching the given specs, with the provided form as input.
protected AbstractExecutableLogic<?>	getExecutableLogic()
SyncopeForm	getMacroTaskForm(String key, String locale)	Fetches the form to fill and submit for execution, for the given macro task (if defined).
javax.ws.rs.core.Response	purgePropagations(OffsetDateTime since, List<ExecStatus> statuses, List<String> resources)	Deletes all the propagation tasks whose latest execution is matching the given conditions.
<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 class org.apache.syncope.core.rest.cxf.service.AbstractExecutableService

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

Methods inherited from class org.apache.syncope.core.rest.cxf.service.AbstractService

applyPreference, buildPagedResult, checkETag, createResponse, findActualKey, getOrderByClauses, getPreference, isNullPriorityAsync, modificationResponse

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

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

Field Detail

logic

protected final TaskLogic logic

Constructor Detail

TaskServiceImpl

public TaskServiceImpl(TaskLogic logic)

Method Detail

getExecutableLogic

protected AbstractExecutableLogic<?> getExecutableLogic()

Specified by:

getExecutableLogic in class AbstractExecutableService

create

public javax.ws.rs.core.Response create(TaskType type,
                                        SchedTaskTO taskTO)

Description copied from interface: TaskService

Creates a new task.

Specified by:

create in interface TaskService

Parameters:

type - task type

taskTO - task to be created

Returns:

Response object featuring Location header of created task

delete

public void delete(TaskType type,
                   String key)

Description copied from interface: TaskService

Deletes the task matching the provided key.

Specified by:

delete in interface TaskService

Parameters:

type - task type

key - key of task to be deleted

search

public <T extends TaskTO> PagedResult<T> search(TaskQuery query)

Description copied from interface: TaskService

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

Specified by:

search in interface TaskService

Type Parameters:

T - type of taskTO

Parameters:

query - query conditions

Returns:

paged list of existing tasks matching the given query

read

public <T extends TaskTO> T read(TaskType type,
                                 String key,
                                 boolean details)

Description copied from interface: TaskService

Returns the task matching the given key.

Specified by:

read in interface TaskService

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 key

update

public void update(TaskType type,
                   SchedTaskTO taskTO)

Description copied from interface: TaskService

Updates the task matching the provided key.

Specified by:

update in interface TaskService

Parameters:

type - task type

taskTO - updated task to be stored

purgePropagations

public javax.ws.rs.core.Response purgePropagations(OffsetDateTime since,
                                                   List<ExecStatus> statuses,
                                                   List<String> resources)

Description copied from interface: TaskService

Deletes all the propagation tasks whose latest execution is matching the given conditions. At least one matching condition must be specified.

Specified by:

purgePropagations in interface TaskService

Parameters:

since - match all executions started afterwards

statuses - execution status(es) to match

resources - external resource(s) to match

Returns:

deleted propagation tasks

getMacroTaskForm

public SyncopeForm getMacroTaskForm(String key,
                                    String locale)

Description copied from interface: TaskService

Fetches the form to fill and submit for execution, for the given macro task (if defined).

Specified by:

getMacroTaskForm in interface TaskService

Parameters:

key - macro task key

locale - form locale

Returns:

the form to fill and submit for execution, for the given macro task (if defined)

execute

public ExecTO execute(ExecSpecs specs,
                      SyncopeForm macroTaskForm)

Description copied from interface: TaskService

Executes the macro task matching the given specs, with the provided form as input.

Specified by:

execute in interface TaskService

Parameters:

specs - conditions to exec

macroTaskForm - macro task form

Returns:

execution report for the macro task matching the given specs