org.cloudfoundry.identity.uaa.scim

Interface ScimGroupMembershipManager

All Superinterfaces:

org.cloudfoundry.identity.uaa.rest.Queryable<ScimGroupMember>

All Known Implementing Classes:

JdbcScimGroupMembershipManager

public interface ScimGroupMembershipManager
extends org.cloudfoundry.identity.uaa.rest.Queryable<ScimGroupMember>

Method Summary

Methods

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

Methods inherited from interface org.cloudfoundry.identity.uaa.rest.Queryable

delete, query, query

Method Detail

addMember

ScimGroupMember addMember(java.lang.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

java.util.List<ScimGroupMember> getMembers(java.lang.String groupId)
                                           throws ScimResourceNotFoundException

Retrieve all members of a group

Parameters:

groupId -

Returns:

Throws:

ScimResourceNotFoundException

getMembers

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

Retrieve members that have the specified authority on the group

Parameters:

groupId -

permission -

Returns:

Throws:

ScimResourceNotFoundException

getGroupsWithMember

java.util.Set<ScimGroup> getGroupsWithMember(java.lang.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(java.lang.String groupId,
                            java.lang.String memberId)
                              throws ScimResourceNotFoundException,
                                     MemberNotFoundException

Retrieve a particular member's membership details

Parameters:

groupId -

memberId -

Returns:

Throws:

ScimResourceNotFoundException

MemberNotFoundException

updateMember

ScimGroupMember updateMember(java.lang.String groupId,
                           ScimGroupMember member)
                             throws ScimResourceNotFoundException,
                                    MemberNotFoundException

Update a particular member's membership details

Parameters:

groupId -

member -

Returns:

Throws:

ScimResourceNotFoundException

MemberNotFoundException

updateOrAddMembers

java.util.List<ScimGroupMember> updateOrAddMembers(java.lang.String groupId,
                                                 java.util.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(java.lang.String groupId,
                               java.lang.String memberId)
                                 throws ScimResourceNotFoundException,
                                        MemberNotFoundException

Revoke membership of a member

Parameters:

groupId -

memberId -

Returns:

Throws:

ScimResourceNotFoundException

MemberNotFoundException

removeMembersByGroupId

java.util.List<ScimGroupMember> removeMembersByGroupId(java.lang.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

java.util.Set<ScimGroup> removeMembersByMemberId(java.lang.String memberId)
                                                 throws ScimResourceNotFoundException

Revoke membership of given member from ALL groups

Parameters:

memberId -

Returns:

Throws:

ScimResourceNotFoundException