Spring/spring-ldap
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

LDAP-266: Documentation

Browse Source
This commit is contained in:
Mattias Hellborg Arthursson
2013-10-21 09:43:57 +02:00
parent 983d183bb1
commit 8d1d5f9759
2 changed files with 35 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
src/docbkx/index.xml
View File

@@ -44,6 +44,7 @@
<xi:include href="odm.xml" />
<xi:include href="advancedqueries.xml" />
<xi:include href="configuration.xml" />
<xi:include href="repositories.xml" />
<xi:include href="pooling.xml" />
<xi:include href="executors.xml" />
<xi:include href="contextprocessor.xml" />

34
src/docbkx/repositories.xml Normal file
View File

@@ -0,0 +1,34 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter id="repositories">
<title>Spring LDAP Repositories</title>
<sect1 id="repositories-overview">
<title>Overview</title>
<para>
Spring LDAP has built-in support for Spring Data repositories. The basic functionality and configuration is described <ulink
url="http://docs.spring.io/spring-data/data-commons/docs/1.6.1.RELEASE/reference/html/repositories.html">here</ulink>.
When working with Spring LDAP repositories, please note the following:
<itemizedlist>
<listitem>
Spring LDAP repositories can be enabled using an <literal>&lt;ldap:repositories&gt;</literal> tag in
your XML configuration or using an <literal>@EnableLdapRepositories</literal> annotation on a
configuration class.
</listitem>
<listitem>
All Spring LDAP repositories must work with entities annotated with the ODM annotations, as described
in <xref linkend="odm" />.
</listitem>
<listitem>
Since all ODM managed classes must have a Distinguished Name as ID, all Spring LDAP repositories must
have the ID type parameter set to <literal>javax.naming.Name</literal>. Indeed, the built-in
<literal>SpringLdapRepository</literal> only takes one type parameter; the managed entity class, defaulting
ID to <literal>javax.naming.Name</literal>.
</listitem>
<listitem>
Due to specifics of the LDAP protocol, paging and sorting is not supported for Spring LDAP repositories.
</listitem>
</itemizedlist>
</para>
</sect1>
</chapter>