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

Interface GroupService

All Superinterfaces:

AnyService<GroupTO>, JAXRSService

@Path(value="groups")
public interface GroupService
extends AnyService<GroupTO>

REST operations for groups.

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
ExecTO	bulkMembersAction(String key, BulkMembersActionType actionType) (De)provision all members of the given group from / onto all the resources associated to it.
javax.ws.rs.core.Response	create(GroupTO groupTO) Creates a new group.
List<GroupTO>	own() This method allows a user to read his own groups.
GroupTO	read(String key) Reads the any object matching the provided key.
PagedResult<GroupTO>	search(AnyQuery anyQuery) Returns a paged list of any objects matching the given query.
javax.ws.rs.core.Response	update(GroupPatch groupPatch) Updates group matching the provided key.
javax.ws.rs.core.Response	update(GroupTO groupTO) Updates group matching the provided key.

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

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

Method Detail

read

GroupTO read(String key)

Description copied from interface: AnyService

Reads the any object matching the provided key.

Specified by:

read in interface AnyService<GroupTO>

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<GroupTO> 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<GroupTO>

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
                                                                                                                                                                                               GroupTO groupTO)

Creates a new group.

Parameters:

groupTO - group to be created

Returns:

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

update

@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
                                                                                                                                                                                                              GroupPatch groupPatch)

Updates group matching the provided key.

Parameters:

groupPatch - modification to be applied to group matching the provided key

Returns:

Response object featuring the updated group 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
                                                                                                                                                                                                                    GroupTO groupTO)

Updates group matching the provided key.

Parameters:

groupTO - complete update

Returns:

Response object featuring the updated group enriched with propagation status information

own

@GET
 @Path(value="own")
 @Produces(value={"application/json","application/yaml","application/xml"})
List<GroupTO> own()

This method allows a user to read his own groups.

Returns:

own groups

bulkMembersAction

@POST
 @Path(value="{key}/members/{actionType}")
 @Produces(value={"application/json","application/yaml","application/xml"})
ExecTO bulkMembersAction(@NotNull @PathParam(value="key")
                                                                                                                                                      String key,
                                                                                                                                                      @NotNull @PathParam(value="actionType")
                                                                                                                                                      BulkMembersActionType actionType)

(De)provision all members of the given group from / onto all the resources associated to it.

Parameters:

key - group key

actionType - action type to perform on all group members

Returns:

execution report for the task generated on purpose