psdi.security.ldap

Interface LdapSyncListener

All Known Implementing Classes:

DefaultLdapSyncAdapter, LdapSyncAdapter

public interface LdapSyncListener

An interface to be implemented by an object that need to process the user and group data that's obtained from the LDAP Server. The listener object is automatically added to the appropriate synchronizer configured based on the configuration settings.

Method Summary

Modifier and Type	Method and Description
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.

Method Detail

syncStarting

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.

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

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.

Parameters:

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

Throws:

LdapSyncException - if the listener fails to cleanup.

syncUser

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.

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

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.

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

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.

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.