org.cloudfoundry.identity.uaa.scim
Interface ScimGroupMembershipManager

All Known Implementing Classes:

JdbcScimGroupMembershipManager

public interface ScimGroupMembershipManager

Method Summary

ScimGroupMember	addMember(String groupId, ScimGroupMember member) Add a member to a group
Set<ScimGroup>	getGroupsWithMember(String memberId, boolean transitive) Retrieve all groups that the given member belongs to
ScimGroupMember	getMemberById(String groupId, String memberId) Retrieve a particular member's membership details
List<ScimGroupMember>	getMembers(String groupId) Retrieve all members of a group
List<ScimGroupMember>	getMembers(String groupId, ScimGroupMember.Role permission) Retrieve members that have the specified authority on the group
ScimGroupMember	removeMemberById(String groupId, String memberId) Revoke membership of a member
List<ScimGroupMember>	removeMembersByGroupId(String groupId) Empty the group, i.e revoke the membership of ALL members of a given group
Set<ScimGroup>	removeMembersByMemberId(String memberId) Revoke membership of given member from ALL groups
ScimGroupMember	updateMember(String groupId, ScimGroupMember member) Update a particular member's membership details
List<ScimGroupMember>	updateOrAddMembers(String groupId, List<ScimGroupMember> members) Replace the members of the given group with the supplied member-list

Method Detail

addMember

ScimGroupMember addMember(String groupId,
                          ScimGroupMember member)
                          throws ScimResourceNotFoundException,
                                 MemberAlreadyExistsException

Add a member to a group

Parameters:

groupId - id of a valid group that already exists.

member - membership info for enrolling an existing scim object (user or group) in the group

Returns:

Throws:

ScimResourceNotFoundException

MemberAlreadyExistsException

getMembers

List<ScimGroupMember> getMembers(String groupId)
                                 throws ScimResourceNotFoundException

Retrieve all members of a group

Parameters:

groupId -

Returns:

Throws:

ScimResourceNotFoundException

getMembers

List<ScimGroupMember> getMembers(String groupId,
                                 ScimGroupMember.Role permission)
                                 throws ScimResourceNotFoundException

Retrieve members that have the specified authority on the group

Parameters:

groupId -

permission -

Returns:

Throws:

ScimResourceNotFoundException

getGroupsWithMember

Set<ScimGroup> getGroupsWithMember(String memberId,
                                   boolean transitive)
                                   throws ScimResourceNotFoundException

Retrieve all groups that the given member belongs to

Parameters:

memberId -

transitive - true means indirect/transitive membership is also processed (nested groups)

Returns:

Throws:

ScimResourceNotFoundException

getMemberById

ScimGroupMember getMemberById(String groupId,
                              String memberId)
                              throws ScimResourceNotFoundException,
                                     MemberNotFoundException

Retrieve a particular member's membership details

Parameters:

groupId -

memberId -

Returns:

Throws:

ScimResourceNotFoundException

MemberNotFoundException

updateMember

ScimGroupMember updateMember(String groupId,
                             ScimGroupMember member)
                             throws ScimResourceNotFoundException,
                                    MemberNotFoundException

Update a particular member's membership details

Parameters:

groupId -

member -

Returns:

Throws:

ScimResourceNotFoundException

MemberNotFoundException

updateOrAddMembers

List<ScimGroupMember> updateOrAddMembers(String groupId,
                                         List<ScimGroupMember> members)
                                         throws ScimResourceNotFoundException

Replace the members of the given group with the supplied member-list

Parameters:

groupId -

members -

Returns:

Throws:

ScimResourceNotFoundException

removeMemberById

ScimGroupMember removeMemberById(String groupId,
                                 String memberId)
                                 throws ScimResourceNotFoundException,
                                        MemberNotFoundException

Revoke membership of a member

Parameters:

groupId -

memberId -

Returns:

Throws:

ScimResourceNotFoundException

MemberNotFoundException

removeMembersByGroupId

List<ScimGroupMember> removeMembersByGroupId(String groupId)
                                             throws ScimResourceNotFoundException

Empty the group, i.e revoke the membership of ALL members of a given group

Parameters:

groupId -

Returns:

Throws:

ScimResourceNotFoundException

removeMembersByMemberId

Set<ScimGroup> removeMembersByMemberId(String memberId)
                                       throws ScimResourceNotFoundException

Revoke membership of given member from ALL groups

Parameters:

memberId -

Returns:

Throws:

ScimResourceNotFoundException