====================================================================== DSML Tools 1.2.1 Binary Release Notes Last updated: April 13, 2005 ====================================================================== For information on this release, including the download location for the source to all the included software, see: http://www.dsmltools.org/ Introduction ------------ This software is a suite of tools for working with the Directory Services Markup Language (DSML). It provides the following capabilities: * Querying of an LDAP directory, with search results output as DSML * Import of DSML data into an LDAP directory * Directory-context validation of DSML (no illegal attributes on an entry etc.) * Directory-context diffing of two DSML documents All distributed software in the namespace "org.dsmltools" is dually licensed under the Mozilla Public License (MPL) and the GNU General Public License (GPL). Dependencies ------------ You can find links to the source for all the dependencies at: http://www.dsmltools.org/dependencies.html This binary release already contains the following required components: The Apache Xerces-J XML Parser 2.6.2 Netscape's LDAP Java SDK 4.1 The GNU Getopt library for Java 1.0.7 Therefore the DSML Tools, as packaged, have only one dependency - Java itself. * Java The DSML Tools have been tested with the Java SDK version 1.3 on Windows NT and 1.4 on Linux. You can download this from: http://java.sun.com/j2se/downloads.html You'll need to go through their web-based interface to get at the download. Note that this software will not work with Java 1.1, because it uses some Java 2-specific classes (e.g. HashSet). I see no reason why it wouldn't work with Java SDK 1.2, the first release of Java 2. Directory Compatibility ----------------------- The DSML Tools have been tested with OpenLDAP 2, Netscape Directory Server and DC-Directory. They should work with any directory that supports LDAP v3. Users of DC-Directory will need v2.4, build 20001002 or later. Installation ------------ Merely unpack the zip into a new directory. The unpack will create a directory called "dsmltools" and put the files in it. You can either add all four .jar files to your CLASSPATH environment variable, or add -cp dsmltools.jar:xmlParserAPIs.jar:xercesImpl.jar:ldapjdk.jar to the command line options when you invoke Java, as below. Usage Instructions ------------------ Once you've installed Java and the software, and made sure that all the correct .jar files have been added to your classpath, you run the software as follows: java org.dsmltools. where is one of LDAP2DSML, DSML2LDAP, DSMLDiff and DSMLValidate. Please see the javadoc documentation for usage instructions for the software. Each of the programs should be explained on the javadoc page for that class. Alternatively, passing the option '-?' or '--help' will produce usage information. Note: If the DSML Tools believe that your DSML, or the data returned by your directory, is invalid (and validation is turned on) it will attempt to fix the problems, while writing errors to stderr. Many directories on the market today violate standards and so the DSML Tools may object to the information they return in this way. If this is a problem for you, you can turn validation off with the '-q' option. Changelog --------- See the file HISTORY. Gerv This product includes software developed by the Apache Software Foundation (http://www.apache.org/).