com.communote.server.core.user.groups

Class IncrementalUserGroupRetriever

java.lang.Object

com.communote.server.core.user.groups.UserGroupRetriever

com.communote.server.core.user.groups.IncrementalUserGroupRetriever

public class IncrementalUserGroupRetriever
extends UserGroupRetriever

Retriever, which works on repositories which supports incremental data recovery.

Author:

Communote GmbH - http://www.communote.com/

Constructor Summary

Constructors

Constructor and Description
IncrementalUserGroupRetriever(IncrementalRepositoryChangeTracker incrementalRepositoryChangeTracker) Constructor.

Method Summary

Modifier and Type	Method and Description
Collection<ExternalUserGroup>	getNextGroups() Method to get the next groups.
Collection<User>	getNextUsers() Method to get the next users.
boolean	needsToAcceptMembersOfGroups() If this method returns true, the UserGroupSynchronizer has to visit the members of a group explicitly.
void	start() Called, before the synchronizations starts.
void	stop(boolean success) Called, when the synchronization has been finished.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IncrementalUserGroupRetriever

public IncrementalUserGroupRetriever(IncrementalRepositoryChangeTracker incrementalRepositoryChangeTracker)

Constructor.

Parameters:

incrementalRepositoryChangeTracker - The tracker to use.

Method Detail

getNextGroups

public Collection<ExternalUserGroup> getNextGroups()

Method to get the next groups.

Specified by:

getNextGroups in class UserGroupRetriever

Returns:

The list of groups or an empty list, if there are no more groups.

getNextUsers

public Collection<User> getNextUsers()

Method to get the next users.

Specified by:

getNextUsers in class UserGroupRetriever

Returns:

The list of users or an empty list, if there are no more groups.

needsToAcceptMembersOfGroups

public boolean needsToAcceptMembersOfGroups()

If this method returns true, the UserGroupSynchronizer has to visit the members of a group explicitly. This could be useful, if getNextUser doesn't return users, which group membership has changed.

Overrides:

needsToAcceptMembersOfGroups in class UserGroupRetriever

Returns:

IncrementalRepositoryChangeTracker

start

public void start()

Called, before the synchronizations starts.

Specified by:

start in class UserGroupRetriever

stop

public void stop(boolean success)

Called, when the synchronization has been finished.

Specified by:

stop in class UserGroupRetriever

Parameters:

success - If true, the synchronization was successful, else not.