Users guide
This document is about the LDAP API, developed at the Apache Software Foundation. It’s a replacement for outdated Java/LDAP libraries like (jLdap, Mozilla LDAP SDK and JNDI).
About this guide
Getting started. Learn how to use the LDAP API, connect to various LDAP servers, manipulate the data within a directory.
Audience
This guide is for anyone wanting to learn how to use the LDAP API. If you plan to use the API, maybe even for your first LDAP experience, you’ll find information here to help. Right now we’ve got pretty good coverage of the basic tasks. Later, we’ll add more advanced use cases so keep checking back. To learn about advanced options (and many other things) go to the [Advanced User’s Guide].
Feedback welcome!
We are interested in improving the content of this guide. Feel free to provide feedback: !email.png! mailto:users@directory.apache.org
Table of contents
- 1 - Introduction
- 2 - Basic LDAP API usage (…)
- 2.1 - Connection and disconnection
- 2.2 - Binding and unbinding
- 2.3 - Searching (…)
- 2.4 - Adding entries
- 2.5 - Deleting entries
- 2.6 - Modifying entries
- 2.7 - Moving an renaming entries (e)
- 2.8 - Comparing entries (e)
- 2.9 - Exception management (…)
- 2.10 - The LdapConnectionTemplate
- 2.11 - The FilterBuilder
- 3 - Advanced LDAP API usage (…)
- 4 - SchemaManagement (…)
- 5 - LDAP security (e)
- 6 - LDAP data structures (…)
- 6.1 - AdministrativePoint (e)
- 6.2 - AdministrativeRole (e)
- 6.3 - Attribute
- 6.4 - AttributeType (…)
- 6.5 - Ava
- 6.6 - Csn
- 6.7 - Control (…)
- 6.8 - Cursor (e)
- 6.9 - Dn
- 6.10 - DITContentRule (e)
- 6.11 - DITStructureRule (e)
- 6.12 - Entry
- 6.13 - ExprNode
- 6.14 - LdapComparator (e)
- 6.15 - LdapResult
- 6.16 - LdapSyntax (e)
- 6.17 - LdapUrl (…)
- 6.18 - LdifControl (e)
- 6.19 - LdifEntry
- 6.20 - MatchingRule (e)
- 6.21 - MatchingRuleUse (e)
- 6.22 - Message (…)
- 6.23 - Modification
- 6.24 - NameForm (e)
- 6.25 - Normalizer (e)
- 6.26 - ObjectClass (e)
- 6.27 - Oid
- 6.28 - Rdn
- 6.29 - Referral (e)
- 6.30 - Refinment (e)
- 6.31 - SchemaManager (e)
- 6.32 - Subentry (e)
- 6.33 - SubtreeSpecification (e)
- 6.34 - SyntaxChecker (e)
- 6.35 - Value
- 7 - Requests and Responses (…)
- 7.1 - AbandonRequest
- 7.2 - AddRequest
- 7.3 - AddResponse
- 7.4 - BindRequest
- 7.5 - BindResponse
- 7.6 - CompareRequest
- 7.7 - CompareResponse
- 7.8 - DelRequest
- 7.9 - DelResponse
- 7.10 - ExtendedRequest
- 7.11 - ExtendedResponse
- 7.12 - IntermediateResponse
- 7.13 - ModDnRequest
- 7.14 - ModDnResponse
- 7.15 - ModifyRequest
- 7.16 - ModifyResponse
- 7.17 - SearchRequest
- 7.18 - SearchResultDone
- 7.19 - SearchResultEntry
- 7.20 - SearchResultReference
- 7.21 - UnbindRequest
- 8 - LDAP related RFCs