Users guide

This documentation is about the newly LDAP API developped at the Apache Software Foundation. We expect this API will be a replacement for all the ancient API (jLdap, Mozilla LDAP SDK and JNDI).

About this guide

Getting started. Learn how to use the LDAP API, connect to various LDAP server, manipulate the data within your directory.

Audience

This guide is primarily for people new to the LDAP API. If you plan to use the API as is, maybe even for your first LDAP experience, you'll (hopefully) find all information necessary to do so. Only basic tasks are covered. Learn more about the options you have (and many other things) in the [Advanced User's Guide].

Feedback welcome!

We are quite interested to improve the content of this guide. Feel free to provide us feedback: !email.png! mailto:users@directory.apache.org

Table of contents

• 1 - Introduction

  • 1.1 - Java and LDAP
  • 1.2 - LDAP in a few words
  • 1.3 - The Apache LDAP API rational
  • 1.4 - Preparation to code

• 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 (e)
  • 2.7 - Moving an renaming entries (e)
  • 2.8 - Comparing entries (e)
  • 2.9 - Exception management (...)

• 3 - Advanced LDAP API usage (...)

  • 3.1 - Controls (...)
  • 3.2 - Extended operations (e)
  • 3.3 - Referrals (e)
  • 3.4 - Aliases (e)
  • 3.5 - LDIF, DSML (...)
  • 3.6 - Abandonning an operation (e)
  • 3.7 - Server informations (e)

• 4 - SchemaManagement (...)

  • 4.1 - SchemaManager (...)
  • 4.2 - AttributeTypes (e)
  • 4.3 - DITContentRules (e)
  • 4.4 - DITStructureRules (e)
  • 4.5 - MatchingRules (e)
  • 4.6 - MatchingRuleUses (e)
  • 4.7 - ObjectClasses (e)
  • 4.8 - NameForms (e)
  • 4.9 - Syntaxes (e)

• 5 - LDAP security (e)

  • 5.1 - ACI and ACLs (e)
  • 5.2 - SSL (e)
  • 5.3 - StartTLS (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 (e)
  • 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