diff --git a/build.gradle b/build.gradle index 3ed9f5c0..9d945dd1 100644 --- a/build.gradle +++ b/build.gradle @@ -120,7 +120,7 @@ task distZip(type: Zip, dependsOn: [docsZip]) { from("src/dist") { - include "readme.txt" + include "readme.md" include "license.txt" include "notice.txt" into "${baseDir}" diff --git a/readme.md b/readme.md new file mode 100644 index 00000000..1ea85f13 --- /dev/null +++ b/readme.md @@ -0,0 +1,81 @@ +##Spring LDAP + +###INTRODUCTION + +Spring LDAP is a library to simplify LDAP programming in Java, built on the same +principles as Spring Jdbc. + +The LdapTemplate class encapsulates all the plumbing work involved in traditional LDAP +programming, such as creating, looping through NamingEnumerations, handling Exceptions +and cleaning up resources. This leaves the programmer to handle the important stuff - +where to find data (DNs and Filters) and what do do with it (map to and from domain +objects, bind, modify, unbind, etc.), in the same way that JdbcTemplate relieves the +programmer of all but the actual SQL and how the data maps to the domain model. + +In addition to this, Spring LDAP provides Exception translation from NamingExceptions +to an unchecked exception hirearchy, as well as several utilities for working with filters, +LDAP paths and Attributes. + +As of version 1.2, support for client-side compensating transaction is provided, as well as +Java 5 generics support with the SimpleLdapTemplate. + +As of version 1.3.1, there is support for LDIF parsing and Object-Directory Mapping (ODM). + +For detailed information on the project, please refer to the [reference documentation](http://static.springsource.org/spring-ldap/docs/1.3.x/reference/html/) and [javadocs](http://static.springsource.org/spring-ldap/site/apidocs/). +See [the changelog](https://jira.springsource.org/browse/LDAP#selectedTab=com.atlassian.jira.plugin.system.project%3Achangelog-panel) for detailed information on changes. + +###MAVEN USERS + +All major releases of this library are available in the central Maven repository. +The following components are available: + +* spring-ldap-core - the core Spring LDAP library +* spring-ldap-tiger - the Spring LDAP Java 5 support library +* spring-ldap-test - support classes that helps LDAP with integration testing +* spring-ldap-ldif-core - the Spring LDAP LDIF parsing library +* spring-ldap-ldif-batch - the Spring Batch integration layer for the LDIF parsing library +* spring-ldap-odm - The Object-Directory Mapping (ODM) framework + +To include e.g. the spring-ldap-core component in your project, use the following dependency tag: + + + org.springframework.ldap + spring-ldap-core + 1.3.1.RELEASE + + +Milestone releases (such as release candidates) are available from the Spring +framework milestone repo: + + + spring-milestone + Spring Portfolio Milestone Repository + http://maven.springframework.org/milestone + + +Snapshot builds produced by the CI builds are available from the Spring framework snapshot repo: + + + spring-milestone + Spring Portfolio Milestone Repository + http://maven.springframework.org/snapshot + + +In order to e.g. try out the latest build snapshot of the core module, include the repository above and +use the following dependency tag: + + + org.springframework.ldap + spring-ldap-core + 1.3.2.CI-SNAPSHOT + + +Note that while all milestone and snapshot builds have passed the (quite extensive) test suite, +the artifacts here are obviously still work in progress. Feel free to use them for trying out new functionality +and bug fixes for an upcoming version. Please report any problems or bugs in the [issue tracker](https://jira.springsource.org/browse/LDAP). + +###ADDITIONAL RESOURCES + +* [Official site](http://www.springframework.org/ldap) +* [Support forum](http://forum.springframework.org/forumdisplay.php?f=40) +* [Issue tracker](https://jira.springsource.org/browse/LDAP) diff --git a/readme.txt b/readme.txt deleted file mode 100644 index 3ff8dede..00000000 --- a/readme.txt +++ /dev/null @@ -1,181 +0,0 @@ -Spring LDAP 1.3.1 (Nov 2010) ----------------------------- -http://www.springframework.org/ldap -http://forum.springframework.org/forumdisplay.php?f=40 - -1. INTRODUCTION - -Spring LDAP is a library to simplify LDAP programming in Java, built on the same -principles as Spring Jdbc. - -The LdapTemplate class encapsulates all the plumbing work involved in traditional LDAP -programming, such as creating, looping through NamingEnumerations, handling Exceptions -and cleaning up resources. This leaves the programmer to handle the important stuff - -where to find data (DNs and Filters) and what do do with it (map to and from domain -objects, bind, modify, unbind, etc.), in the same way that JdbcTemplate relieves the -programmer of all but the actual SQL and how the data maps to the domain model. - -In addition to this, Spring LDAP provides Exception translation from NamingExceptions -to an unchecked exception hirearchy, as well as several utilities for working with filters, -LDAP paths and Attributes. - -As of version 1.2, support for client-side compensating transaction is provided, as well as -Java 5 generics support with the SimpleLdapTemplate. - -As of version 1.3.1, there is support for LDIF parsing and Object-Directory Mapping (ODM). - -See changelog.txt for detailed information on the changes included in the current release. - -2. RELEASE INFO - -Spring LDAP requires J2SE 1.4 and Spring 2.x for running. J2SE 1.5 is required for building. -J2EE 1.4 (Servlet 2.3, JSP 1.2) is required for running the example. - -"." contains Spring LDAP distribution units (jars and source zip archives), readme, and copyright -"dist" contains the Spring LDAP distribution -"dist/modules" contains the Spring LDAP modules - -The -with-dependencies distribution contains the following additional content: - -"dist/module-sources" contains the Spring LDAP modules -"docs" contains the Spring LDAP reference manual and API Javadocs -"samples" contains buildable Spring LDAP sample application sources -"lib" contains the Spring LDAP dependencies - -Nightly builds are available for download from: -http://static.springframework.org/spring-ldap/downloads/1.3-snapshot-download.php - -Spring LDAP is released under the terms of the Apache Software License (see license.txt). - -3. DISTRIBUTION JAR FILES - -The following distinct jar files are included in the distribution. This list -specifies the respective contents and third-party dependencies. - -* spring-ldap-core-1.3.1.RELEASE.jar -- Contents: The Spring LDAP library -- Dependencies: Commons Logging, Commons Lang, Commons Pool, spring-beans, - spring-core, spring-context, spring-jdbc, spring-tx, ldapbp - -* spring-ldap-core-tiger-1.3.1.RELEASE.jar -- Contents: The Spring LDAP Java 5 support library -- Dependencies: Commons Logging, Commons Lang, Commons Pool, spring-beans, - spring-core, spring-context, spring-jdbc, spring-tx, ldapbp - -* spring-ldap-test-1.3.1.RELEASE.jar -- Contents: Support classes that helps LDAP with integration testing. -- Dependencies: Commons Logging, Commons Lang, Commons Pool, spring-beans, - spring-core, spring-context, spring-jdbc, spring-tx, ldapbp - -* spring-ldap-ldif-core-1.3.1.RELEASE.jar -- Contents: The Spring LDAP LDIF parsing library. -- Dependencies: Commons Logging, Commons Lang, spring-beans, spring-core, - spring-ldap-core - -* spring-ldap-ldif-batch-1.3.1.RELEASE.jar -- Contents: The Spring Batch integration layer for the LDIF parsing library. -- Dependencies: Commons Logging, spring-batch, spring-beans, spring-core, - spring-ldap-core, spring-ldap-ldif-core - -* spring-ldap-odm-1.3.1.RELEASE.jar -- Contents: The Object-Directory Mapping (ODM) framework. -- Dependencies: Commons Logging, Commons CLI, spring-beans, spring-ldap-core, - spring-ldap-core-tiger - -4. MAVEN USERS - -All major releases of this library are available in the central Maven repository. -Note that the artifacts have changed names between the 1.2.x and 1.3 releases: -spring-ldap is now spring-ldap-core -spring-ldap-tiger is now spring-ldap-core-tiger - -This means that in order to use the latest release (1.3.1.RELEASE), you need to -include the following dependencies: - - - org.springframework.ldap - spring-ldap-core - 1.3.1.RELEASE - - -For Java 1.5 support: - - - org.springframework.ldap - spring-ldap-core-tiger - 1.3.1.RELEASE - - -Milestone releases (such as release candidates) are available from the Spring -framework milestone repo: - - - spring-milestone - Spring Portfolio Milestone Repository - http://s3.amazonaws.com/maven.springframework.org/milestone - - -This means that in order to use a milestone or release candidate, you need to -specify the repository above and include the following dependencies: - - - org.springframework.ldap - spring-ldap-core - 2.0.0.RC1 - - -For Java 1.5 support: - - - org.springframework.ldap - spring-ldap-core-tiger - 2.0.0.RC1 - - -Nighly builds are published to the snapshot repository: - - - spring-snapshot - Spring Portfolio Snapshot Repository - http://s3.amazonaws.com/maven.springframework.org/snapshot - - - - org.springframework.ldap - spring-ldap-core - 2.0.0.CI-SNAPSHOT - - -For Java 1.5 support: - - org.springframework.ldap - spring-ldap-core-tiger - 2.0.0.CI-SNAPSHOT - - -5. WHERE TO START - -This distribution contains documentation and a sample application illustrating -the features of Spring LDAP. - -A great way to get started is to review and run the sample application, -supplementing with reference manual material as needed. You will require -Maven 2, which can be downloaded from http://maven.apache.org/, for building -Spring LDAP. To build deployable .war files for all samples, simply access the -"samples" directory and execute the "mvn package" command. Alternatively, go -to a sample and run "mvn jetty:run" to run the sample directly in a Jetty 6 Web -container. - -6. ADDITIONAL RESOURCES - -The Spring LDAP homepage can be found at the following URL: - - http://www.springframework.org/ldap - -Spring LDAP support forums are located at: - - http://forum.springframework.org/forumdisplay.php?f=40 - -The Spring Framework portal is located at: - - http://www.springframework.org diff --git a/src/assembly/all.xml b/src/assembly/all.xml deleted file mode 100644 index 0081d929..00000000 --- a/src/assembly/all.xml +++ /dev/null @@ -1,37 +0,0 @@ - - - all - - jar - - false - - - - org.springframework.ldap:spring-ldap-core - org.springframework.ldap:spring-ldap-core-tiger - org.springframework.ldap:spring-ldap-odm - org.springframework.ldap:spring-ldap-ldif-core - org.springframework.ldap:spring-ldap-ldif-batch - org.springframework.ldap:spring-ldap-test - - - - false - true - - - **/spring.handlers - **/spring.schemas - - - - - - - - src/main/resources/META-INF - META-INF - - - diff --git a/src/assembly/docs.xml b/src/assembly/docs.xml deleted file mode 100644 index 2a9ee5af..00000000 --- a/src/assembly/docs.xml +++ /dev/null @@ -1,16 +0,0 @@ - - - - - . - - readme.txt - license.txt - notice.txt - changelog.txt - - - dos - - - \ No newline at end of file diff --git a/src/assembly/minimal.xml b/src/assembly/minimal.xml deleted file mode 100644 index faec3416..00000000 --- a/src/assembly/minimal.xml +++ /dev/null @@ -1,34 +0,0 @@ - - - minimal - - zip - - - src/assembly/docs.xml - - true - - - - org.springframework.ldap:spring-ldap-core - org.springframework.ldap:spring-ldap-core-tiger - org.springframework.ldap:spring-ldap-odm - org.springframework.ldap:spring-ldap-ldif-core - org.springframework.ldap:spring-ldap-ldif-batch - org.springframework.ldap:spring-ldap-test - - - false - false - dist/modules/${module.artifactId}-${module.version}.${module.extension} - - - - - - target/${artifactId}-${version}-all.jar - dist - - - diff --git a/src/assembly/sources.xml b/src/assembly/sources.xml deleted file mode 100644 index 5715bf2c..00000000 --- a/src/assembly/sources.xml +++ /dev/null @@ -1,34 +0,0 @@ - - - sources - - jar - - false - - - core/src/main/java - - - - core-tiger/src/main/java - - - - odm/src/main/java - - - - ldif/ldif-core/src/main/java - - - - ldif/ldif-batch/src/main/java - - - - test-support/src/main/java - - - - diff --git a/src/assembly/with-dependencies.xml b/src/assembly/with-dependencies.xml deleted file mode 100644 index 7fae2df2..00000000 --- a/src/assembly/with-dependencies.xml +++ /dev/null @@ -1,90 +0,0 @@ - - with-dependencies - - zip - - - src/assembly/docs.xml - - true - - - - org.springframework.ldap:spring-ldap-parent - org.springframework.ldap:spring-ldap-core - org.springframework.ldap:spring-ldap-core-tiger - org.springframework.ldap:spring-ldap-odm - org.springframework.ldap:spring-ldap-ldif-core - org.springframework.ldap:spring-ldap-ldif-batch - org.springframework.ldap:spring-ldap-test - - - false - false - dist/modules/${module.artifactId}-${module.version}.${module.extension} - - - - - src/main/java - - - dist/module-sources/${module.artifactId} - - - - - - target/${artifactId}-${version}-all.jar - dist - - - target/${artifactId}-${version}-sources.jar - dist - - - - - - target/site/apidocs - docs/api - - - target/site/reference - docs/reference - - - - target/dependency - lib - - **/*.jar - - - - - samples - samples - - **/readme.txt - - dos - - - samples - samples - - **/src/** - **/build*.xml - **/*.bat - **/pom.xml - - - **/target - **/target/** - **/bin - **/bin/** - - - -