com.communote.server.core.user.groups

Class UserGroupRetriever

java.lang.Object

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

Direct Known Subclasses:

ExternalUserGroupRetriever, IncrementalUserGroupRetriever

public abstract class UserGroupRetriever
extends Object

Retriever interface for users and groups.

Author:

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

Constructor Summary

Constructors

Constructor and Description
UserGroupRetriever()

Method Summary

Modifier and Type	Method and Description
abstract Collection<ExternalUserGroup>	getNextGroups() Method to get the next groups.
abstract 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.
abstract void	start() Called, before the synchronizations starts.
abstract 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

UserGroupRetriever

public UserGroupRetriever()

Method Detail

getNextGroups

public abstract Collection<ExternalUserGroup> getNextGroups()

Method to get the next groups.

Returns:

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

getNextUsers

public abstract Collection<User> getNextUsers()

Method to get the next users.

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.

Returns:

True, if the synchronizer needs to visit the members of groups explicitly. Default is false.

start

public abstract void start()

Called, before the synchronizations starts.

stop

public abstract void stop(boolean success)

Called, when the synchronization has been finished.

Parameters:

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