KLDAP Library
KLDAP::LdapUrl Class Reference
#include <ldapurl.h>
Inherits KUrl.
Detailed Description
LdapUrl.LdapUrl implements an RFC 2255 compliant LDAP Url parser, with minimal differences. LDAP Urls implemented by this class has the following format: ldap[s]://[user[:password]@]hostname[:port]["/" [dn ["?" [attributes] ["?" [scope] ["?" [filter] ["?" extensions]]]]]]
Definition at line 43 of file ldapurl.h.
Public Types | |
enum | Scope { Base, One, Sub } |
Public Member Functions | |
LdapUrl () | |
LdapUrl (const KUrl &url) | |
LdapUrl (const LdapUrl &that) | |
LdapUrl & | operator= (const LdapUrl &that) |
LdapDN | dn () const |
void | setDn (const LdapDN &dn) |
QStringList | attributes () const |
void | setAttributes (const QStringList &attributes) |
Scope | scope () const |
void | setScope (Scope scope) |
QString | filter () const |
void | setFilter (const QString &filter) |
bool | hasExtension (const QString &key) const |
Extension | extension (const QString &key) const |
QString | extension (const QString &key, bool &critical) const |
void | setExtension (const QString &key, const Extension &ext) |
void | setExtension (const QString &key, const QString &value, bool critical=false) |
void | setExtension (const QString &key, int value, bool critical=false) |
void | removeExtension (const QString &key) |
void | updateQuery () |
void | parseQuery () |
Constructor & Destructor Documentation
LdapUrl::LdapUrl | ( | ) |
LdapUrl::LdapUrl | ( | const KUrl & | url | ) | [explicit] |
LdapUrl::LdapUrl | ( | const LdapUrl & | that | ) |
Member Function Documentation
LdapDN LdapUrl::dn | ( | ) | const |
Returns the dn part of the LDAP Url (same as path(), but slash removed from the beginning).
Definition at line 92 of file ldapurl.cpp.
void LdapUrl::setDn | ( | const LdapDN & | dn | ) |
QStringList LdapUrl::attributes | ( | ) | const |
void LdapUrl::setAttributes | ( | const QStringList & | attributes | ) |
LdapUrl::Scope LdapUrl::scope | ( | ) | const |
void LdapUrl::setScope | ( | Scope | scope | ) |
QString LdapUrl::filter | ( | ) | const |
void LdapUrl::setFilter | ( | const QString & | filter | ) |
bool LdapUrl::hasExtension | ( | const QString & | key | ) | const |
Returns if the specified extension exists in the LDAP Url.
Definition at line 135 of file ldapurl.cpp.
LdapUrl::Extension LdapUrl::extension | ( | const QString & | key | ) | const |
QString LdapUrl::extension | ( | const QString & | key, | |
bool & | critical | |||
) | const |
void LdapUrl::setExtension | ( | const QString & | key, | |
const Extension & | ext | |||
) |
Sets the specified extension key with the value and criticality in ext.
Definition at line 164 of file ldapurl.cpp.
void LdapUrl::setExtension | ( | const QString & | key, | |
const QString & | value, | |||
bool | critical = false | |||
) |
Sets the specified extension key with the value and criticality specified.
Definition at line 170 of file ldapurl.cpp.
void LdapUrl::setExtension | ( | const QString & | key, | |
int | value, | |||
bool | critical = false | |||
) |
Sets the specified extension key with the value and criticality specified.
Definition at line 178 of file ldapurl.cpp.
void LdapUrl::removeExtension | ( | const QString & | key | ) |
void LdapUrl::updateQuery | ( | ) |
Updates the query component from the attributes, scope, filter and extensions.
Definition at line 192 of file ldapurl.cpp.
void LdapUrl::parseQuery | ( | ) |
Parses the query argument of the URL and makes it available via the attributes(), extension(), filter() and scope() methods.
Definition at line 243 of file ldapurl.cpp.
The documentation for this class was generated from the following files: