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

Class AbstractExecutableService

java.lang.Object

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

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

All Implemented Interfaces:

ExecutableService, JAXRSService

Direct Known Subclasses:

ReportServiceImpl, TaskServiceImpl

public abstract class AbstractExecutableService
extends AbstractService
implements ExecutableService

Field Summary

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
AbstractExecutableService()

Method Summary

Modifier and Type	Method	Description
void	actionJob(String key, JobAction action)	Executes an action on an existing executable's job.
void	deleteExecution(String executionKey)	Deletes the executable execution matching the provided key.
javax.ws.rs.core.Response	deleteExecutions(ExecQuery query)	Deletes the executions matching the given query.
ExecTO	execute(ExecSpecs query)	Executes the executable matching the given specs.
protected abstract AbstractExecutableLogic<?>	getExecutableLogic()
JobTO	getJob(String key)	Returns job (running or scheduled) for the executable matching the given key.
PagedResult<ExecTO>	listExecutions(ExecQuery query)	Returns a paged list of executions matching the given query.
List<JobTO>	listJobs()	List jobs (running and / or scheduled).
List<ExecTO>	listRecentExecutions(int max)	Returns the list of recently completed executions, ordered by end date descendent.

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

Constructor Detail

AbstractExecutableService

public AbstractExecutableService()

Method Detail

getExecutableLogic

protected abstract AbstractExecutableLogic<?> getExecutableLogic()

listExecutions

public PagedResult<ExecTO> listExecutions(ExecQuery query)

Description copied from interface: ExecutableService

Returns a paged list of executions matching the given query.

Specified by:

listExecutions in interface ExecutableService

Parameters:

query - query conditions

Returns:

paged list of executions the given query

listRecentExecutions

public List<ExecTO> listRecentExecutions(int max)

Description copied from interface: ExecutableService

Returns the list of recently completed executions, ordered by end date descendent.

Specified by:

listRecentExecutions in interface ExecutableService

Parameters:

max - the maximum number of executions to return

Returns:

list of recently completed executions, ordered by end date descendent

deleteExecution

public void deleteExecution(String executionKey)

Description copied from interface: ExecutableService

Deletes the executable execution matching the provided key.

Specified by:

deleteExecution in interface ExecutableService

Parameters:

executionKey - key of executable execution to be deleted

deleteExecutions

public javax.ws.rs.core.Response deleteExecutions(ExecQuery query)

Description copied from interface: ExecutableService

Deletes the executions matching the given query.

Specified by:

deleteExecutions in interface ExecutableService

Parameters:

query - query conditions

Returns:

batch results as Response entity

execute

public ExecTO execute(ExecSpecs query)

Description copied from interface: ExecutableService

Executes the executable matching the given specs.

Specified by:

execute in interface ExecutableService

Parameters:

query - conditions to exec

Returns:

execution report for the executable matching the given specs

getJob

public JobTO getJob(String key)

Description copied from interface: ExecutableService

Returns job (running or scheduled) for the executable matching the given key.

Specified by:

getJob in interface ExecutableService

Parameters:

key - executable key

Returns:

job (running or scheduled) for the given key

listJobs

public List<JobTO> listJobs()

Description copied from interface: ExecutableService

List jobs (running and / or scheduled).

Specified by:

listJobs in interface ExecutableService

Returns:

jobs (running and / or scheduled)

actionJob

public void actionJob(String key,
                      JobAction action)

Description copied from interface: ExecutableService

Executes an action on an existing executable's job.

Specified by:

actionJob in interface ExecutableService

Parameters:

key - executable key

action - action to execute