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

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	associate(@NotNull AssociationPatch patch) Executes resource-related operations on given entity.
javax.ws.rs.core.Response	deassociate(@NotNull DeassociationPatch patch) Executes resource-related operations on given entity.
javax.ws.rs.core.Response	delete(@NotNull String key) Deletes any object matching provided key.
void	delete(@NotNull String key, @NotNull SchemaType schemaType, @NotNull String schema) Deletes the attribute, owned by the given any object, for the given schema type and schema.
TO	read(@NotNull String key) Reads the any object matching the provided key.
Set<AttrTO>	read(@NotNull String key, @NotNull SchemaType schemaType) Reads the list of attributes owned by the given any object for the given schema type.
AttrTO	read(@NotNull String key, @NotNull SchemaType schemaType, @NotNull 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(@NotNull String key, @NotNull SchemaType schemaType, @NotNull 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/yaml","application/xml"})
Set<AttrTO> read(@NotNull @PathParam(value="key")
                                                                                                                                     @NotNull String key,
                                                                                                                                     @NotNull @PathParam(value="schemaType")
                                                                                                                                     @NotNull 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/yaml","application/xml"})
AttrTO read(@NotNull @PathParam(value="key")
                                                                                                                                         @NotNull String key,
                                                                                                                                         @NotNull @PathParam(value="schemaType")
                                                                                                                                         @NotNull SchemaType schemaType,
                                                                                                                                         @NotNull @PathParam(value="schema")
                                                                                                                                         @NotNull 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/yaml","application/xml"})
TO read(@NotNull @PathParam(value="key")
                                                                                                               @NotNull 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/yaml","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/yaml","application/xml"})
 @Consumes(value={"application/json","application/yaml","application/xml"})
javax.ws.rs.core.Response update(@NotNull @PathParam(value="key")
                                                                                                                                                                                                                                          @NotNull String key,
                                                                                                                                                                                                                                          @NotNull @PathParam(value="schemaType")
                                                                                                                                                                                                                                          @NotNull SchemaType schemaType,
                                                                                                                                                                                                                                          @NotNull
                                                                                                                                                                                                                                          @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/yaml","application/xml"})
void delete(@NotNull @PathParam(value="key")
                                                                                                                                            @NotNull String key,
                                                                                                                                            @NotNull @PathParam(value="schemaType")
                                                                                                                                            @NotNull SchemaType schemaType,
                                                                                                                                            @NotNull @PathParam(value="schema")
                                                                                                                                            @NotNull 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/yaml","application/xml"})
javax.ws.rs.core.Response delete(@NotNull @PathParam(value="key")
                                                                                                                                           @NotNull 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}")
 @Consumes(value={"application/json","application/yaml","application/xml"})
 @Produces(value="multipart/mixed")
javax.ws.rs.core.Response deassociate(@NotNull
                                                                                                                                                                                                       @NotNull DeassociationPatch patch)

Executes resource-related operations on given entity.

Parameters:

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

Returns:

batch results as Response entity

associate

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

Executes resource-related operations on given entity.

Parameters:

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

Returns:

batch results as Response entity