Package org.apache.syncope.common.rest.api.service

Interface AnyObjectService

All Superinterfaces:

AnyService<org.apache.syncope.common.lib.to.AnyObjectTO>, JAXRSService

@Path("anyObjects")
public interface AnyObjectService
extends AnyService<org.apache.syncope.common.lib.to.AnyObjectTO>

REST operations for anyObjects.

Field Summary

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

Method Summary

Modifier and Type	Method	Description
jakarta.ws.rs.core.Response	create(@NotNull org.apache.syncope.common.lib.request.AnyObjectCR createReq)	Creates a new any object.
org.apache.syncope.common.lib.to.AnyObjectTO	read(@NotNull String type, @NotNull String name)
org.apache.syncope.common.lib.to.AnyObjectTO	read(String key)	Reads the any object matching the provided key.
org.apache.syncope.common.lib.to.PagedResult<org.apache.syncope.common.lib.to.AnyObjectTO>	search(AnyQuery anyQuery)	Returns a paged list of any objects matching the given query.
jakarta.ws.rs.core.Response	update(@NotNull org.apache.syncope.common.lib.request.AnyObjectUR updateReq)	Updates any object matching the provided key.

Methods inherited from interface org.apache.syncope.common.rest.api.service.AnyService

associate, deassociate, delete, delete, read, read, update

Method Details

read

org.apache.syncope.common.lib.to.AnyObjectTO read(String key)

Description copied from interface: AnyService

Reads the any object matching the provided key.

Specified by:

read in interface AnyService<org.apache.syncope.common.lib.to.AnyObjectTO>

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

read

@GET
@Path("byName/{type}/{name}")
@Produces({"application/json","application/yaml","application/xml"})
org.apache.syncope.common.lib.to.AnyObjectTO read(@NotNull @PathParam("type")
 @NotNull String type,
 @NotNull @PathParam("name")
 @NotNull String name)

search

org.apache.syncope.common.lib.to.PagedResult<org.apache.syncope.common.lib.to.AnyObjectTO> 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<org.apache.syncope.common.lib.to.AnyObjectTO>

Parameters:

anyQuery - query conditions

Returns:

paged list of any objects matching the given query

create

@POST
@Produces({"application/json","application/yaml","application/xml"})
@Consumes({"application/json","application/yaml","application/xml"})
jakarta.ws.rs.core.Response create(@NotNull
 @NotNull org.apache.syncope.common.lib.request.AnyObjectCR createReq)

Creates a new any object.

Parameters:

createReq - any object create request

Returns:

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

update

@PATCH
@Path("{key}")
@Produces({"application/json","application/yaml","application/xml"})
@Consumes({"application/json","application/yaml","application/xml"})
jakarta.ws.rs.core.Response update(@NotNull
 @NotNull org.apache.syncope.common.lib.request.AnyObjectUR updateReq)

Updates any object matching the provided key.

Parameters:

updateReq - modification to be applied to any object matching the provided key

Returns:

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