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

Class AbstractExecutableService

java.lang.Object

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

All Implemented Interfaces:

ExecutableService, JAXRSService

Direct Known Subclasses:

ReportServiceImpl, TaskServiceImpl

public abstract class AbstractExecutableService
extends Object
implements ExecutableService

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

Method Summary

Modifier and Type	Method and Description
void	actionJob(String key, JobAction action) Executes an action on an existing executable's job.
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)
protected javax.ws.rs.core.Response	createResponse(ProvisioningResult<?> provisioningResult) Builds response to successful create request, taking into account any Prefer header.
void	deleteExecution(String executionKey) Deletes the executable execution matching the provided key.
javax.ws.rs.core.Response	deleteExecutions(ExecQuery query) Deletes the executions belonging matching the given query.
ExecTO	execute(ExecSpecs query) Executes the executable matching the given query.
protected String	getActualKey(AnyDAO<?> dao, String pretendingKey)
protected abstract AbstractExecutableLogic<?>	getExecutableLogic()
JobTO	getJob(String key) Returns job (running or scheduled) for the executable matching the given key.
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()
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.
protected javax.ws.rs.core.Response	modificationResponse(Object entity) Builds response to successful modification request, taking into account any Prefer header.

Methods inherited from class java.lang.Object

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

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

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 belonging 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 query.

Specified by:

execute in interface ExecutableService

Parameters:

query - query conditions

Returns:

execution report for the executable matching the given query

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

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