|
| 1 | +[](https://gitter.im/spring-projects/spring-ldap?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) |
| 2 | + |
| 3 | +[](https://travis-ci.org/spring-projects/spring-ldap) |
| 4 | + |
| 5 | +[](https://ge.spring.io/scans?search.rootProjectNames=spring-ldap) |
| 6 | + |
| 7 | += Spring LDAP |
| 8 | + |
| 9 | +Spring LDAP is a library to simplify LDAP programming in Java, built on the same |
| 10 | +principles as Spring Jdbc. |
| 11 | + |
| 12 | +The LdapTemplate class encapsulates all the plumbing work involved in traditional LDAP |
| 13 | +programming, such as creating, looping through NamingEnumerations, handling Exceptions |
| 14 | +and cleaning up resources. This leaves the programmer to handle the important stuff - |
| 15 | +where to find data (DNs and Filters) and what to do with it (map to and from domain |
| 16 | +objects, bind, modify, unbind, etc.), in the same way that JdbcTemplate relieves the |
| 17 | +programmer of all but the actual SQL and how the data maps to the domain model. |
| 18 | + |
| 19 | +In addition to this, Spring LDAP provides Exception translation from NamingExceptions |
| 20 | +to an unchecked exception hierarchy, as well as several utilities for working with filters, |
| 21 | +LDAP paths and attributes. |
| 22 | + |
| 23 | +For detailed information on the project, please refer to the [reference documentation](https://docs.spring.io/spring-ldap/docs/current/reference/) and [javadocs](https://docs.spring.io/spring-ldap/docs/2.3.x/apidocs/). |
| 24 | +See [the changelog](https://github.com/spring-projects/spring-ldap/releases) for detailed information on changes in the latest version. |
| 25 | + |
| 26 | +== Code of Conduct |
| 27 | +This project adheres to the Contributor Covenant [code of conduct](CODE_OF_CONDUCT.adoc). |
| 28 | +By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected]. |
| 29 | + |
| 30 | +== Downloading Artifacts |
| 31 | +See https://docs.spring.io/spring-ldap/reference/getting-spring-ldap.html[Getting Spring LDAP] for how to obtain Spring LDAP. |
| 32 | + |
| 33 | +== Documentation |
| 34 | + |
| 35 | +Be sure to read the https://docs.spring.io/spring-ldap/reference/[Spring LDAP Reference]. |
| 36 | +Extensive JavaDoc for the Spring LDAP code is also available in the https://docs.spring.io/spring-ldap/site/docs/current/api/[Spring LDAP API Documentation]. |
| 37 | + |
| 38 | +You may also want to check out https://github.com/spring-projects/spring-ldap/releases[the change log for new features]. |
| 39 | + |
| 40 | +== Building from Source |
| 41 | + |
| 42 | +Spring LDAP uses a https://gradle.org[Gradle]-based build system. |
| 43 | +In the instructions below, https://vimeo.com/34436402[`./gradlew`] is invoked from the root of the source tree and serves as |
| 44 | +a cross-platform, self-contained bootstrap mechanism for the build. |
| 45 | + |
| 46 | +=== Prerequisites |
| 47 | +https://docs.github.com/en/get-started/quickstart/set-up-git[Git] and the https://www.oracle.com/java/technologies/downloads/#java17[JDK17 build]. |
| 48 | + |
| 49 | +Be sure that your `JAVA_HOME` environment variable points to the `jdk-17` folder extracted from the JDK download. |
| 50 | + |
| 51 | +=== Check out sources |
| 52 | +[indent=0] |
| 53 | +---- |
| 54 | +git clone [email protected]:spring-projects/spring-ldap.git |
| 55 | +---- |
| 56 | + |
| 57 | +=== Install all `spring-*.jar` into your local Maven repository. |
| 58 | + |
| 59 | +[indent=0] |
| 60 | +---- |
| 61 | +./gradlew publishToMavenLocal |
| 62 | +---- |
| 63 | + |
| 64 | +=== Compile and test; build all JARs, distribution zips, and docs |
| 65 | + |
| 66 | +[indent=0] |
| 67 | +---- |
| 68 | +./gradlew build |
| 69 | +---- |
| 70 | + |
| 71 | +The reference docs are not currently included in the distribution zip. |
| 72 | +You can build the reference docs for this branch by running the following command: |
| 73 | + |
| 74 | +---- |
| 75 | +./gradlew :spring-ldap-docs:antora |
| 76 | +---- |
| 77 | + |
| 78 | +That command publishes the docs site to the `_docs/build/site_` directory. |
| 79 | +The https://github.com/spring-projects/spring-ldap/tree/docs-build[playbook branch] describes how to build the reference docs in detail. |
| 80 | + |
| 81 | +Discover more commands with `./gradlew tasks`. |
| 82 | + |
| 83 | +== Getting Support |
| 84 | +Check out the https://stackoverflow.com/questions/tagged/spring-ldap[Spring LDAP tags on Stack Overflow]. |
| 85 | +https://spring.io/support[Commercial support] is available too. |
| 86 | + |
| 87 | +== Contributing |
| 88 | +https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request[Pull requests] are welcome; see the https://github.com/spring-projects/spring-ldap/blob/main/CONTRIBUTING.adoc[contributor guidelines] for details. |
| 89 | + |
| 90 | +== License |
| 91 | +Spring LDAP is Open Source software released under the |
| 92 | +https://www.apache.org/licenses/LICENSE-2.0.html[Apache 2.0 license]. |
0 commit comments