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