Development Documentation

The following documentation is about developing LSC itself - not a LSC synchronization task. Make sure you've read all the general documentation before continuing here!

Working environment

As well as the general Requirements, you need some extra tools to hack LSC - make sure you get these set-up.

You should follow our defined code style.

Java API for LSC-core

The JavaDoc is generated from comments in LSC code. It needs a lot of improvement, all comments in code are very welcome!

This can be very useful to get a function name to call from SyncOptions in the configuration file (see AbstractBean, AD, ScriptableJndiServices, DateUtils…)

It is updated nightly based on the SVN trunk.

Development tools

Continuous build system

Hudson follows all commits on the SVN: http://build.lsc-project.org.

It provides LSC-core snapshots built against the latest source code here.

Regenerating the "generateWizard"

To do this, you must have installed and configured the path to AntInstaller as described here.

Then, in the lsc-sample directory, run the following command:

$ ant lsc::buildGenerateWizard

This will generate the file lib/lsc-sample-generator.jar.

To adapt what the wizard does, see the src/install/resources/build-generator.xml file, which is a normal Ant buildfile.

Modifying commonly-used Java classes

See this documentation, which is a bit out of date but still useful: Real-world modifications.

Releasing

See these notes on doing a release.

Packaging