org.lsc.beans.syncoptions

Interface ISyncOptions

All Known Implementing Classes:

ForceSyncOptions, PropertiesBasedSyncOptions

public interface ISyncOptions

Author:

Sebastien Bahloul <seb@lsc-project.org>

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_CONDITION default condition if none is given

Method Summary

Modifier and Type	Method and Description
String	getChangeIdCondition() Returns the condition for a id change
String	getCondition(LscModificationType 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	getDelimiter(String name) Return the delimiter name for the corresponding dataset
String	getDn() Return the expression used to infer the new object 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.
PolicyType	getStatus(String id, String attributeName) Analyze the context to get the right synchronization status to apply.
String	getUpdateCondition() Returns the condition for an update
void	initialize(TaskType task) Initialize the synchronization options policy.

Field Detail

DEFAULT_CONDITION

static final String DEFAULT_CONDITION

default condition if none is given

See Also:

Constant Field Values

Method Detail

initialize

void initialize(TaskType task)

Initialize the synchronization options policy.

Parameters:

task - the task configuration object on which applying syncopts

getStatus

PolicyType 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

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)

getChangeIdCondition

String getChangeIdCondition()

Returns the condition for a id change

Returns:

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

getCondition

String getCondition(LscModificationType operation)

getDn

String getDn()

Return the expression used to infer the new object DN

Returns:

the new object dn pattern

getDelimiter

String getDelimiter(String name)

Return the delimiter name for the corresponding dataset

Parameters:

name - dataset name

Returns:

the delimiter for this dataset or the default delimiter