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

Class RemediationServiceImpl

java.lang.Object

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

All Implemented Interfaces:

JAXRSService, RemediationService

@Service
public class RemediationServiceImpl
extends Object
implements RemediationService

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

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)
protected javax.ws.rs.core.Response	createResponse(ProvisioningResult<?> provisioningResult) Builds response to successful create request, taking into account any Prefer header.
javax.ws.rs.core.Response	delete(String key) Deletes the remediation matching the given key.
protected String	getActualKey(AnyDAO<?> dao, String pretendingKey)
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<RemediationTO>	list(RemediationQuery query) Returns a list of all remediations.
protected javax.ws.rs.core.Response	modificationResponse(Object entity) Builds response to successful modification request, taking into account any Prefer header.
RemediationTO	read(String key) Returns remediation with matching key.
javax.ws.rs.core.Response	remedy(String remediationKey, AnyPatch anyPatch) Perform remediation by updating the provided user, group or any object.
javax.ws.rs.core.Response	remedy(String remediationKey, AnyTO anyTO) Perform remediation by creating the provided user, group or any object.
javax.ws.rs.core.Response	remedy(String remediationKey, String anyKey) Perform remediation by deleting the provided user, group or any object.

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

RemediationServiceImpl

public RemediationServiceImpl()

Method Detail

list

public PagedResult<RemediationTO> list(RemediationQuery query)

Description copied from interface: RemediationService

Returns a list of all remediations.

Specified by:

list in interface RemediationService

Parameters:

query - query conditions

Returns:

list of all remediations.

read

public RemediationTO read(String key)

Description copied from interface: RemediationService

Returns remediation with matching key.

Specified by:

read in interface RemediationService

Parameters:

key - key of remediation to be read

Returns:

remediation with matching key

delete

public javax.ws.rs.core.Response delete(String key)

Description copied from interface: RemediationService

Deletes the remediation matching the given key.

Specified by:

delete in interface RemediationService

Parameters:

key - key for remediation to be deleted

Returns:

an empty response if operation was successful

remedy

public javax.ws.rs.core.Response remedy(String remediationKey,
                                        AnyTO anyTO)

Description copied from interface: RemediationService

Perform remediation by creating the provided user, group or any object.

Specified by:

remedy in interface RemediationService

Parameters:

remediationKey - key for remediation to act on

anyTO - user, group or any object to create

Returns:

Response object featuring Location header of created object as well as the object itself enriched with propagation status information

remedy

public javax.ws.rs.core.Response remedy(String remediationKey,
                                        AnyPatch anyPatch)

Description copied from interface: RemediationService

Perform remediation by updating the provided user, group or any object.

Specified by:

remedy in interface RemediationService

Parameters:

remediationKey - key for remediation to act on

anyPatch - user, group or any object to update

Returns:

Response object featuring the updated object enriched with propagation status information

remedy

public javax.ws.rs.core.Response remedy(String remediationKey,
                                        String anyKey)

Description copied from interface: RemediationService

Perform remediation by deleting the provided user, group or any object.

Specified by:

remedy in interface RemediationService

Parameters:

remediationKey - key for remediation to act on

anyKey - user's, group's or any object's key to delete

Returns:

Response object featuring the deleted object 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