Qore openldap Module 1.2
QC_LdapClient.dox.h
1
2namespace OpenLdap {
4
8class LdapClient {
9
10public:
12
30nothing add(string dn, hash attrs, *timeout timeout_ms);
31
32public:
34
53 bind(hash bind, *timeout timeout_ms);
54
55public:
57
75bool compare(string dn, string attr, softlist vals, *timeout timeout_ms);
76
77public:
79
105 constructor(string uri, *hash options);
106
107public:
109
117
118public:
120
134nothing del(string dn, *timeout timeout_ms);
135
136public:
138
144
145public:
147
157string getUri();
158
159public:
161
173bool isSecure();
174
175public:
177
196nothing modify(string dn, softlist mods, *timeout timeout_ms);
197
198public:
200
216nothing passwd(string dn, string oldpwd, string newpwd, *timeout timeout_ms);
217
218public:
220
237nothing rename(string dn, string newrdn, string newparent, softbool deleteoldrdn = True, *timeout timeout_ms);
238
239public:
241
261hash search(hash h, *timeout timeout_ms);
262
263public:
265
276static getInfo();
277};
280
285
295
298 const LDAP_MOD_ADD = "add";
300 const LDAP_MOD_DELETE = "delete";
302 const LDAP_MOD_REPLACE = "replace";
306
309 const DefaultTimeout = 60s;
311}
The LdapClient class.
Definition: QC_LdapClient.dox.h:8
static getInfo()
Returns a hash with information about the openldap library.
nothing add(string dn, hash attrs, *timeout timeout_ms)
add ldap an entry and attributes
bool isSecure()
returns True if the connection to the server is secure, False if not
bind(hash bind, *timeout timeout_ms)
bind to the server with the given authentication parameters
nothing del(string dn, *timeout timeout_ms)
delete ldap entries; if any errors occur (entry does not exist, etc), an LDAP-ERROR exception will be...
nothing modify(string dn, softlist mods, *timeout timeout_ms)
modify (add, replace, delete) ldap attributes; if any errors occur (entry does not exist,...
copy()
Creates a new LdapClient object based on the original.
string getUri()
returns the URI string used to connect to the LDAP server
bool compare(string dn, string attr, softlist vals, *timeout timeout_ms)
check ldap attribute values; if any errors occur (entry does not exist, etc), an LDAP-ERROR exception...
nothing passwd(string dn, string oldpwd, string newpwd, *timeout timeout_ms)
changes the LDAP password of a user
hash search(hash h, *timeout timeout_ms)
performs a search on the LDAP server
nothing rename(string dn, string newrdn, string newparent, softbool deleteoldrdn=True, *timeout timeout_ms)
renames entries in the Directory Information Tree
constructor(string uri, *hash options)
Creates a new LdapClient object and establishes a connection to the server with optional bind paramet...
destructor()
unbinds from the LDAP server (if a connection has been established) and destroys the object
const DefaultTimeout
the default timeout value
Definition: QC_LdapClient.dox.h:309
const LDAP_MOD_DELETE
for deleting an entry
Definition: QC_LdapClient.dox.h:300
const LDAP_MOD_REPLACE
for replacing an entry
Definition: QC_LdapClient.dox.h:302
const LDAP_MOD_ADD
for adding an entry
Definition: QC_LdapClient.dox.h:298
const LDAP_SCOPE_CHILDREN
limits the search scope to all of the descendants
Definition: QC_LdapClient.dox.h:287
const LDAP_SCOPE_ONELEVEL
limits the search scope to the object's immediate children
Definition: QC_LdapClient.dox.h:289
const LDAP_SCOPE_SUBTREE
limits the search scope to the object and all its descendants
Definition: QC_LdapClient.dox.h:291
const LDAP_SCOPE_BASE
limits the search scope to the object itself
Definition: QC_LdapClient.dox.h:283
OpenLdap namespace.
Definition: QC_LdapClient.dox.h:2