com.atlassian.crowd.dao.membership

Interface InternalMembershipDao

All Superinterfaces:

MembershipDao

All Known Implementing Classes:

CachingMembershipDao, MembershipDAOHibernate

public interface InternalMembershipDao
extends MembershipDao

Manages persistence of InternalMembership.

Method Summary

Modifier and Type	Method and Description
BatchResult<InternalMembership>	addAll(Set<InternalMembership> memberships) Bulk add of memberships.
default BatchResult<String>	addUserToGroups(long directoryId, String username, Set<String> groupNames) Add many groups to a user
List<InternalMembership>	getMembershipsCreatedAfter(long directoryId, Date timestamp, int maxResults) Retrieves memberships with the creation timestamp greater than the specified date
void	removeAllRelationships(long directoryId) Removes all relationships the the given directory identified by directory id.
void	removeAllUserRelationships(long directoryId) Removes all user relationships the the given directory identified by directory id.
void	removeGroupMembers(long directoryId, String groupName) Removes all members of the given group name.
void	removeGroupMemberships(long directoryId, String groupName) Removes all relationships from parent groups to the given group name.
void	removeUserMemberships(long directoryId, String username) Removes all MembershipType.GROUP_USER relationships from parent groups to the given username.
void	renameGroupRelationships(long directoryId, String oldName, String newName) Renames group name in all relationships.
void	renameUserRelationships(long directoryId, String oldName, String newName) Renames username in all relationships.

Methods inherited from interface com.atlassian.crowd.embedded.spi.MembershipDao

addAllUsersToGroup, addGroupToGroup, addUserToGroup, countDirectMembersOfGroup, isGroupDirectMember, isUserDirectMember, removeGroupFromGroup, removeUserFromGroup, search, searchGroupedByName

Method Detail

removeGroupMembers

void removeGroupMembers(long directoryId,
                        String groupName)

Removes all members of the given group name.

Parameters:

directoryId - Directory id.

groupName - Group name.

removeGroupMemberships

void removeGroupMemberships(long directoryId,
                            String groupName)

Removes all relationships from parent groups to the given group name.

Parameters:

directoryId - Directory id.

groupName - Group name.

removeUserMemberships

void removeUserMemberships(long directoryId,
                           String username)

Removes all MembershipType.GROUP_USER relationships from parent groups to the given username.

Parameters:

directoryId - Directory id.

username - Username.

removeAllRelationships

void removeAllRelationships(long directoryId)

Removes all relationships the the given directory identified by directory id.

Parameters:

directoryId - Directory id.

removeAllUserRelationships

void removeAllUserRelationships(long directoryId)

Removes all user relationships the the given directory identified by directory id.

Parameters:

directoryId - Directory id.

renameUserRelationships

void renameUserRelationships(long directoryId,
                             String oldName,
                             String newName)

Renames username in all relationships.

Parameters:

directoryId - Directory id.

oldName - Old username.

newName - New username.

renameGroupRelationships

void renameGroupRelationships(long directoryId,
                              String oldName,
                              String newName)

Renames group name in all relationships.

Parameters:

directoryId - Directory id.

oldName - Old group name.

newName - New group name.

addAll

BatchResult<InternalMembership> addAll(Set<InternalMembership> memberships)

Bulk add of memberships.

Parameters:

memberships - Set of memberships.

Returns:

Batch result.

getMembershipsCreatedAfter

@ExperimentalSpi
List<InternalMembership> getMembershipsCreatedAfter(long directoryId,
                                                                     Date timestamp,
                                                                     int maxResults)

Retrieves memberships with the creation timestamp greater than the specified date

Parameters:

directoryId - the id of the directory to search

timestamp - the date to limit the search by

maxResults - the maximum number of results to return

Returns:

addUserToGroups

default BatchResult<String> addUserToGroups(long directoryId,
                                            String username,
                                            Set<String> groupNames)
                                     throws UserNotFoundException

Add many groups to a user

This method assumes that groups and user already exist.

Default implementation is not-optimal in respect of number of DB queries. Reference optimal implementation for Hibernate5 is located in crowd-persistance-hibernate5.

Parameters:

directoryId - the id of the directory to which user and groups belong

username - username of the user to whom we add groups

groupNames - names of the group to add to a user. The groups need to exist in the directory

Returns:

result of the bulk operation containing successful and failed entities

Throws:

UserNotFoundException - when user with a given username does not exist in the directory with directoryId id