@Path(value="groups") public interface GroupService extends AnyService<GroupTO>
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
Modifier and Type | Method and Description |
---|---|
javax.ws.rs.core.Response |
create(@NotNull GroupTO groupTO)
Creates a new group.
|
List<GroupTO> |
own()
This method allows a user to read his own groups.
|
ExecTO |
provisionMembers(@NotNull String key,
@NotNull ProvisionAction action)
(De)provision all members of the given group from / onto all the resources associated to it.
|
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(@NotNull GroupPatch groupPatch)
Updates group matching the provided key.
|
javax.ws.rs.core.Response |
update(@NotNull GroupTO groupTO)
Updates group matching the provided key.
|
associate, deassociate, delete, delete, read, read, update
GroupTO read(String key)
AnyService
read
in interface AnyService<GroupTO>
key
- if value looks like a UUID then it is interpreted as key, otherwise as a (user)namePagedResult<GroupTO> search(AnyQuery anyQuery)
AnyService
search
in interface AnyService<GroupTO>
anyQuery
- query conditions@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 GroupTO groupTO)
groupTO
- group to be created@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 GroupPatch groupPatch)
groupPatch
- modification to be applied to group matching the provided key@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 GroupTO groupTO)
groupTO
- complete update@GET @Path(value="own") @Produces(value={"application/json","application/yaml","application/xml"}) List<GroupTO> own()
@POST @Path(value="{key}/members/{action}") @Produces(value={"application/json","application/yaml","application/xml"}) ExecTO provisionMembers(@NotNull @PathParam(value="key") @NotNull String key, @NotNull @PathParam(value="action") @NotNull ProvisionAction action)
key
- group keyaction
- action type to perform on all group membersCopyright © 2010–2023 The Apache Software Foundation. All rights reserved.