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

Interface AnyService<TO extends AnyTO>

All Superinterfaces:

JAXRSService

All Known Subinterfaces:

AnyObjectService, GroupService, UserService

public interface AnyService<TO extends AnyTO>
extends JAXRSService

Field Summary

Fields inherited from interface org.apache.syncope.common.rest.api.service.JAXRSService

PARAM_ANYTYPE_KIND, PARAM_CONNID_PAGED_RESULTS_COOKIE, PARAM_DETAILS, PARAM_ENTITY_KEY, PARAM_FIQL, PARAM_MAX, PARAM_NOTIFICATION, PARAM_ORDERBY, PARAM_PAGE, PARAM_RESOURCE, PARAM_SIZE

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	associate(AssociationPatch patch) Executes resource-related operations on given any object.
javax.ws.rs.core.Response	bulk(BulkAction bulkAction) Executes the provided bulk action.
javax.ws.rs.core.Response	deassociate(DeassociationPatch patch) Executes resource-related operations on given any object.
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.
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.

Method Detail

read

@GET
 @Path(value="{key}/{schemaType}")
 @Produces(value={"application/json","application/xml"})
Set<AttrTO> read(@NotNull @PathParam(value="key")
                                                                                                                  String key,
                                                                                                                  @NotNull @PathParam(value="schemaType")
                                                                                                                  SchemaType schemaType)

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.

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

@GET
 @Path(value="{key}/{schemaType}/{schema}")
 @Produces(value={"application/json","application/xml"})
AttrTO read(@NotNull @PathParam(value="key")
                                                                                                                      String key,
                                                                                                                      @NotNull @PathParam(value="schemaType")
                                                                                                                      SchemaType schemaType,
                                                                                                                      @NotNull @PathParam(value="schema")
                                                                                                                      String schema)

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.

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

@GET
 @Path(value="{key}")
 @Produces(value={"application/json","application/xml"})
TO read(@NotNull @PathParam(value="key")
                                                                                            String key)

Reads the any object matching the provided key.

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

@GET
 @Produces(value={"application/json","application/xml"})
PagedResult<TO> search(@BeanParam
                                                                                     AnyQuery anyQuery)

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

Parameters:

anyQuery - query conditions

Returns:

paged list of any objects matching the given query

update

@PUT
 @Path(value="{key}/{schemaType}/{schema}")
 @Produces(value={"application/json","application/xml"})
 @Consumes(value={"application/json","application/xml"})
javax.ws.rs.core.Response update(@NotNull @PathParam(value="key")
                                                                                                                                                                                                    String key,
                                                                                                                                                                                                    @NotNull @PathParam(value="schemaType")
                                                                                                                                                                                                    SchemaType schemaType,
                                                                                                                                                                                                    @NotNull
                                                                                                                                                                                                    AttrTO attrTO)

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

Parameters:

key - any object key or name

schemaType - schema type

attrTO - attribute

Returns:

Response object featuring the updated any object attribute - as Entity

delete

@DELETE
 @Path(value="{key}/{schemaType}/{schema}")
 @Produces(value={"application/json","application/xml"})
void delete(@NotNull @PathParam(value="key")
                                                                                                                         String key,
                                                                                                                         @NotNull @PathParam(value="schemaType")
                                                                                                                         SchemaType schemaType,
                                                                                                                         @NotNull @PathParam(value="schema")
                                                                                                                         String schema)

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

Parameters:

key - any object key or name

schemaType - schema type

schema - schema

delete

@DELETE
 @Path(value="{key}")
 @Produces(value={"application/json","application/xml"})
javax.ws.rs.core.Response delete(@NotNull @PathParam(value="key")
                                                                                                                        String key)

Deletes any object matching provided key.

Parameters:

key - any object key or name

Returns:

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

deassociate

@POST
 @Path(value="{key}/deassociate/{action}")
 @Produces(value={"application/json","application/xml"})
 @Consumes(value={"application/json","application/xml"})
javax.ws.rs.core.Response deassociate(@NotNull
                                                                                                                                                                                                         DeassociationPatch patch)

Executes resource-related operations on given any object.

Parameters:

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

Returns:

Response object featuring BulkActionResult as Entity

associate

@POST
 @Path(value="{key}/associate/{action}")
 @Produces(value={"application/json","application/xml"})
 @Consumes(value={"application/json","application/xml"})
javax.ws.rs.core.Response associate(@NotNull
                                                                                                                                                                                                     AssociationPatch patch)

Executes resource-related operations on given any object.

Parameters:

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

Returns:

Response object featuring BulkActionResult as Entity

bulk

@POST
 @Path(value="bulk")
 @Produces(value={"application/json","application/xml"})
 @Consumes(value={"application/json","application/xml"})
javax.ws.rs.core.Response bulk(@NotNull
                                                                                                                                                                            BulkAction bulkAction)

Executes the provided bulk action.

Parameters:

bulkAction - list of any object ids against which the bulk action will be performed.

Returns:

Response object featuring BulkActionResult as Entity