org.lsc.beans.syncoptions

Class PropertiesBasedSyncOptions

java.lang.Object

org.lsc.beans.syncoptions.PropertiesBasedSyncOptions

All Implemented Interfaces:

ISyncOptions

public class PropertiesBasedSyncOptions
extends Object
implements ISyncOptions

Synchronization options based on a properties file This class interprets properties to get detailed options for synchronization, including behavior and values for the general case or attribute by attribute.

Author:

Sebastien Bahloul <seb@lsc-project.org>, Jonathan Clarke <jon@lsc-project.org>

Field Summary

Fields inherited from interface org.lsc.beans.syncoptions.ISyncOptions

DEFAULT_CONDITION

Constructor Summary

Constructors

Constructor and Description
PropertiesBasedSyncOptions()

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

PropertiesBasedSyncOptions

public PropertiesBasedSyncOptions()

Method Detail

initialize

public void initialize(TaskType task)

Description copied from interface: ISyncOptions

Initialize the synchronization options policy.

Specified by:

initialize in interface ISyncOptions

Parameters:

task - the task configuration object on which applying syncopts

getStatus

public final PolicyType getStatus(String id,
                                  String attributeName)

Description copied from interface: ISyncOptions

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

Specified by:

getStatus in interface ISyncOptions

Parameters:

id - the object identifier according to the datasource

attributeName - the attribute name

Returns:

the default or create value

getDefaultValues

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

Description copied from interface: ISyncOptions

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

Specified by:

getDefaultValues in interface ISyncOptions

Parameters:

id - the object identifier according to the datasource

attributeName - the attribute name

Returns:

the default value

getCreateValues

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

Description copied from interface: ISyncOptions

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

Specified by:

getCreateValues in interface ISyncOptions

Parameters:

id - the object identifier according to the datasource

attributeName - the attribute name

Returns:

the create value

getForceValues

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

Description copied from interface: ISyncOptions

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

Specified by:

getForceValues in interface ISyncOptions

Parameters:

id - the object identifier according to the datasource

attributeName - the attribute name

Returns:

the force value

getCreateAttributeNames

public Set<String> getCreateAttributeNames()

Description copied from interface: ISyncOptions

Return the names of attributes to be created.

Specified by:

getCreateAttributeNames in interface ISyncOptions

Returns:

the created attributes names

getDefaultValuedAttributeNames

public Set<String> getDefaultValuedAttributeNames()

Description copied from interface: ISyncOptions

Return the default valued attributes

Specified by:

getDefaultValuedAttributeNames in interface ISyncOptions

Returns:

the default valued attributes names

getForceValuedAttributeNames

public Set<String> getForceValuedAttributeNames()

Description copied from interface: ISyncOptions

Return the force valued attributes

Specified by:

getForceValuedAttributeNames in interface ISyncOptions

Returns:

the force valued attributes names

getDn

public String getDn()

Description copied from interface: ISyncOptions

Return the expression used to infer the new object DN

Specified by:

getDn in interface ISyncOptions

Returns:

the new object dn pattern

getCreateCondition

public String getCreateCondition()

Description copied from interface: ISyncOptions

Returns the condition for a creation

Specified by:

getCreateCondition in interface ISyncOptions

Returns:

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

getDeleteCondition

public String getDeleteCondition()

Description copied from interface: ISyncOptions

Returns the condition for a delete

Specified by:

getDeleteCondition in interface ISyncOptions

Returns:

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

getUpdateCondition

public String getUpdateCondition()

Description copied from interface: ISyncOptions

Returns the condition for an update

Specified by:

getUpdateCondition in interface ISyncOptions

Returns:

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

getChangeIdCondition

public String getChangeIdCondition()

Description copied from interface: ISyncOptions

Returns the condition for a id change

Specified by:

getChangeIdCondition in interface ISyncOptions

Returns:

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

getCondition

public String getCondition(LscModificationType operation)

Specified by:

getCondition in interface ISyncOptions

getDelimiter

public String getDelimiter(String name)

Description copied from interface: ISyncOptions

Return the delimiter name for the corresponding dataset

Specified by:

getDelimiter in interface ISyncOptions

Parameters:

name - dataset name

Returns:

the delimiter for this dataset or the default delimiter