Go to the documentation of this file.
7 #ifndef LDAP_CONNECTION_H
8 #define LDAP_CONNECTION_H
51 LDAPConnection(
const std::string& hostname=
"localhost",
int port=389,
70 void init(
const std::string& hostname,
int port);
90 void bind(
const std::string& dn=
"",
const std::string& passwd=
"",
183 void rename(
const std::string& dn,
const std::string& newRDN,
184 bool delOldRDN=
false,
const std::string& newParentDN=
"",
209 const std::string& filter=
"objectClass=*",
231 const std::string&
getHost()
const;
241 #endif //LDAP_CONNECTION_H
LDAPMessageQueue * search(const std::string &base="", int scope=0, const std::string &filter="objectClass=*", const StringList &attrs=StringList(), bool attrsOnly=false, const LDAPConstraints *cons=0)
Performing a search on a directory tree.
Definition: LDAPAsynConnection.cpp:136
This class is only thrown as an Exception and used to signalize error conditions during LDAP-operatio...
Definition: LDAPException.h:23
~LDAPConnection()
Destructor.
Definition: LDAPConnection.cpp:25
LDAPMessageQueue * del(const std::string &dn, const LDAPConstraints *cons=0)
Delete an entry from the directory.
Definition: LDAPAsynConnection.cpp:156
This class represents an asynchronous connection to an LDAP-Server.
Definition: LDAPAsynConnection.h:45
static const int SEARCH_ONE
Constant for the Search-Operation to indicate a One-Level Search.
Definition: LDAPConnection.h:34
#define LDAP_DEBUG_TRACE
Definition: debug.h:12
LDAPMessageQueue * rename(const std::string &dn, const std::string &newRDN, bool delOldRDN=false, const std::string &newParentDN="", const LDAPConstraints *cons=0)
modify the DN of an entry
Definition: LDAPAsynConnection.cpp:213
const std::string & getHost() const
Definition: LDAPAsynConnection.cpp:297
Object of this class are created by the LDAPMsg::create method if results for an Extended Operation w...
Definition: LDAPExtResult.h:20
LDAPResult * readMessageQueue(LDAPMessageQueue *msg)
For internal use only.
Definition: LDAPSearchResults.cpp:19
const LDAPConstraints * getConstraints() const
Definition: LDAPConnection.cpp:376
static const int COMPARE_FALSE
Definition: LDAPResult.h:38
const std::string & getErrMsg() const
In some case of error the server may return addional error messages.
Definition: LDAPResult.cpp:76
void setConstraints(LDAPConstraints *cons)
Definition: LDAPConnection.cpp:372
int getPort() const
Definition: LDAPConnection.cpp:368
void bind(const std::string &dn="", const std::string &passwd="", LDAPConstraints *cons=0)
Performs a simple authentication with the server.
Definition: LDAPConnection.cpp:32
LDAPMessageQueue * modify(const std::string &dn, const LDAPModList *modlist, const LDAPConstraints *cons=0)
Apply modifications to attributes of an entry.
Definition: LDAPAsynConnection.cpp:199
void init(const std::string &hostname, int port)
Initzializes a synchronous connection to a server.
LDAPConnection(const std::string &hostname="localhost", int port=389, LDAPConstraints *cons=new LDAPConstraints())
This Constructor initializes synchronous LDAP-Connection.
Definition: LDAPConnection.cpp:20
LDAPMessageQueue * compare(const std::string &dn, const LDAPAttribute &attr, const LDAPConstraints *cons=0)
Perform the COMPARE-operation on an attribute.
Definition: LDAPAsynConnection.cpp:170
#define DEBUG(level, arg)
Definition: debug.h:30
This class represents some options that can be set for a LDAPConnection operation.
Definition: LDAPConstraints.h:27
static const int SEARCH_ONE
Constant for the Search-Operation to indicate a One-Level Search.
Definition: LDAPAsynConnection.h:57
int getPort() const
Definition: LDAPAsynConnection.cpp:302
const std::string & getHost() const
Definition: LDAPConnection.cpp:364
LDAPMessageQueue * saslInteractiveBind(const std::string &mech, int flags=0, SaslInteractionHandler *sih=0, const LDAPConstraints *cons=0)
Definition: LDAPAsynConnection.cpp:117
LDAPExtResult * extOperation(const std::string &oid, const std::string &value="", const LDAPConstraints *const =0)
This method is for extended LDAP-Operations.
Definition: LDAPConnection.cpp:330
TlsOptions getTlsOptions() const
Definition: LDAPConnection.cpp:380
This class is used to store every kind of LDAP Entry.
Definition: LDAPEntry.h:19
LDAPMessageQueue * extOperation(const std::string &oid, const std::string &value="", const LDAPConstraints *cons=0)
Perform a LDAP extended Operation.
Definition: LDAPAsynConnection.cpp:233
This class is for representing LDAP-Result-Messages.
Definition: LDAPResult.h:30
This class is created for the asynchronous LDAP-operations.
Definition: LDAPMessageQueue.h:27
static const int REFERRAL
Definition: LDAPResult.h:43
static const int SUCCESS
Definition: LDAPResult.h:33
This container class is used to store multiple LDAPUrl-objects.
Definition: LDAPUrlList.h:16
void rename(const std::string &dn, const std::string &newRDN, bool delOldRDN=false, const std::string &newParentDN="", const LDAPConstraints *cons=0)
This method performs the ModDN-operation.
Definition: LDAPConnection.cpp:247
LDAPSearchResults * search(const std::string &base, int scope=0, const std::string &filter="objectClass=*", const StringList &attrs=StringList(), bool attrsOnly=false, const LDAPConstraints *cons=0)
This method can be used for the sync.
Definition: LDAPConnection.cpp:284
const LDAPConstraints * getConstraints() const
Get the default constraints of the connection.
Definition: LDAPAsynConnection.cpp:283
Represents the name an value(s) of an Attribute.
Definition: LDAPAttribute.h:21
void add(const LDAPEntry *le, const LDAPConstraints *cons=0)
Use this method to perform the ADD-operation.
Definition: LDAPConnection.cpp:177
const LDAPUrlList & getReferralUrls() const
Definition: LDAPResult.cpp:86
The class stores the results of a synchronous SEARCH-Operation.
Definition: LDAPSearchResults.h:22
static const int SEARCH_SUB
Constant for the Search-Operation to indicate a Subtree Search.
Definition: LDAPConnection.h:40
void start_tls()
Start TLS on this connection.
Definition: LDAPAsynConnection.cpp:79
TlsOptions getTlsOptions() const
Definition: LDAPAsynConnection.cpp:288
static const int COMPARE_TRUE
Definition: LDAPResult.h:39
bool compare(const std::string &dn, const LDAPAttribute &attr, LDAPConstraints *cons=0)
Performs a COMPARE-operation on an entery of the destination server.
Definition: LDAPConnection.cpp:101
void modify(const std::string &dn, const LDAPModList *mods, const LDAPConstraints *cons=0)
To modify the attributes of an entry, this method can be used.
Definition: LDAPConnection.cpp:211
static const int SEARCH_SUB
Constant for the Search-Operation to indicate a subtree Search.
Definition: LDAPAsynConnection.h:63
void saslInteractiveBind(const std::string &mech, int flags=0, SaslInteractionHandler *sih=0, const LDAPConstraints *cons=0)
Definition: LDAPConnection.cpp:63
This class extends LDAPException and is used to signalize Referrals there were received during synchr...
Definition: LDAPException.h:84
Class to access the global (and connection specific) TLS Settings To access the global TLS Settings j...
Definition: TlsOptions.h:21
static const int SEARCH_BASE
Constant for the Search-Operation to indicate a Base-Level Search.
Definition: LDAPAsynConnection.h:51
Main class for synchronous LDAP-Communication.
Definition: LDAPConnection.h:21
void start_tls()
Start TLS on this connection.
Definition: LDAPConnection.cpp:28
LDAPMessageQueue * add(const LDAPEntry *le, const LDAPConstraints *const=0)
Add an entry to the directory.
Definition: LDAPAsynConnection.cpp:185
void del(const std::string &dn, const LDAPConstraints *cons=0)
Deletes an entry from the directory.
Definition: LDAPConnection.cpp:142
int getResultCode() const
Definition: LDAPResult.cpp:66
Container class to store multiple string-objects.
Definition: StringList.h:15
static const int SEARCH_BASE
Constant for the Search-Operation to indicate a Base-Level Search.
Definition: LDAPConnection.h:28
This container class is used to store multiple LDAPModification-objects.
Definition: LDAPModList.h:18
LDAPMessageQueue * bind(const std::string &dn="", const std::string &passwd="", const LDAPConstraints *cons=0)
Simple authentication to a LDAP-Server.
Definition: LDAPAsynConnection.cpp:86
void unbind()
Performs the UNBIND-operation on the destination server.
Definition: LDAPConnection.cpp:97
LDAPMsg * getNext()
This method reads exactly one Message from the results of a Request.
Definition: LDAPMessageQueue.cpp:40
Definition: SaslInteractionHandler.h:13
void setConstraints(LDAPConstraints *cons)
Change the default constraints of the connection.
Definition: LDAPAsynConnection.cpp:278
void unbind()
Performs the UNBIND-operation on the destination server.
Definition: LDAPAsynConnection.cpp:263