org.lsc.beans.syncoptions
Interface ISyncOptions

All Known Implementing Classes:

ForceSyncOptions, PropertiesBasedSyncOptions

public interface ISyncOptions

Author:

Sebastien Bahloul <seb@lsc-project.org>

Nested Class Summary

static class

ISyncOptions.STATUS_TYPE The strategy to apply to the attribute updates.

Method Summary

String	getCondition(JndiModificationType operation) Returns the condition for this operation
Set<String>	getCreateAttributeNames() Return the names of attributes to be created.
String	getCreateCondition() Returns the condition for a creation
List<String>	getCreateValues(String id, String attributeName) Return the create value for a given attribute name.
Set<String>	getDefaultValuedAttributeNames() Return the default valued attributes
List<String>	getDefaultValues(String id, String attributeName) Return the default values for a given attribute name.
String	getDeleteCondition() Returns the condition for a delete
String	getDn() Get the setting to generate a DN
Set<String>	getForceValuedAttributeNames() Return the force valued attributes
List<String>	getForceValues(String id, String attributeName) Return the force value for a given attribute name.
String	getModrdnCondition() Returns the condition for a modrdn
ISyncOptions.STATUS_TYPE	getStatus(String id, String attributeName) Analyze the context to get the right synchronization status to apply.
String	getTaskName() Get the task name
String	getUpdateCondition() Returns the condition for an update
List<String>	getWriteAttributes() Get all the attributes that must be written in the destination
void	initialize(String taskname) Initialize the synchronization options policy.

Method Detail

initialize

void initialize(String taskname)

Initialize the synchronization options policy.

Parameters:

taskname - the task name on which applying syncopts

getStatus

ISyncOptions.STATUS_TYPE getStatus(String id,
                                   String attributeName)

Analyze the context to get the right synchronization status to apply.

Parameters:

id - the object identifier according to the datasource

attributeName - the attribute name

Returns:

the default or create value

getDefaultValues

List<String> getDefaultValues(String id,
                              String attributeName)

Return the default values for a given attribute name. The default values replace a missing value in the source datasource

Parameters:

id - the object identifier according to the datasource

attributeName - the attribute name

Returns:

the default value

getCreateValues

List<String> getCreateValues(String id,
                             String attributeName)

Return the create value for a given attribute name. The create value replace a missing value in the source datasource only while creating a new entry. For coherence, implementation classes must guarantee that a default value override a create value

Parameters:

id - the object identifier according to the datasource

attributeName - the attribute name

Returns:

the create value

getCreateAttributeNames

Set<String> getCreateAttributeNames()

Return the names of attributes to be created.

Returns:

the created attributes names

getDefaultValuedAttributeNames

Set<String> getDefaultValuedAttributeNames()

Return the default valued attributes

Returns:

the default valued attributes names

getForceValues

List<String> getForceValues(String id,
                            String attributeName)

Return the force value for a given attribute name. The force value forces a value in the desination directory

Parameters:

id - the object identifier according to the datasource

attributeName - the attribute name

Returns:

the force value

getForceValuedAttributeNames

Set<String> getForceValuedAttributeNames()

Return the force valued attributes

Returns:

the force valued attributes names

getWriteAttributes

List<String> getWriteAttributes()

Get all the attributes that must be written in the destination

Returns:

the attributes to write in the destination

getCreateCondition

String getCreateCondition()

Returns the condition for a creation

Returns:

the condition or "true" if none is specified (default)

getUpdateCondition

String getUpdateCondition()

Returns the condition for an update

Returns:

the condition or "true" if none is specified (default)

getDeleteCondition

String getDeleteCondition()

Returns the condition for a delete

Returns:

the condition or "true" if none is specified (default)

getModrdnCondition

String getModrdnCondition()

Returns the condition for a modrdn

Returns:

the condition or "true" if none is specified (default)

getCondition

String getCondition(JndiModificationType operation)

Returns the condition for this operation

Parameters:

operation - The operation type

Returns:

the condition or "true" if none is specified (default)

getDn

String getDn()

Get the setting to generate a DN

Returns:

String The script to generate a DN

getTaskName

String getTaskName()

Get the task name

Returns:

String The current task name.