psdi.security.ldap

Class GenericDirectorySynchronizer

java.lang.Object

psdi.security.ldap.LdapSynchronizer

psdi.security.ldap.AbstractLdapSynchronizer

psdi.security.ldap.GenericDirectorySynchronizer

public class GenericDirectorySynchronizer
extends AbstractLdapSynchronizer

This is a generic class to synchronize the required data from LDAP server to MAXIMO Database tables. The Synchronization process is one way only i.e from directory to MAXIMO. Any changes made to the MAXIMO tables in this process by external means will be overwritten when this synchronizer runs . Any data that's not coming from directory, i.e default data that's not available in directory will not be overwritten when data is updated in MAXIMO tables.

Field Summary

Fields inherited from class psdi.security.ldap.AbstractLdapSynchronizer

connection, contextSettings, errorCount, fullSyncNeeded, GROUP_SEARCH_PAGE_SIZE, groupSettings, ldapSyncListener, logger, maxErrors, noGroupsSynchronized, noUsersSynchronized, sqlLogger, synchronizerSettings, syncNeeded, syncParameters, USER_SEARCH_PAGE_SIZE, userSettings

Constructor Summary

Constructors

Constructor and Description
GenericDirectorySynchronizer()

Method Summary

Modifier and Type	Method and Description
protected void	determineSynchronizationNeed() Determines whether synchronization is needed or not.
protected java.lang.String	getGroupDNAttributeName() Returns the attribute used for identifying the distinguished name of a group object.In Novell "dn" is for distinguishedname.
protected java.lang.String	getGroupObjectClass() Returns the object class used to indentify group objects in Novell eDirectory.
protected java.lang.String	getMemberUserAccountName(java.lang.String memberDN) Returns the user or group member account name, for the given distinguished name of the user or group.
protected java.lang.String	getUserDNAttributeName() Returns the attribute used for identifying the distinguished name of a user object.In Novell "dn" is for distinguishedname.
protected java.lang.String	getUserObjectClass() Returns the object class used to indentify user objects in Novell eDirectory.
protected void	initSync() Initialize sync parameters.
protected java.util.Set	retrieveAllGroupMembers(java.lang.String groupDN) Retrieves all the group members of the given group distinguished name.
protected void	retrieveGroupMembers(java.lang.String groupDN, java.util.Set memberUsers, java.util.Set memberGroups) Retrieves group members and fills the users and groups that are members of the given group into the passed in sets.
protected void	syncGroups() Performs LDAP query against the LDAP Directory server and retrieves the results .
protected void	syncUsers() Performs LDAP query against the LDAP Directory server and retrieves the results page by page and processes each page result.

Methods inherited from class psdi.security.ldap.AbstractLdapSynchronizer

buildURL, closeContext, commitGroupChanges, commitGroupChanges, commitUserChanges, commitUserChanges, createDefaultLdapContext, createSearchLdapContext, getDefaultLdapContextEnvironment, getGroupAttributes, getGroupMemberAsGroupAttribute, getGroupMemberAsUserAttribute, getGroupMembersAttribute, getGroupSearchBase, getGroupSearchControls, getGroupSearchFilter, getGroupSearchPageSize, getGroupSearchScope, getLDAPSyncListener, getSearchLdapContextEnvironment, getSynchronizerSettings, getSyncParameters, getUserAttributes, getUserSearchBase, getUserSearchControls, getUserSearchFilter, getUserSearchPageSize, getUserSearchScope, init, isFullSyncNeeded, isSyncNeeded, performSync, setFullSyncNeeded, setLDAPSyncListener, setOwner, setSyncNeeded, syncGroupMembers, updateSyncParameters

Methods inherited from class java.lang.Object

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

Constructor Detail

GenericDirectorySynchronizer

public GenericDirectorySynchronizer()

Method Detail

initSync

protected void initSync()
                 throws LdapSyncException

Initialize sync parameters.

Overrides:

initSync in class AbstractLdapSynchronizer

Throws:

LdapSyncException - if fails to initialize

retrieveAllGroupMembers

protected java.util.Set retrieveAllGroupMembers(java.lang.String groupDN)
                                         throws LdapSyncException

Retrieves all the group members of the given group distinguished name. If a group has another group as a member, then this method figures out the users of that nested group. The returned set includes complete list of all the user account names of the given group.

Specified by:

retrieveAllGroupMembers in class AbstractLdapSynchronizer

Parameters:

groupDN - group distinguished name for which users need to be retrieved.

Returns:

A set of all users that are members of the given group.

Throws:

LdapSyncException - if fails to retrieve members.

See Also:

AbstractLdapSynchronizer.retrieveAllGroupMembers(java.lang.String)

retrieveGroupMembers

protected void retrieveGroupMembers(java.lang.String groupDN,
                                    java.util.Set memberUsers,
                                    java.util.Set memberGroups)
                             throws LdapSyncException

Retrieves group members and fills the users and groups that are members of the given group into the passed in sets.

Parameters:

groupDN - distinguished name of the group for which members need to be retrieved.

memberUsers - returns the set of member users of the group.

memberGroups - returns the set of member groups of the group.

Throws:

LdapSyncException - if fails to retrieve members of the group.

getMemberUserAccountName

protected java.lang.String getMemberUserAccountName(java.lang.String memberDN)
                                             throws LdapSyncException

Returns the user or group member account name, for the given distinguished name of the user or group. The code also determines whether the member distinguished name passed in is for a user or a group depending on the class name of the retrieved object based on the member distinguished name.

Parameters:

memberDN - user or group distinguished name

Returns:

user or group account name based on the distinguished name

Throws:

LdapSyncException - if fails to retrieve the account name.

determineSynchronizationNeed

protected void determineSynchronizationNeed()
                                     throws LdapSyncException

Determines whether synchronization is needed or not. As it is a generic syncronizer it always does a full sync.

Specified by:

determineSynchronizationNeed in class AbstractLdapSynchronizer

Throws:

LdapSyncException - if fails to determine the need

getUserObjectClass

protected java.lang.String getUserObjectClass()

Returns the object class used to indentify user objects in Novell eDirectory.

Specified by:

getUserObjectClass in class AbstractLdapSynchronizer

See Also:

AbstractLdapSynchronizer.getUserObjectClass()

getGroupObjectClass

protected java.lang.String getGroupObjectClass()

Returns the object class used to indentify group objects in Novell eDirectory.

Specified by:

getGroupObjectClass in class AbstractLdapSynchronizer

See Also:

AbstractLdapSynchronizer.getGroupObjectClass()

getUserDNAttributeName

protected java.lang.String getUserDNAttributeName()

Returns the attribute used for identifying the distinguished name of a user object.In Novell "dn" is for distinguishedname. But dn doesn't return any value. So just added cn for now.

Specified by:

getUserDNAttributeName in class AbstractLdapSynchronizer

See Also:

AbstractLdapSynchronizer.getUserDNAttributeName()

getGroupDNAttributeName

protected java.lang.String getGroupDNAttributeName()

Returns the attribute used for identifying the distinguished name of a group object.In Novell "dn" is for distinguishedname. But dn doesn't return any value. So just added cn for now.

Specified by:

getGroupDNAttributeName in class AbstractLdapSynchronizer

See Also:

AbstractLdapSynchronizer.getGroupDNAttributeName()

syncGroups

protected void syncGroups()
                   throws LdapSyncException

Performs LDAP query against the LDAP Directory server and retrieves the results . For each object that's obtained in the result, a notification event will be fired to the listener to synchronize the changes to MAXIMO database tables. This method also retrieves all the users of each group object processed in the search result.

Overrides:

syncGroups in class AbstractLdapSynchronizer

Throws:

LdapSyncException

syncUsers

protected void syncUsers()
                  throws LdapSyncException

Performs LDAP query against the LDAP Directory server and retrieves the results page by page and processes each page result. For each object that's obtained in the result, a notification event will be fired to the listener to synchronize the changes to MAXIMO database tables.

Overrides:

syncUsers in class AbstractLdapSynchronizer

Throws:

LdapSyncException