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

Interface FIQLQueryService

All Superinterfaces:

JAXRSService

All Known Implementing Classes:

FIQLQueryServiceImpl

@Path("fiqlQueries")
public interface FIQLQueryService
extends JAXRSService

REST operations for FIQL queries.

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
Response	create(@NotNull FIQLQueryTO fiqlQueryTO)	Creates a new fiqlQuery.
void	delete(@NotNull String key)	Deletes the FIQL querymatching the provided key.
List<FIQLQueryTO>	list(String target)	Returns a list of all FIQL queries for the calling user, matching the given target if provided.
FIQLQueryTO	read(@NotNull String key)	Returns FIQL querywith matching key.
void	update(@NotNull FIQLQueryTO fiqlQueryTO)	Updates the FIQL querymatching the provided key.

Method Details

list

@GET
@Produces({"application/json","application/yaml","application/xml"})
List<FIQLQueryTO> list(@QueryParam("target")
 String target)

Returns a list of all FIQL queries for the calling user, matching the given target if provided.

Parameters:

target - FIQL query target

Returns:

list of all FIQL queries for the calling user, matching the given target if provided

read

@GET
@Path("{key}")
@Produces({"application/json","application/yaml","application/xml"})
FIQLQueryTO read(@NotNull @PathParam("key")
 @NotNull String key)

Returns FIQL querywith matching key.

Parameters:

key - FIQL querykey to be read

Returns:

FIQL querywith matching key

create

@POST
@Consumes({"application/json","application/yaml","application/xml"})
@Produces({"application/json","application/yaml","application/xml"})
Response create(@NotNull
 @NotNull FIQLQueryTO fiqlQueryTO)

Creates a new fiqlQuery.

Parameters:

fiqlQueryTO - FIQL queryto be created

Returns:

Response object featuring Location header of created fiqlQuery

update

@PUT
@Path("{key}")
@Consumes({"application/json","application/yaml","application/xml"})
@Produces({"application/json","application/yaml","application/xml"})
void update(@NotNull
 @NotNull FIQLQueryTO fiqlQueryTO)

Updates the FIQL querymatching the provided key.

Parameters:

fiqlQueryTO - FIQL queryto be stored

delete

@DELETE
@Path("{key}")
@Produces({"application/json","application/yaml","application/xml"})
void delete(@NotNull @PathParam("key")
 @NotNull String key)

Deletes the FIQL querymatching the provided key.

Parameters:

key - FIQL querykey to be deleted