b2a0b09143
This change publishes a build scan to ge.spring.io for every local build from an authenticated Spring committer and for CI where appropriate access tokens are available. The build will not fail if publishing fails. This change also allows the build to benefit from local and remote build caching, providing faster builds for all contributors. Additionally, the project will have access to all features of Gradle Enterprise such as: - Dashboards to view all historical build scans, along with performance trends over time - Build failure analytics for enhanced investigation and diagnosis of build failures - Test failure analytics to better understand trends and causes around slow, failing, and flaky tests See #445
147 lines
6.2 KiB
Plaintext
147 lines
6.2 KiB
Plaintext
= Spring Data LDAP image:https://jenkins.spring.io/buildStatus/icon?job=spring-data-ldap%2Fmain&subject=Build[link=https://jenkins.spring.io/view/SpringData/job/spring-data-ldap/] https://gitter.im/spring-projects/spring-data[image:https://badges.gitter.im/spring-projects/spring-data.svg[Gitter]] image:https://img.shields.io/badge/Revved%20up%20by-Gradle%20Enterprise-06A0CE?logo=Gradle&labelColor=02303A["Revved up by Gradle Enterprise", link="https://ge.spring.io/scans?search.rootProjectNames=Spring Data LDAP"]
|
||
|
||
The primary goal of the https://projects.spring.io/spring-data[Spring Data] project is to make it easier to build Spring-powered applications that use new data access technologies such as non-relational databases, map-reduce frameworks, and cloud based data services.
|
||
|
||
The Spring Data LDAP project aims to provide familiar and consistent repository abstractions for https://github.com/spring-projects/spring-ldap[Spring LDAP].
|
||
|
||
== Features
|
||
|
||
* Spring configuration support using Java-based `@Configuration` classes or an XML namespace.
|
||
* Annotation based mapping metadata.
|
||
* Automatic implementation of Repository interfaces including support for custom query methods.
|
||
* QueryDSL integration to support type-safe queries.
|
||
|
||
== Code of Conduct
|
||
|
||
This project is governed by the https://github.com/spring-projects/.github/blob/e3cc2ff230d8f1dca06535aa6b5a4a23815861d4/CODE_OF_CONDUCT.md[Spring Code of Conduct]. By participating, you are expected to uphold this code of conduct. Please report unacceptable behavior to spring-code-of-conduct@pivotal.io.
|
||
|
||
== Getting Started
|
||
|
||
Here is a quick teaser of an application using Spring Data Repositories in Java:
|
||
|
||
[source,java]
|
||
----
|
||
public interface PersonRepository extends CrudRepository<Person, Long> {
|
||
|
||
List<Person> findByLastname(String lastname);
|
||
|
||
List<Person> findByFirstnameLike(String firstname);
|
||
}
|
||
|
||
@Service
|
||
public class MyService {
|
||
|
||
private final PersonRepository repository;
|
||
|
||
public MyService(PersonRepository repository) {
|
||
this.repository = repository;
|
||
}
|
||
|
||
public void doWork() {
|
||
|
||
repository.deleteAll();
|
||
|
||
Person person = new Person();
|
||
person.setFirstname("Rob");
|
||
person.setLastname("Winch");
|
||
repository.save(person);
|
||
|
||
List<Person> lastNameResults = repository.findByLastname("Winch");
|
||
List<Person> firstNameResults = repository.findByFirstnameLike("R*");
|
||
}
|
||
}
|
||
|
||
@Configuration
|
||
@EnableLdapRepositories
|
||
class ApplicationConfig {
|
||
|
||
}
|
||
----
|
||
|
||
=== Maven configuration
|
||
|
||
Add the Maven dependency:
|
||
|
||
[source,xml]
|
||
----
|
||
<dependency>
|
||
<groupId>org.springframework.data</groupId>
|
||
<artifactId>spring-data-ldap</artifactId>
|
||
<version>${version}</version>
|
||
</dependency>
|
||
----
|
||
|
||
If you'd rather like the latest snapshots of the upcoming major version, use our Maven snapshot repository and declare the appropriate dependency version.
|
||
|
||
[source,xml]
|
||
----
|
||
<dependency>
|
||
<groupId>org.springframework.data</groupId>
|
||
<artifactId>spring-data-ldap</artifactId>
|
||
<version>${version}-SNAPSHOT</version>
|
||
</dependency>
|
||
|
||
<repository>
|
||
<id>spring-snapshot</id>
|
||
<name>Spring Snapshot Repository</name>
|
||
<url>https://repo.spring.io/snapshot</url>
|
||
</repository>
|
||
----
|
||
|
||
== Getting Help
|
||
|
||
Having trouble with Spring Data? We’d love to help!
|
||
|
||
* Check the
|
||
https://docs.spring.io/spring-data/ldap/reference/[reference documentation], and https://docs.spring.io/spring-data/ldap/docs/current/api/[Javadocs].
|
||
* Learn the Spring basics – Spring Data builds on Spring Framework, check the https://spring.io[spring.io] web-site for a wealth of reference documentation.
|
||
If you are just starting out with Spring, try one of the https://spring.io/guides[guides].
|
||
* If you are upgrading, check out the https://docs.spring.io/spring-data/ldap/docs/current/changelog.txt[changelog] for "`new and noteworthy`" features.
|
||
* Ask a question - we monitor https://stackoverflow.com[stackoverflow.com] for questions tagged with https://stackoverflow.com/tags/spring-data[`spring-data-ldap`].
|
||
You can also chat with the community on https://gitter.im/spring-projects/spring-data[Gitter].
|
||
* Report bugs with Spring Data LDAP at https://github.com/spring-projects/spring-data-ldap/issues[github.com/spring-projects/spring-data-ldap/issues].
|
||
|
||
== Reporting Issues
|
||
|
||
Spring Data uses GitHub as issue tracking system to record bugs and feature requests. If you want to raise an issue, please follow the recommendations below:
|
||
|
||
* Before you log a bug, please search the
|
||
https://github.com/spring-projects/spring-data-ldap/issues[issue tracker] to see if someone has already reported the problem.
|
||
* If the issue doesn’t already exist, https://github.com/spring-projects/spring-data-ldap/issues/new[create a new issue].
|
||
* Please provide as much information as possible with the issue report, we like to know the version of Spring Data that you are using and JVM version.
|
||
* If you need to paste code, or include a stack trace use Markdown +++```+++ escapes before and after your text.
|
||
* If possible try to create a test-case or project that replicates the issue. Attach a link to your code or a compressed file containing your code.
|
||
|
||
== Building from Source
|
||
|
||
You don’t need to build from source to use Spring Data (binaries in https://repo.spring.io[repo.spring.io]), but if you want to try out the latest and greatest, Spring Data can be easily built with the https://github.com/takari/maven-wrapper[maven wrapper].
|
||
You also need JDK 1.8.
|
||
|
||
[source,bash]
|
||
----
|
||
$ ./mvnw clean install
|
||
----
|
||
|
||
If you want to build with the regular `mvn` command, you will need https://maven.apache.org/run-maven/index.html[Maven v3.8.0 or above].
|
||
|
||
_Also see link:CONTRIBUTING.adoc[CONTRIBUTING.adoc] if you wish to submit pull requests, and in particular please sign the https://cla.pivotal.io/sign/spring[Contributor’s Agreement] before your first non-trivial change._
|
||
|
||
=== Building reference documentation
|
||
|
||
Building the documentation builds also the project without running tests.
|
||
|
||
[source,bash]
|
||
----
|
||
$ ./mvnw clean install -Pantora
|
||
----
|
||
|
||
The generated documentation is available from `target/antora/site/index.html`.
|
||
|
||
== Examples
|
||
|
||
* https://github.com/spring-projects/spring-data-examples/[Spring Data Examples] contains example projects that explain specific features in more detail.
|
||
|
||
== License
|
||
|
||
Spring Data LDAP is Open Source software released under the https://www.apache.org/licenses/LICENSE-2.0.html[Apache 2.0 license].
|