psdi.security.ldap

Class LdapSyncAdapter

java.lang.Object

psdi.security.ldap.LdapSyncAdapter

All Implemented Interfaces:

LdapSyncListener

Direct Known Subclasses:

DefaultLdapSyncAdapter

public class LdapSyncAdapter
extends java.lang.Object
implements LdapSyncListener

An adapter class that has a dummy implementations of all the required methods.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.sql.Connection	connection
protected MXLogger	logger
protected MXLogger	sqlLogger
protected UserInfo	userInfo

Constructor Summary

Constructors

Constructor and Description
LdapSyncAdapter()

Method Summary

Modifier and Type	Method and Description
protected java.sql.Connection	getConnection() Returns the connection to be used.
protected MXLogger	getLogger() Returns the logger to be used to log messages.
protected MXLogger	getSqlLogger() Returns the logger to be used to log SQL messages.
protected UserInfo	getUserInfo() Returns the UserInfo for getting mboSets.
void	syncEnded(LdapSyncEvent event) Called by the Synchronizer at the end of a full or incremental synchronization to let the listener cleanup any references to objects that are being held for the duration of the synchronization process.
void	syncGroup(LdapSyncEvent event) Called by the Synchronizer when a group data need to be synchronized with the database.
void	syncGroupMembers(LdapSyncEvent event) Called by the Synchronizer when a group member data need to be synchronized with the database.
void	syncStarting(LdapSyncEvent event) Called by the Synchronizer at the begining of a full or incremental synchronization to let the listener initialize itself.
void	syncUser(LdapSyncEvent event) Called by the Synchronizer when a user data need to be synchronized with the database.

Methods inherited from class java.lang.Object

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

Field Detail

connection

protected java.sql.Connection connection

logger

protected MXLogger logger

sqlLogger

protected MXLogger sqlLogger

userInfo

protected UserInfo userInfo

Constructor Detail

LdapSyncAdapter

public LdapSyncAdapter()

Method Detail

getConnection

protected java.sql.Connection getConnection()

Returns the connection to be used.

Returns:

the connection to be used.

getUserInfo

protected UserInfo getUserInfo()

Returns the UserInfo for getting mboSets.

getLogger

protected MXLogger getLogger()

Returns the logger to be used to log messages.

Returns:

the logger to be used to log messages.

getSqlLogger

protected MXLogger getSqlLogger()

Returns the logger to be used to log SQL messages.

Returns:

the logger to be used to log SQL messages.

syncStarting

public void syncStarting(LdapSyncEvent event)
                  throws LdapSyncException

Called by the Synchronizer at the begining of a full or incremental synchronization to let the listener initialize itself. This is called only once for the entire synchronization process. The listener should hold on to the connection being passed in this event to perform synchronization with the database on subsequent calls.

Specified by:

syncStarting in interface LdapSyncListener

Parameters:

event - synchronization event that provides additional details to let the listener initialize itself.

Throws:

LdapSyncException - if the listener fails to perform the initialization.

syncEnded

public void syncEnded(LdapSyncEvent event)
               throws LdapSyncException

Called by the Synchronizer at the end of a full or incremental synchronization to let the listener cleanup any references to objects that are being held for the duration of the synchronization process. This is always called whether the synchronization process completes successfully or fails because of some external problem.

Specified by:

syncEnded in interface LdapSyncListener

Parameters:

event - synchronization event that provides additional details to the listener.

Throws:

LdapSyncException - if the listener fails to cleanup.

syncUser

public void syncUser(LdapSyncEvent event)
              throws LdapSyncException

Called by the Synchronizer when a user data need to be synchronized with the database. The event object contains the necessary user synchronization data and all the details about how the data need to be mapped to the database tables.

Specified by:

syncUser in interface LdapSyncListener

Parameters:

event - synchronization event that provides additional details to perform the user data synchronization with database.

Throws:

LdapSyncException - if the listener fails to perform the user data synchronization.

syncGroup

public void syncGroup(LdapSyncEvent event)
               throws LdapSyncException

Called by the Synchronizer when a group data need to be synchronized with the database. The event object contains the necessary group synchronization data and all the details about how the data need to be mapped to the database tables.

Specified by:

syncGroup in interface LdapSyncListener

Parameters:

event - synchronization event that provides additional details to perform the group data synchronization with database.

Throws:

LdapSyncException - if the listener fails to perform the group data synchronization.

syncGroupMembers

public void syncGroupMembers(LdapSyncEvent event)
                      throws LdapSyncException

Called by the Synchronizer when a group member data need to be synchronized with the database. The event object contains the necessary group member synchronization data and all the details about how the data need to be mapped to the database tables.

Specified by:

syncGroupMembers in interface LdapSyncListener

Parameters:

event - synchronization event that provides additional details to perform the group member data synchronization with database.

Throws:

LdapSyncException - if the listener fails to perform the group member data synchronization.