LDAP v3 client library.

Implemented operations include BIND, ADD, MODIFY, DEL, MODIFYDN, SEARCH, COMPARE

Usage

  1. Instantiate an LDAPConnection object.
  2. Call its connect method to connect to the LDAP directory.
  3. Call its bind method to authenticate to the LDAP directory, if needed.
  4. Perform LDAP operations using methods on it (e.g. search, add, delete).
  5. Call its close method when finished.

Please see the README for more details on how to use this package. In addition, an overview of the exceptions used in this package can be found in the base exception class LdapException.

Developers wanting to modify the package, please see the DEVEL.md file.

Classes

Attribute

Represents an LDAP Attribute.

ConnectionManager

Manages the state of the LDAP connection.

Control

An LDAP Control

DN

Utility for building DN's

Filter

An LDAP search filter.

LDAPConfiguration

LDAP configuration.

LDAPConnection

Operations that we can invoke on an LDAP server

LDAPResult

Generic LDAP Result

LDAPUtil

Modification

An LDAP modification operation type.

ResultCode

LDAP Result Codes

SearchEntry

Search entry result produced by the search operation.

SearchResult

Results from a search request.

SearchScope

ServerSideSortRequestControl

ServerSideSortResponseControl

SortKey

Description taken from OpenDJ SDK!!!

SubstringFilter

A Substring filter Clients should not need to invoke this directly. Use Filter.substring()

VLVRequestControl

Virtual List View Controls See http://www.ietf.org/archive/id/draft-ietf-ldapext-ldapv3-vlv-09.txt VLV Request Control. The client sends this to the server to request a VLV search

VLVResponseControl

Exceptions / Errors

LdapConfigException

Exception thrown when the configuration file contains errors.

LdapException

Abstract base class for all LDAP exceptions.

LdapParseException

Exception when a problem is encountered with parsing received LDAP messages.

LdapResultAdminLimitExceededException

LdapResultAffectsMultipleDsasException

LdapResultAliasDereferencingProblemException

LdapResultAliasProblemException

LdapResultAttributeOrValueExistsException

LdapResultAuthMethodNotSupportedException

LdapResultBusyException

LdapResultConfidentialityRequiredException

LdapResultConstraintViolationException

LdapResultEntryAlreadyExistsException

LdapResultException

Exception when an unsuccessful LDAP result is received.

LdapResultInappropriateAuthenticationException

LdapResultInappropriateMatchingException

LdapResultInsufficientAccessRightsException

LdapResultInvalidAttributeSyntaxException

LdapResultInvalidCredentialsException

LdapResultInvalidDnSyntaxException

LdapResultIsLeafException

LdapResultLoopDetectException

LdapResultNamingViolationException

LdapResultNoSuchAttributeException

LdapResultNoSuchObjectException

LdapResultNotAllowedOnNonleafException

LdapResultNotAllowedOnRdnException

LdapResultObjectClassModsProhibitedException

LdapResultObjectClassViolationException

LdapResultOperationsErrorException

LdapResultOtherException

LdapResultProtocolErrorException

LdapResultReferralException

LdapResultSaslBindInProgressException

LdapResultSizeLimitExceededException

LdapResultStrongAuthRequiredException

LdapResultTimeLimitExceededException

LdapResultUnavailableCriticalExtensionException

LdapResultUnavailableException

LdapResultUndefinedAttributeTypeException

LdapResultUnknownCodeException

Exception for LDAP result codes that are not handled by their own exceptions.

LdapResultUnwillingToPerformException

LdapSocketException

Exception when there is a connection problem.

LdapSocketRefusedException

LdapSocketServerNotFoundException

LdapUsageException

Exception thrown when the library has been incorrectly used.