psdi.security.vmm

Class VMMSyncParameters

java.lang.Object

psdi.security.vmm.VMMSyncParameters

public class VMMSyncParameters
extends java.lang.Object

A class to represent the synchronization parameters that are used by the synchronizer object to determine the need to perform synchronization or not and also to determine whether full or incremental synchronization is needed or not. Note: These parameters are always stored in database and retrieved back and passed to the synchronizer at the time of performing the synchronization task and are typically not configured by users.

These are the key/value pairs from the ldapsyncparams table for this cron task instance. If change polling is not supported for this instance then there will be no data. The value for parameter "CheckPoint" is a string containing one or more repository IDs and its associated checkpoint, delimited with bars and equals signs, for example
AD1=123|AD2=456 indicates that for the repository AD1, the checkpoint is 123, and for the repository AD2, the checkpoint is 456.

At this point, there is only one parameter, VMMSynchronizer.CHECKPOINT.

Constructor Summary

Constructors

Constructor and Description
VMMSyncParameters()

Method Summary

Methods

Modifier and Type	Method and Description
commonj.sdo.DataObject	checkpointMapToObject(java.util.HashMap<java.lang.String,java.lang.String> cpMap, commonj.sdo.DataObject controlDO, boolean fullSync) Given a ChangeControl DataObject to be sent to VMM, construct child DataObject(s) containing the checkpoint(s) to start searching from.
java.lang.String	checkpointMapToString(java.util.HashMap in) Given a HashMap of checkpoints, return a string suitable for storing in ldapsyncparams.
java.util.HashMap<java.lang.String,java.lang.String>	checkpointObjectToMap(commonj.sdo.DataObject inDO) Given a DataObject returned from VMM, construct a HashMap keyed by repository ID with value equal to string representation of the checkpoint.
java.util.HashMap<java.lang.String,java.lang.String>	checkpointStringToMap(java.lang.String in) Given a checkpoint string value from ldapsyncparams, return a HashMap keyed by repository ID with value equal to string representation of the checkpoint.
java.lang.String	get(java.lang.String parameterName) Returns the value of the parameter.
java.util.Iterator	getParameters() Returns an Iterator object to iterate over the list of parameters.
void	put(java.lang.String parameterName, java.lang.String value) Puts the parameter and its value in a cache.
int	size() Returns the number of parameters.

Methods inherited from class java.lang.Object

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

Constructor Detail

VMMSyncParameters

public VMMSyncParameters()

Method Detail

get

public java.lang.String get(java.lang.String parameterName)

Returns the value of the parameter. The value can be null.

Parameters:

parameterName - name of the parameter for which value is needed.

Returns:

the parameter value, which can be null.

put

public void put(java.lang.String parameterName,
       java.lang.String value)

Puts the parameter and its value in a cache.

Parameters:

parameterName - name of the parameter

value - the value of the parameter, which can be null.

getParameters

public java.util.Iterator getParameters()

Returns an Iterator object to iterate over the list of parameters.

Returns:

an Iterator object to iterate over the list of parameters.

checkpointMapToString

public java.lang.String checkpointMapToString(java.util.HashMap in)

Given a HashMap of checkpoints, return a string suitable for storing in ldapsyncparams.

Parameters:

in - HashMap of checkpoints

Returns:

String representation of checkpoints, for storing in ldapsyncparams table

checkpointStringToMap

public java.util.HashMap<java.lang.String,java.lang.String> checkpointStringToMap(java.lang.String in)

Given a checkpoint string value from ldapsyncparams, return a HashMap keyed by repository ID with value equal to string representation of the checkpoint.

Parameters:

in - String specifying checkpoint, value from ldapsyncparams table.

Returns:

HashMap of checkpoints

checkpointObjectToMap

public java.util.HashMap<java.lang.String,java.lang.String> checkpointObjectToMap(commonj.sdo.DataObject inDO)
                                                                           throws VMMSyncException

Given a DataObject returned from VMM, construct a HashMap keyed by repository ID with value equal to string representation of the checkpoint.

Parameters:

inDO - ChangeResponseControl DataObject containing the checkpoint(s)

Returns:

HashMap of checkpoints

Throws:

VMMSyncException

checkpointMapToObject

public commonj.sdo.DataObject checkpointMapToObject(java.util.HashMap<java.lang.String,java.lang.String> cpMap,
                                           commonj.sdo.DataObject controlDO,
                                           boolean fullSync)
                                             throws VMMSyncException

Given a ChangeControl DataObject to be sent to VMM, construct child DataObject(s) containing the checkpoint(s) to start searching from.

Returns:

Updated Control DataObject

Throws:

VMMSyncException

See Also:

VMMSynchronizer.lastCheckPoint

size

public int size()

Returns the number of parameters.

Returns:

the number of parameters.