com.sap.scimono.callback.groups

Interface GroupsCallback

All Known Implementing Classes:

DefaultGroupsCallback

public interface GroupsCallback

Method Summary

Modifier and Type	Method and Description
Group	createGroup(Group group) Creates a group with the provided attributes.
void	deleteGroup(String groupId) Deletes the group with the specified groupId.
Optional<String>	generateId() Generates a group id for a new group
Group	getGroup(String groupId)
default Group	getGroup(String groupId, RequestedResourceAttributes additionalAttributes)
PagedResult<Group>	getGroups(PageInfo pageInfo, String filter) Returns a page of groups (limited by SCIMConfigurationCallback.getMaxResourcesPerPage()), taking into account the specified filter and paging parameters.
default PagedResult<Group>	getGroups(PageInfo pageInfo, String filter, RequestedResourceAttributes additionalAttributes) Returns a page of groups (more info in getGroups(PageInfo, String) ()} adding specifying additional attributes to be returned of excluded from the response
void	patchGroup(String groupId, PatchBody patchBody, Meta groupMeta) Updates a group with the provided attributes.
Group	updateGroup(Group group) Updates a group with the provided attributes.

Method Detail

getGroup

Group getGroup(String groupId)

Parameters:

groupId, - unique group id

Returns:

the group with the specified groupId or null if no such group exists

getGroup

default Group getGroup(String groupId,
                       RequestedResourceAttributes additionalAttributes)

getGroups

PagedResult<Group> getGroups(PageInfo pageInfo,
                             String filter)

Returns a page of groups (limited by SCIMConfigurationCallback.getMaxResourcesPerPage()), taking into account the specified filter and paging parameters.

Parameters:

pageInfo - parsed paging parameters from the API request

filter - unparsed filter string from the $filter query parameter

Returns:

a page of groups or empty page if no groups match the filter/paging criteria

getGroups

default PagedResult<Group> getGroups(PageInfo pageInfo,
                                     String filter,
                                     RequestedResourceAttributes additionalAttributes)

Returns a page of groups (more info in getGroups(PageInfo, String) ()} adding specifying additional attributes to be returned of excluded from the response

Parameters:

additionalAttributes - additional attributes to be returned of excluded from the response

Returns:

a page of groups or empty page if no groups match the filter/paging criteria

createGroup

Group createGroup(Group group)

Creates a group with the provided attributes. The group object must have all mandatory attributes available, including metadata (version, etc.). The returned group must have its id set.

Parameters:

group -

updateGroup

Group updateGroup(Group group)

Updates a group with the provided attributes. The group object must have all mandatory attributes available, including metadata (id, new version, etc.).

Parameters:

group -

patchGroup

void patchGroup(String groupId,
                PatchBody patchBody,
                Meta groupMeta)

Updates a group with the provided attributes. The group object must have all mandatory attributes available, including metadata (id, new version, etc.).

Parameters:

groupId -

patchBody -

groupMeta -

deleteGroup

void deleteGroup(String groupId)

Deletes the group with the specified groupId.

Parameters:

groupId -

generateId

Optional<String> generateId()

Generates a group id for a new group

Returns:

a unique group idnetifier