com.communote.plugin.ldap

Class ADTrackingIncrementalRepositoryChangeTracker

java.lang.Object

com.communote.plugin.ldap.ADTrackingIncrementalRepositoryChangeTracker

All Implemented Interfaces:

PropertyKeys, IncrementalRepositoryChangeTracker

public class ADTrackingIncrementalRepositoryChangeTracker
extends Object
implements IncrementalRepositoryChangeTracker, PropertyKeys

Tracker for active directory.

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROPERTY_KEY_AD_LAST_USED_SERVER Key for storing the last used server url of this tracker.

Fields inherited from interface com.communote.plugin.ldap.PropertyKeys

PROPERTY_KEY_ACTIVE_DIRECTORY_TRACKING_ALLOW_PAGING, PROPERTY_KEY_ACTIVE_DIRECTORY_TRACKING_ENABLED_GROUP, PROPERTY_KEY_ACTIVE_DIRECTORY_TRACKING_ENABLED_USER, PROPERTY_KEY_ACTIVE_DIRECTORY_TRACKING_PAGING_SIZE, PROPERTY_KEY_ACTIVE_DIRECTORY_TRACKING_TIME_OUT, PROPERTY_KEY_ACTIVE_DIRECTORY_TRACKING_USER_SEQUENCE_NUMBER

Constructor Summary

Constructors

Constructor and Description
ADTrackingIncrementalRepositoryChangeTracker(LdapConfiguration ldapConfiguration, PluginPropertyService pluginProperties, UserManagement userManagement, ExternalUserGroupDao externalUserGroupDao, boolean doFullSynchronization) Constructor.

Method Summary

Modifier and Type	Method and Description
Collection<ExternalUserGroup>	getNextGroups() Method to return the next groups from the repository.
Collection<User>	getNextUsers() Method to return the next users from the repository.
boolean	needsToAcceptMembersOfGroups() If this method returns true, the UserGroupSynchronizer has to visit the members of a group explicitly.
void	setUserGroupManagement(UserGroupManagement userGroupManagement)
void	start() Initializes the connection to the directory server.
void	stop(boolean successful) Method to be called after the synchronization ran.

Methods inherited from class java.lang.Object

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

Field Detail

PROPERTY_KEY_AD_LAST_USED_SERVER

public static final String PROPERTY_KEY_AD_LAST_USED_SERVER

Key for storing the last used server url of this tracker.

See Also:

Constant Field Values

Constructor Detail

ADTrackingIncrementalRepositoryChangeTracker

public ADTrackingIncrementalRepositoryChangeTracker(LdapConfiguration ldapConfiguration,
                                                    PluginPropertyService pluginProperties,
                                                    UserManagement userManagement,
                                                    ExternalUserGroupDao externalUserGroupDao,
                                                    boolean doFullSynchronization)

Constructor.

Parameters:

ldapConfiguration - The LDAP configuration to use.

pluginProperties - The properties to use.

userManagement - Management for users.

externalUserGroupDao - Dao for external users.

doFullSynchronization - If set to true, a full sync will done.

Method Detail

getNextGroups

public Collection<ExternalUserGroup> getNextGroups()

Method to return the next groups from the repository.

Specified by:

getNextGroups in interface IncrementalRepositoryChangeTracker

Returns:

List of groups or null if no groups left.

getNextUsers

public Collection<User> getNextUsers()

Method to return the next users from the repository.

Specified by:

getNextUsers in interface IncrementalRepositoryChangeTracker

Returns:

List of users or null if no users left.

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.

Specified by:

needsToAcceptMembersOfGroups in interface IncrementalRepositoryChangeTracker

Returns:

True.

setUserGroupManagement

public void setUserGroupManagement(UserGroupManagement userGroupManagement)

Parameters:

userGroupManagement - the userGroupManagement to set

start

public void start()

Initializes the connection to the directory server.

Specified by:

start in interface IncrementalRepositoryChangeTracker

stop

public void stop(boolean successful)

Method to be called after the synchronization ran.

Specified by:

stop in interface IncrementalRepositoryChangeTracker

Parameters:

successful - True, if the sync was successful.