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

Interface AnyObjectService

All Superinterfaces:

AnyService<AnyObjectTO>, JAXRSService

@Path(value="anyObjects")
public interface AnyObjectService
extends AnyService<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_MAX, PARAM_NOTIFICATION, PARAM_ORDERBY, PARAM_PAGE, PARAM_REALM, PARAM_RESOURCE, PARAM_SIZE, PARAM_USER

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	create(@NotNull AnyObjectTO anyObjectTO) Creates a new any object.
AnyObjectTO	read(String key) Reads the any object matching the provided key.
PagedResult<AnyObjectTO>	search(AnyQuery anyQuery) Returns a paged list of any objects matching the given query.
javax.ws.rs.core.Response	update(@NotNull AnyObjectPatch anyObjectPatch) Updates any object matching the provided key.
javax.ws.rs.core.Response	update(@NotNull AnyObjectTO anyObjectTO) 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 Detail

read

AnyObjectTO read(String key)

Description copied from interface: AnyService

Reads the any object matching the provided key.

Specified by:

read in interface AnyService<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

search

PagedResult<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<AnyObjectTO>

Parameters:

anyQuery - query conditions

Returns:

paged list of any objects matching the given query

create

@POST
 @Produces(value={"application/json","application/yaml","application/xml"})
 @Consumes(value={"application/json","application/yaml","application/xml"})
javax.ws.rs.core.Response create(@NotNull
                                                                                                                                                                                               @NotNull AnyObjectTO anyObjectTO)

Creates a new any object.

Parameters:

anyObjectTO - any object to be created

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(value="{key}")
 @Produces(value={"application/json","application/yaml","application/xml"})
 @Consumes(value={"application/json","application/yaml","application/xml"})
javax.ws.rs.core.Response update(@NotNull
                                                                                                                                                                                                                      @NotNull AnyObjectPatch anyObjectPatch)

Updates any object matching the provided key.

Parameters:

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

Returns:

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

update

@PUT
 @Path(value="{key}")
 @Produces(value={"application/json","application/yaml","application/xml"})
 @Consumes(value={"application/json","application/yaml","application/xml"})
javax.ws.rs.core.Response update(@NotNull
                                                                                                                                                                                                                    @NotNull AnyObjectTO anyObjectTO)

Updates any object matching the provided key.

Parameters:

anyObjectTO - complete update

Returns:

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