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

Class TaskServiceImpl

java.lang.Object

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 and Description
protected static org.slf4j.Logger	LOG
protected org.apache.cxf.jaxrs.ext.MessageContext	messageContext
protected static String	OPTIONS_ALLOW
protected SearchCondVisitor	searchCondVisitor
protected org.apache.cxf.jaxrs.ext.search.SearchContext	searchContext
protected javax.ws.rs.core.UriInfo	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_MAX, PARAM_NOTIFICATION, PARAM_ORDERBY, PARAM_PAGE, PARAM_REALM, PARAM_RESOURCE, PARAM_SIZE, PARAM_USER

Constructor Summary

Constructors

Constructor and Description
TaskServiceImpl()

Method Summary

Modifier and Type	Method and Description
protected javax.ws.rs.core.Response.ResponseBuilder	applyPreference(ProvisioningResult<?> provisioningResult, javax.ws.rs.core.Response.ResponseBuilder builder)
protected <T extends BaseBean> PagedResult<T>	buildPagedResult(List<T> list, int page, int size, int totalCount) Builds a paged result out of a list of items and additional information.
protected void	checkETag(String etag)
javax.ws.rs.core.Response	create(TaskType type, SchedTaskTO taskTO) Creates a new task.
protected javax.ws.rs.core.Response	createResponse(ProvisioningResult<?> provisioningResult) Builds response to successful create request, taking into account any Prefer header.
void	delete(TaskType type, String key) Deletes the task matching the provided key.
protected String	getActualKey(AnyDAO<?> dao, String pretendingKey)
protected AbstractExecutableLogic<?>	getExecutableLogic()
protected List<OrderByClause>	getOrderByClauses(String orderBy)
protected Preference	getPreference() Reads Prefer header from request and parses into a Preference instance.
protected SearchCond	getSearchCond(String fiql, String realm)
protected boolean	isNullPriorityAsync()
protected javax.ws.rs.core.Response	modificationResponse(Object entity) Builds response to successful modification request, taking into account any Prefer header.
javax.ws.rs.core.Response	purgePropagations(Date 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 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

LOG

protected static final org.slf4j.Logger LOG

OPTIONS_ALLOW

protected static final String OPTIONS_ALLOW

See Also:

Constant Field Values

uriInfo

@Context
protected javax.ws.rs.core.UriInfo uriInfo

messageContext

@Context
protected org.apache.cxf.jaxrs.ext.MessageContext messageContext

searchContext

@Context
protected org.apache.cxf.jaxrs.ext.search.SearchContext searchContext

searchCondVisitor

@Autowired
protected SearchCondVisitor searchCondVisitor

Constructor Detail

TaskServiceImpl

public TaskServiceImpl()

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 id

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(Date 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

getActualKey

protected String getActualKey(AnyDAO<?> dao,
                              String pretendingKey)

isNullPriorityAsync

protected boolean isNullPriorityAsync()

getPreference

protected Preference getPreference()

Reads Prefer header from request and parses into a Preference instance.

Returns:

a Preference instance matching the passed Prefer header, or Preference.NONE if missing.

applyPreference

protected javax.ws.rs.core.Response.ResponseBuilder applyPreference(ProvisioningResult<?> provisioningResult,
                                                                    javax.ws.rs.core.Response.ResponseBuilder builder)

createResponse

protected javax.ws.rs.core.Response createResponse(ProvisioningResult<?> provisioningResult)

Builds response to successful create request, taking into account any Prefer header.

Parameters:

provisioningResult - the entity just created

Returns:

response to successful create request

modificationResponse

protected javax.ws.rs.core.Response modificationResponse(Object entity)

Builds response to successful modification request, taking into account any Prefer header.

Parameters:

entity - the entity just modified

Returns:

response to successful modification request

checkETag

protected void checkETag(String etag)

getSearchCond

protected SearchCond getSearchCond(String fiql,
                                   String realm)

getOrderByClauses

protected List<OrderByClause> getOrderByClauses(String orderBy)

buildPagedResult

protected <T extends BaseBean> PagedResult<T> buildPagedResult(List<T> list,
                                                               int page,
                                                               int size,
                                                               int totalCount)

Builds a paged result out of a list of items and additional information.

Type Parameters:

T - result type

Parameters:

list - bare list of items to be returned

page - current page

size - requested size

totalCount - total result size (not considering pagination)

Returns:

paged result