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

Class UserRequestServiceImpl

java.lang.Object

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

All Implemented Interfaces:

JAXRSService, UserRequestService

@Service
public class UserRequestServiceImpl
extends Object
implements UserRequestService

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

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.
void	cancelRequest(String executionId, String reason) Cancel a running user request.
protected void	checkETag(String etag)
UserRequestForm	claimForm(String taskId) Requests to manage the form for the given task id.
protected javax.ws.rs.core.Response	createResponse(ProvisioningResult<?> provisioningResult) Builds response to successful create request, taking into account any Prefer header.
protected String	getActualKey(AnyDAO<?> dao, String pretendingKey)
UserRequestForm	getForm(String username, String taskId) Returns a user request form matching the given task id.
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<UserRequestForm>	listForms(UserRequestQuery query) Returns a list of user request forms matching the given query.
PagedResult<UserRequest>	listRequests(UserRequestQuery query) Returns a list of running user requests matching the given query.
protected javax.ws.rs.core.Response	modificationResponse(Object entity) Builds response to successful modification request, taking into account any Prefer header.
UserRequest	startRequest(String bpmnProcess, String user, WorkflowTaskExecInput inputVariables) Starts a new request for the given BPMN Process and user (if provided) or requesting user (if not provided).
javax.ws.rs.core.Response	submitForm(UserRequestForm form) Submits a user request form.
UserRequestForm	unclaimForm(String taskId) Cancels request to manage the form for the given task id.

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

UserRequestServiceImpl

public UserRequestServiceImpl()

Method Detail

listRequests

public PagedResult<UserRequest> listRequests(UserRequestQuery query)

Description copied from interface: UserRequestService

Returns a list of running user requests matching the given query.

Specified by:

listRequests in interface UserRequestService

Parameters:

query - query conditions

Returns:

list of all running user requests

startRequest

public UserRequest startRequest(String bpmnProcess,
                                String user,
                                WorkflowTaskExecInput inputVariables)

Description copied from interface: UserRequestService

Starts a new request for the given BPMN Process and user (if provided) or requesting user (if not provided).

Specified by:

startRequest in interface UserRequestService

Parameters:

bpmnProcess - BPMN process

user - if value looks like a UUID then it is interpreted as key otherwise as a username

inputVariables - initial request variables

Returns:

data about the started request service, including execution id

cancelRequest

public void cancelRequest(String executionId,
                          String reason)

Description copied from interface: UserRequestService

Cancel a running user request.

Specified by:

cancelRequest in interface UserRequestService

Parameters:

executionId - execution id

reason - reason to cancel the user request

claimForm

public UserRequestForm claimForm(String taskId)

Description copied from interface: UserRequestService

Requests to manage the form for the given task id.

Specified by:

claimForm in interface UserRequestService

Parameters:

taskId - workflow task id

Returns:

the form for the given task id

unclaimForm

public UserRequestForm unclaimForm(String taskId)

Description copied from interface: UserRequestService

Cancels request to manage the form for the given task id.

Specified by:

unclaimForm in interface UserRequestService

Parameters:

taskId - workflow task id

Returns:

the workflow form for the given task id

getForm

public UserRequestForm getForm(String username,
                               String taskId)

Description copied from interface: UserRequestService

Returns a user request form matching the given task id.

Specified by:

getForm in interface UserRequestService

Parameters:

username - username of the logged user

taskId - workflow task id

Returns:

the form for the given task id

listForms

public PagedResult<UserRequestForm> listForms(UserRequestQuery query)

Description copied from interface: UserRequestService

Returns a list of user request forms matching the given query.

Specified by:

listForms in interface UserRequestService

Parameters:

query - query conditions

Returns:

list of all available user request forms

submitForm

public javax.ws.rs.core.Response submitForm(UserRequestForm form)

Description copied from interface: UserRequestService

Submits a user request form.

Specified by:

submitForm in interface UserRequestService

Parameters:

form - user request form.

Returns:

Response object featuring the updated user enriched with propagation status information

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