psdi.security.ldap

Class AbstractLdapSynchronizer

java.lang.Object

psdi.security.ldap.LdapSynchronizer

psdi.security.ldap.AbstractLdapSynchronizer

Direct Known Subclasses:

ActiveDirectorySynchronizer, GenericDirectorySynchronizer, NovellDirectorySynchronizer

public abstract class AbstractLdapSynchronizer
extends LdapSynchronizer

An abstract class that implements the common synchronization logic needed to retrieve user and group object information from LDAP Directory Server. This class must be extended further to provide concrete implementations to the appropriate Directory Server related synchronization. The code written here would work for LDAP Servers that support version LDAPv3 and above. The code written here does not take care of referrals that are returned as part of search. The code must be enhanced, if referral support is needed.

Field Summary

Fields

Modifier and Type	Field and Description
static int	GROUP_SEARCH_PAGE_SIZE The default search page result for group searches
static int	USER_SEARCH_PAGE_SIZE The default search page result for user searches

Constructor Summary

Constructors

Constructor and Description
AbstractLdapSynchronizer() A default constructor.

Method Summary

Modifier and Type	Method and Description
LdapSyncListener	getLDAPSyncListener() Returns the listener object that receives synchronization events.
SynchronizerSettings	getSynchronizerSettings() Returns synchronizer settings configured.
SyncParameters	getSyncParameters() Returns the synchronization parameters used during the synchronization.
void	init(LdapSynchronizerInitData initData) Initializes the synchronizer with the initialization data that's obtained from configuration values.
boolean	isFullSyncNeeded() Returns whether a full synchronizaiton is needed or not.
boolean	isSyncNeeded() Returns whether synchronization is needed or not.
void	performSync(java.sql.Connection con, SyncParameters syncParams, UserInfo userInfo) Performs the synchronization operation based on the synchronization parameters.
void	setLDAPSyncListener(LdapSyncListener ldapSyncListener) Sets the listener object that gets notification events during synchronization process.
void	setOwner(LdapSyncTask val) Set reference to the calling class

Methods inherited from class java.lang.Object

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

Field Detail

USER_SEARCH_PAGE_SIZE

public static final int USER_SEARCH_PAGE_SIZE

The default search page result for user searches

See Also:

Constant Field Values

GROUP_SEARCH_PAGE_SIZE

public static final int GROUP_SEARCH_PAGE_SIZE

The default search page result for group searches

See Also:

Constant Field Values

Constructor Detail

AbstractLdapSynchronizer

public AbstractLdapSynchronizer()

A default constructor.

Method Detail

init

public void init(LdapSynchronizerInitData initData)
          throws LdapSyncException

Initializes the synchronizer with the initialization data that's obtained from configuration values. Based on the initialization data, instantiates the lsterner object that receives notification events.

Specified by:

init in class LdapSynchronizer

Parameters:

initData - initialization data

Throws:

LdapSyncException - if fail to initialize

getSyncParameters

public SyncParameters getSyncParameters()

Returns the synchronization parameters used during the synchronization.

Returns:

synchronization parameters

getSynchronizerSettings

public SynchronizerSettings getSynchronizerSettings()

Returns synchronizer settings configured.

Returns:

synchronizer settings configured.

performSync

public void performSync(java.sql.Connection con,
                        SyncParameters syncParams,
                        UserInfo userInfo)
                 throws LdapSyncException

Performs the synchronization operation based on the synchronization parameters. The synchronization parameters contain the necessary data required for this operation and also contain the values that are used by the last synchronization operation.

Specified by:

performSync in class LdapSynchronizer

Parameters:

con - database connection to be used for synchronizing LDAP data with MAXIMO database tables.

syncParams - synchronization prameters

Throws:

LdapSyncException - if fails to synchronize

setOwner

public void setOwner(LdapSyncTask val)

Set reference to the calling class

isFullSyncNeeded

public boolean isFullSyncNeeded()

Returns whether a full synchronizaiton is needed or not.

Returns:

true to indicate full synchronization is needed, otherwise false.

isSyncNeeded

public boolean isSyncNeeded()

Returns whether synchronization is needed or not.

Returns:

true to indicate synchronization is needed, otherwise false.

setLDAPSyncListener

public void setLDAPSyncListener(LdapSyncListener ldapSyncListener)

Sets the listener object that gets notification events during synchronization process.

Parameters:

ldapSyncListener - a listener object that need to receive synchronization events.

getLDAPSyncListener

public LdapSyncListener getLDAPSyncListener()

Returns the listener object that receives synchronization events.

Returns:

the listener object that receives synchronization events.