org.lsc

Class Configuration

java.lang.Object

org.lsc.Configuration

public class Configuration
extends Object

Ldap Synchronization Connector Configuration. This class was initially handling only properties configuration types but with XML evolution, LscConfiguration is now the central point. This point is maintained for historic compatibility issues It contains deprecated properties based methods to allow smooth updates of plugins and external methods components

Author:

Sebastien Bahloul , Remy-Christophe Schermesser

Field Summary

Fields

Modifier and Type	Field and Description
static String	DATABASE_PROPERTIES_FILENAME Filename of the database.properties file
static int	DAYS_BEFORE_SUPPRESSION Numbers of days between an entry is set to be deleted and its actual deletion.
static String	DN_ACCOUNTS
static String	DN_ENHANCED_SCHEMA
static String	DN_LDAP_SCHEMA
static String	DN_PEOPLE
static String	DN_REAL_ROOT
static String	DN_STRUCTURES
static String	location Default location for configuration filename
static String	LSC_SYNCOPTIONS_PREFIX Prefix for syncoptions configuration elements in lsc.properties
static String	LSC_TASKS_PREFIX Prefix for tasks configuration elements in lsc.properties
static int	MAX_CONCURRENT_SYNCHRONIZED The maximum limit of data that can be synchronized by a synchronous task
static String	OBJECTCLASS_EMPLOYEE
static String	OBJECTCLASS_PERSON
static String	PROPERTIES_FILENAME Filename of the lsc.properties file
static int	UID_MAX_LENGTH

Method Summary

Modifier and Type	Method and Description
static void	assertPropertyNotEmpty(String propertyName, String propertyValue, String location) Helper method to check that a String read in from a property is not empty or null
static Properties	getAsProperties(org.apache.commons.configuration.PropertiesConfiguration propsConf, String prefix) Deprecated.
static Properties	getAsProperties(String prefix) Deprecated.
static Properties	getAsProperties(String filename, String prefix) Deprecated.
static String	getConfigurationDirectory() Get the path to the directory where configuration files are stored, with a "/" at the end (or "\" on Windows).
static Properties	getDstProperties() Deprecated.
static int	getInt(String key, int defaultValue) Deprecated.
static Properties	getPropertiesFromFile(String pathToFile) Deprecated.
static Properties	getPropertiesFromFileInConfigDir(String fileName) Deprecated.
static Properties	getPropertiesSubset(Properties originalProperties, String prefix)
static Properties	getSrcProperties() Deprecated.
static String	getString(String key) Deprecated.
static String	getString(String key, String defaultValue) Deprecated.
static boolean	isLoggingSetup() Get the flag to determine if logging is configured or not yet
static void	setLoggingSetup(boolean loggingSetup) Set the flag to determine if logging is configured or not yet
static void	setProperties(String prefix, Properties props) Set the new properties
static void	setUp() Set up configuration for the given location, including logback.
static void	setUp(String lscConfigurationPath) Set up configuration for the given location, including logback.
static void	setUp(String lscConfigurationPath, boolean validate) Set up configuration for the given location, including logback.

Methods inherited from class java.lang.Object

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

Field Detail

PROPERTIES_FILENAME

public static final String PROPERTIES_FILENAME

Filename of the lsc.properties file

See Also:

Constant Field Values

DATABASE_PROPERTIES_FILENAME

public static final String DATABASE_PROPERTIES_FILENAME

Filename of the database.properties file

See Also:

Constant Field Values

location

public static String location

Default location for configuration filename

DN_PEOPLE

public static String DN_PEOPLE

DN_LDAP_SCHEMA

public static String DN_LDAP_SCHEMA

DN_ENHANCED_SCHEMA

public static String DN_ENHANCED_SCHEMA

DN_STRUCTURES

public static String DN_STRUCTURES

DN_ACCOUNTS

public static String DN_ACCOUNTS

OBJECTCLASS_PERSON

public static String OBJECTCLASS_PERSON

OBJECTCLASS_EMPLOYEE

public static String OBJECTCLASS_EMPLOYEE

DAYS_BEFORE_SUPPRESSION

public static int DAYS_BEFORE_SUPPRESSION

Numbers of days between an entry is set to be deleted and its actual deletion.

DN_REAL_ROOT

public static String DN_REAL_ROOT

UID_MAX_LENGTH

public static int UID_MAX_LENGTH

LSC_TASKS_PREFIX

public static final String LSC_TASKS_PREFIX

Prefix for tasks configuration elements in lsc.properties

See Also:

Constant Field Values

LSC_SYNCOPTIONS_PREFIX

public static final String LSC_SYNCOPTIONS_PREFIX

Prefix for syncoptions configuration elements in lsc.properties

See Also:

Constant Field Values

MAX_CONCURRENT_SYNCHRONIZED

public static final int MAX_CONCURRENT_SYNCHRONIZED

The maximum limit of data that can be synchronized by a synchronous task

See Also:

Constant Field Values

Method Detail

getSrcProperties

@Deprecated
public static Properties getSrcProperties()
                                               throws LscConfigurationException

Deprecated.

Get data source connection properties.

Returns:

the data source connection properties

Throws:

LscConfigurationException

getDstProperties

@Deprecated
public static Properties getDstProperties()
                                               throws LscConfigurationException

Deprecated.

Get data destination connection properties.

Returns:

the data destination connection properties

Throws:

LscConfigurationException

getAsProperties

@Deprecated
public static Properties getAsProperties(String prefix)

Deprecated.

Create a Properties object that is a subset of this configuration. If there are no properties matching the prefix, an empty Properties object is returned.

Parameters:

prefix - The prefix used to select the properties.

Returns:

Properties object with the requests properties without the prefix

getAsProperties

@Deprecated
public static Properties getAsProperties(String filename,
                                                     String prefix)

Deprecated.

getAsProperties

@Deprecated
public static Properties getAsProperties(org.apache.commons.configuration.PropertiesConfiguration propsConf,
                                                     String prefix)

Deprecated.

getPropertiesSubset

public static Properties getPropertiesSubset(Properties originalProperties,
                                             String prefix)

getInt

@Deprecated
public static int getInt(String key,
                                     int defaultValue)

Deprecated.

Get a int associated with the given property key

Parameters:

key - The property key.

defaultValue - The default value.

Returns:

The associated int.

getString

@Deprecated
public static String getString(String key)

Deprecated.

Get a string associated with the given property key

Parameters:

key - The property key.

Returns:

The associated string.

getString

@Deprecated
public static String getString(String key,
                                           String defaultValue)

Deprecated.

Get a string associated with the given property key

Parameters:

key - The property key.

defaultValue - The default value.

Returns:

The associated string.

getConfigurationDirectory

public static String getConfigurationDirectory()

Get the path to the directory where configuration files are stored, with a "/" at the end (or "\" on Windows). All configuration files MUST be read from this directory. If no directory is specified when launching LSC, this returns the user's current directory.

Returns:

Path to configuration directory

setProperties

public static void setProperties(String prefix,
                                 Properties props)
                          throws org.apache.commons.configuration.ConfigurationException

Set the new properties

Parameters:

prefix - the prefix or null

props - the news properties

Throws:

org.apache.commons.configuration.ConfigurationException

getPropertiesFromFile

@Deprecated
public static Properties getPropertiesFromFile(String pathToFile)
                                                    throws FileNotFoundException,
                                                           IOException

Deprecated.

Helper method to read a file from the filesystem and return it as Properties.

Parameters:

pathToFile - Absolute filename on the filesystem to read.

Returns:

Properties from the file

Throws:

FileNotFoundException

IOException

getPropertiesFromFileInConfigDir

@Deprecated
public static Properties getPropertiesFromFileInConfigDir(String fileName)
                                                               throws FileNotFoundException,
                                                                      IOException

Deprecated.

Helper method to read a file from the configuration directory and return it as Properties.

Parameters:

fileName - Filename relative to the configuration directory.

Returns:

Properties from the file

Throws:

FileNotFoundException

IOException

setUp

public static void setUp()

Set up configuration for the given location, including logback. MUST NEVER BE CALLED DIRECTLY : ONLY USED BY LscConfiguration static code instantiation IMPORTANT: don't log ANYTHING before calling this method!

setUp

public static void setUp(String lscConfigurationPath)
                  throws LscException

Set up configuration for the given location, including logback. IMPORTANT: don't log ANYTHING before calling this method!

Parameters:

lscConfigurationPath -

Throws:

LscException

setUp

public static void setUp(String lscConfigurationPath,
                         boolean validate)
                  throws LscException

Set up configuration for the given location, including logback. IMPORTANT: don't log ANYTHING before calling this method!

Parameters:

lscConfigurationPath -

Throws:

LscException

assertPropertyNotEmpty

public static void assertPropertyNotEmpty(String propertyName,
                                          String propertyValue,
                                          String location)
                                   throws LscConfigurationException

Helper method to check that a String read in from a property is not empty or null

Parameters:

propertyName - Name of the property key as read from lsc.properties

propertyValue - Value read from the configuration

location - Where this property is read from, to display a meaningful error message (example: class name, task name, etc)

Throws:

RuntimeException - If the property is null or empty.

LscConfigurationException

setLoggingSetup

public static void setLoggingSetup(boolean loggingSetup)

Set the flag to determine if logging is configured or not yet

Parameters:

loggingSetup - Is logging setup yet?

isLoggingSetup

public static boolean isLoggingSetup()

Get the flag to determine if logging is configured or not yet

Returns:

boolean loggingSetup