psdi.security.vmm

Class VMMSynchronizer

java.lang.Object

psdi.security.vmm.Synchronizer

psdi.security.vmm.VMMSynchronizer

public class VMMSynchronizer
extends Synchronizer

A class that implements the VMM synchronization logic needed to retrieve user and group object information from VMM Server runtime. The code written here would retrieve user and group object limited to single configured DN

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CHECKPOINT The ParamName on LdapSyncParams table for storing check point values for the last iteration of VMMSYNC, when ChangePolling was enabled.
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
VMMSynchronizer() A default constructor.

Method Summary

Modifier and Type	Method and Description
VMMSynchronizerSettings	getSynchronizerSettings() Returns synchronizer settings configured.
VMMSyncParameters	getSyncParameters() Returns the synchronization parameters used during the synchronization.
VMMSyncListener	getVMMSyncListener() Returns the listener object that receives synchronization events.
void	init(VMMSynchronizerInitData 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, VMMSyncParameters syncParams, UserInfo userInfo) Performs the synchronization operation based on the synchronization parameters.
void	setOwner(VMMSyncTask val) Set reference to the calling class
void	setVMMSyncListener(VMMSyncListener vmmSyncListener) Sets the listener object that gets notification events during synchronization process.

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

CHECKPOINT

public static final java.lang.String CHECKPOINT

The ParamName on LdapSyncParams table for storing check point values for the last iteration of VMMSYNC, when ChangePolling was enabled.

See Also:

Constant Field Values

Constructor Detail

VMMSynchronizer

public VMMSynchronizer()

A default constructor.

Method Detail

init

public void init(VMMSynchronizerInitData initData)
          throws VMMSyncException

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 Synchronizer

Parameters:

initData - initialization data

Throws:

VMMSyncException - if fail to initialize

getSyncParameters

public VMMSyncParameters getSyncParameters()

Returns the synchronization parameters used during the synchronization.

Returns:

synchronization parameters

getSynchronizerSettings

public VMMSynchronizerSettings getSynchronizerSettings()

Returns synchronizer settings configured.

Returns:

synchronizer settings configured.

performSync

public void performSync(java.sql.Connection con,
                        VMMSyncParameters syncParams,
                        UserInfo userInfo)
                 throws VMMSyncException

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 Synchronizer

Parameters:

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

syncParams - synchronization prameters

Throws:

VMMSyncException - if fails to synchronize

See Also:

getVMMSyncListener(), determineSynchronizationNeed(), #getInitialCheckpoint, syncVMMUsers(), syncVMMGroups(), updateSyncParameters()

setOwner

public void setOwner(VMMSyncTask 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.

setVMMSyncListener

public void setVMMSyncListener(VMMSyncListener vmmSyncListener)

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

Parameters:

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

getVMMSyncListener

public VMMSyncListener getVMMSyncListener()

Returns the listener object that receives synchronization events.

Returns:

the listener object that receives synchronization events.