dartdap library
LDAP v3 client library.
Basic usage:
- Create an LDAP connection (LdapConnection).
- Perform LDAP operations (
search,add,modify,modifyDN,compare,delete). - Close the connection (
close).
An overview of the exceptions used in this package can be found in the base exception class LdapException.
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.
- Ldap
- The Ldap Interface https://tools.ietf.org/html/rfc4511
- LdapConnection
- Connection to perform LDAP operations on an LDAP server.
- LdapConnectionPool
- LdapConnectionPool implements a very simple connection pool handler.
- LdapResult
- Generic LDAP Result
- LdapUtil
- Modification
- An LDAP modification operation type.
- QueryGrammarDefinition
- QueryParserDefinition
- ResultCode
- LDAP Result Codes
- SearchEntry
- Search entry result produced by the search operation.
- SearchResult
- Results from a search request.
- SearchScope
- ServerSideSortRequestControl
- ServerSideSortResponseControl
- https://tools.ietf.org/html/rfc2891
- SimplePagedResultsControl
- A Simple Paged Result Control The client sends this control to the server to get back paged results. The control is returned by the server. The cookie value returned in the control should be used to fetch the next page of results. See example/paged_search.dart for usage.
- 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 https://tools.ietf.org/html/draft-ietf-ldapext-ldapv3-vlv-09 VLV Request Control. The client sends this to the server to request a VLV search
- VLVResponseControl
Enums
- ConnectionState
- States for an LdapConnection.
Properties
- clogger ↔ Logger
-
Logger for the control section of dartdap.
getter/setter pair
Functions
-
parseQuery(
String input) → Filter
Typedefs
- BadCertHandlerType = bool Function(X509Certificate cert)
- Callback function type for handling bad certificates.
-
LdapFunction
= Future<
bool> Function(LdapConnection c)
Exceptions / Errors
- LdapCertificateException
- Exception when a bad certificate is encountered.
- LdapConfigException
- Exception thrown when the configuration file contains errors.
- LdapConnectionDisconnected
- Exception thrown when an open connection has been disconnected.
- LdapException
- Abstract base class for all LDAP exceptions.
- LdapParseException
- Exception when a problem is encountered with parsing received LDAP messages.
- LdapPoolException
- 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
- An LdapResult was received with a result code of 'No Such Object'.
- LdapResultNotAllowedOnNonleafException
- LdapResultNotAllowedOnRdnException
- LdapResultObjectClassModsProhibitedException
- LdapResultObjectClassViolationException
- LdapResultOperationsErrorException
- LdapResultOtherException
- LdapResultProtocolErrorException
- LdapResultReferralException
- LdapResultSaslBindInProgressException
- LdapResultSizeLimitExceededException
- LdapResultStrongAuthRequiredException
- LdapResultTimeLimitExceededException
- LdapResultUndefinedAttributeTypeException
- LdapResultUnknownCodeException
- Exception for LDAP result codes that are not handled by their own exceptions.
- LdapResultUnwillingToPerformException
- LdapSocketException
- Exception when a SocketException was raised.
- LdapSocketRefusedException
- Exception indicating the LDAP/LDAPS port could not be connected to.
- LdapSocketServerNotFoundException
- Exception indicating the server was not found.
- LdapUsageException
- Exception thrown when the library has been incorrectly used.