opendj « Brian’s Stuff

The LDAP Maven Plugin was relying on the jcabi-aether library to resolve dependencies. When I first wrote the LDAP Maven Plugin I couldn’t find much information on how to resolve dependencies and jcabi-aether proved to be invaluable. Aether is dependency resolution framework used under the hood by Maven 3 and higher.

Aether was originally managed by Sonatype but it was moved to stewardship of the Eclipse foundation. Since Maven 3.1 the Eclipse version has been used.

Since I wanted to the maintain support for Maven 3.0.5 I decided to revert to the Maven 2 dependency resolution API.

In addition, I downgraded the version of ApacheDS used by the plugin to 1.5.5. I was having trouble resolving one of the transitive dependencies for 2.0.0-M15 during integration testing and I didn’t have any luck using the latest version (2.0.0-M17) or later. So I decided to downgrade for now and revisit the issue when ApacheDS 2.0.0 is released and documentation on embedding it becomes available.

The LDAP Maven Plugin is a Maven plugin that can:

Import/export data to/from a LDAP directory server. Both the LDIF and DSML formats are supported.
Launch and shutdown a LDAP directory server in the Maven build life-cycle. The plugin supports the following LDAP directory servers:

Importing or exporting data

The plugin provides the following goals to import or export content from a LDAP directory server:

load is used to load content from a file into a LDAP directory server.
dump is used to dump content to a file from a LDAP directory sever.

The following file formats are supported:

LDIF – LDAP Directory Interchange Format
DSML – Directory Services Markup Language

LDAP Data Interchange Format (LDIF)

Import

The following POM fragment demonstrates how to load content into a LDAP directory server from a LDIF formatted file using the load goal of the LDAP Maven Plugin.

<plugin> <groupId>com.btmatthews.maven.plugins</groupId> <artifactId>ldap-maven-plugin</artifactId> <version>1.2.0</version> <executions> <execution> <id>load</id> <goals> <goal>load</goal> </goals> <configuration> <host>localhost</host> <port>10389</port> <authDn>uid=admin,ou=system</authDn> <passwd>secret</passwd> <sources> <ldif>load.ldif</ldif> </sources> </configuration> </execution> </executions> </plugin>

Export

The following POM fragment demonstrates how to export content from a LDAP directory server to a LDIF formatted file using the dump goal of the LDAP Maven Plugin.

<plugin> <groupId>com.btmatthews.maven.plugins</groupId> <artifactId>ldap-maven-plugin</artifactId> <version>1.2.0</version> <executions> <execution> <id>dump</id> <goals> <goal>dump</goal> </goals> <configuration> <host>localhost</host> <port>10389</port> <authDn>uid=admin,ou=system</authDn> <passwd>secret</passwd> <searchBase>dc=btmatthews,dc=com</searchBase> <filename>dump.ldif</filename> <format>ldif</format> </configuration> </execution> </executions> </plugin>

Directory Service Markup Language (DSML)

Import

The following POM fragment demonstrates how to load content into a LDAP directory server from a DSML formatted file using the load goal of the LDAP Maven Plugin.

<plugin> <groupId>com.btmatthews.maven.plugins</groupId> <artifactId>ldap-maven-plugin</artifactId> <version>1.2.0</version> <executions> <execution> <id>load</id> <goals> <goal>load</goal> </goals> <configuration> <host>localhost</host> <port>10389</port> <authDn>uid=admin,ou=system</authDn> <passwd>secret</passwd> <sources> <dsml>${basedir}/load.dsml</dsml> </sources> </configuration> </execution> </executions> </plugin>

Export

The following POM fragment demonstrates how to export content from a LDAP directory server to a DSML formatted file using the dump goal of the LDAP Maven Plugin.

<plugin> <groupId>com.btmatthews.maven.plugins</groupId> <artifactId>ldap-maven-plugin</artifactId> <version>1.2.0</version> <executions> <execution> <id>dump</id> <goals> <goal>dump</goal> </goals> <configuration> <host>localhost</host> <port>10389</port> <authDn>uid=admin,ou=system</authDn> <passwd>secret</passwd> <searchBase>dc=btmatthews,dc=com</searchBase> <filename>dump.dsml</filename> <format>dsml</format> </configuration> </execution> </executions> </plugin>

Running an LDAP Server in the build life-cycle

pom.xml

The following POM fragment uses the run goal to launch an embedded LDAP directory server prior to the execution of the integration tests and then uses the stop goal to shutdown the embedded LDAP directory server upon completion of the integration tests.

<?xml version="1.0" encoding="UTF-8"?> <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation=" http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> <build> <pluginManagement> <plugins> <plugin> <groupId>com.btmatthews.maven.plugins</groupId> <artifactId>ldap-maven-plugin</artifactId> <version>1.2.0</version> </plugin> </plugins> </pluginManagement> <plugins> <plugin> <groupId>com.btmatthews.maven.plugins</groupId> <artifactId>ldap-maven-plugin</artifactId> <version>1.2.0</version> <configuration> <monitorPort>11389</monitorPort> <monitorKey>ldap</monitorKey> <daemon>true</daemon> </configuration> <executions> <execution> <id>start-ldap</id> <goals> <goal>run</goal> </goals> <phase>pre-integration-test</phase> </execution> <execution> <id>stop-ldap</id> <goals> <goal>stop</goal> </goals> <phase>post-integration-test</phase> </execution> </executions> </plugin> </plugins> </build> </project>

Connecting in Java

The following LDAP client libraries can be used to connect to the embedded LDAP server:

The LDAPUnit library provides an assortment of assertion and verification methods for use in unit and integration test cases.

Maven Central Coordinates

The LDAP Maven Plugin has been published in Maven Central at the following coordinates:

<plugin> <groupId>com.btmatthews.maven.plugins</groupId> <artifactId>ldap-maven-plugin</artifactId> <version>1.2.0</version> </plugin>

License & Source Code

The LDAP Maven Plugin is made available under the Apache License and the source code is hosted on GitHub at https://github.com/bmatthews68/ldap-maven-plugin.

Brian’s Stuff

Stuff I don’t want to forget (again!)

Tag Archives: opendj

LDAP Maven Plugin 1.3.0 Released

Release Announcement – LDAP Maven Plugin 1.2.0

Importing or exporting data

LDAP Data Interchange Format (LDIF)

Import

Export

Directory Service Markup Language (DSML)

Import

Export

Running an LDAP Server in the build life-cycle

pom.xml

Connecting in Java

Maven Central Coordinates

License & Source Code