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

Class AbstractAnyService<TO extends AnyTO,P extends AnyPatch>

java.lang.Object

org.apache.syncope.core.rest.cxf.service.AbstractAnyService<TO,P>

All Implemented Interfaces:

AnyService<TO>, JAXRSService

Direct Known Subclasses:

AnyObjectServiceImpl, GroupServiceImpl, UserServiceImpl

public abstract class AbstractAnyService<TO extends AnyTO,P extends AnyPatch>
extends Object
implements AnyService<TO>

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

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)
javax.ws.rs.core.Response	associate(AssociationPatch patch) Executes resource-related operations on given entity.
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	deassociate(DeassociationPatch patch) Executes resource-related operations on given entity.
javax.ws.rs.core.Response	delete(String key) Deletes any object matching provided key.
void	delete(String key, SchemaType schemaType, String schema) Deletes the attribute, owned by the given any object, for the given schema type and schema.
protected javax.ws.rs.core.Response	doUpdate(P anyPatch)
protected Date	findLastChange(String key)
protected String	getActualKey(AnyDAO<?> dao, String pretendingKey)
protected abstract AnyDAO<?>	getAnyDAO()
protected abstract AbstractAnyLogic<TO,P>	getAnyLogic()
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.
protected abstract P	newPatch(String key)
TO	read(String key) Reads the any object matching the provided key.
Set<AttrTO>	read(String key, SchemaType schemaType) Reads the list of attributes owned by the given any object for the given schema type.
AttrTO	read(String key, SchemaType schemaType, String schema) Reads the attribute, owned by the given any object, for the given schema type and schema.
PagedResult<TO>	search(AnyQuery anyQuery) Returns a paged list of any objects matching the given query.
javax.ws.rs.core.Response	update(String key, SchemaType schemaType, AttrTO attrTO) Adds or replaces the attribute, owned by the given any object, for the given schema type and schema.

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

AbstractAnyService

public AbstractAnyService()

Method Detail

getAnyDAO

protected abstract AnyDAO<?> getAnyDAO()

getAnyLogic

protected abstract AbstractAnyLogic<TO,P> getAnyLogic()

newPatch

protected abstract P newPatch(String key)

read

public Set<AttrTO> read(String key,
                        SchemaType schemaType)

Description copied from interface: AnyService

Reads the list of attributes owned by the given any object for the given schema type. Note that for the UserService, GroupService and AnyObjectService subclasses, if the key parameter looks like a UUID then it is interpreted as as key, otherwise as a (user)name.

Specified by:

read in interface AnyService<TO extends AnyTO>

Parameters:

key - any object key or name

schemaType - schema type

Returns:

list of attributes, owned by the given any object, for the given schema type

read

public AttrTO read(String key,
                   SchemaType schemaType,
                   String schema)

Description copied from interface: AnyService

Reads the attribute, owned by the given any object, for the given schema type and schema. Note that for the UserService, GroupService and AnyObjectService subclasses, if the key parameter looks like a UUID then it is interpreted as as key, otherwise as a (user)name.

Specified by:

read in interface AnyService<TO extends AnyTO>

Parameters:

key - any object key or name

schemaType - schema type

schema - schema

Returns:

attribute, owned by the given any object, for the given schema type and schema

read

public TO read(String key)

Description copied from interface: AnyService

Reads the any object matching the provided key.

Specified by:

read in interface AnyService<TO extends AnyTO>

Parameters:

key - if value looks like a UUID then it is interpreted as key, otherwise as a (user)name

Returns:

any object with matching key

search

public PagedResult<TO> search(AnyQuery anyQuery)

Description copied from interface: AnyService

Returns a paged list of any objects matching the given query.

Specified by:

search in interface AnyService<TO extends AnyTO>

Parameters:

anyQuery - query conditions

Returns:

paged list of any objects matching the given query

findLastChange

protected Date findLastChange(String key)

doUpdate

protected javax.ws.rs.core.Response doUpdate(P anyPatch)

update

public javax.ws.rs.core.Response update(String key,
                                        SchemaType schemaType,
                                        AttrTO attrTO)

Description copied from interface: AnyService

Adds or replaces the attribute, owned by the given any object, for the given schema type and schema.

Specified by:

update in interface AnyService<TO extends AnyTO>

Parameters:

key - any object key or name

schemaType - schema type

attrTO - attribute

Returns:

Response object featuring the updated any object attribute - as Entity

delete

public void delete(String key,
                   SchemaType schemaType,
                   String schema)

Description copied from interface: AnyService

Deletes the attribute, owned by the given any object, for the given schema type and schema.

Specified by:

delete in interface AnyService<TO extends AnyTO>

Parameters:

key - any object key or name

schemaType - schema type

schema - schema

delete

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

Description copied from interface: AnyService

Deletes any object matching provided key.

Specified by:

delete in interface AnyService<TO extends AnyTO>

Parameters:

key - any object key or name

Returns:

Response object featuring the deleted any object enriched with propagation status information

deassociate

public javax.ws.rs.core.Response deassociate(DeassociationPatch patch)

Description copied from interface: AnyService

Executes resource-related operations on given entity.

Specified by:

deassociate in interface AnyService<TO extends AnyTO>

Parameters:

patch - external resources to be used for propagation-related operations

Returns:

batch results as Response entity

associate

public javax.ws.rs.core.Response associate(AssociationPatch patch)

Description copied from interface: AnyService

Executes resource-related operations on given entity.

Specified by:

associate in interface AnyService<TO extends AnyTO>

Parameters:

patch - external resources to be used for propagation-related operations

Returns:

batch results as Response entity

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