KLDAP Library
KLDAP::LdapUrl Class Reference
#include <ldapurl.h>
Inherits KUrl.
Public Types | |
| enum | Scope { Base, One, Sub } |
Public Member Functions | |
| QStringList | attributes () const |
| LdapDN | dn () const |
| QString | extension (const QString &key, bool &critical) const |
| Extension | extension (const QString &key) const |
| QString | filter () const |
| bool | hasExtension (const QString &key) const |
| LdapUrl (const LdapUrl &that) | |
| LdapUrl (const KUrl &url) | |
| LdapUrl () | |
| LdapUrl & | operator= (const LdapUrl &that) |
| void | parseQuery () |
| void | removeExtension (const QString &key) |
| Scope | scope () const |
| void | setAttributes (const QStringList &attributes) |
| void | setDn (const LdapDN &dn) |
| void | setExtension (const QString &key, int value, bool critical=false) |
| void | setExtension (const QString &key, const QString &value, bool critical=false) |
| void | setExtension (const QString &key, const Extension &ext) |
| void | setFilter (const QString &filter) |
| void | setScope (Scope scope) |
| void | updateQuery () |
Detailed Description
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.
Constructor & Destructor Documentation
| LdapUrl::LdapUrl | ( | ) |
Constructs an empty KLdapUrl.
Definition at line 43 of file ldapurl.cpp.
| LdapUrl::LdapUrl | ( | const KUrl & | url | ) | [explicit] |
Constructs a KLdapUrl from a KUrl.
Definition at line 48 of file ldapurl.cpp.
| LdapUrl::LdapUrl | ( | const LdapUrl & | that | ) |
Constructs a KLdapUrl from a LdapUrl.
Definition at line 59 of file ldapurl.cpp.
Member Function Documentation
| QStringList LdapUrl::attributes | ( | ) | const |
Returns the attributes part of the LDAP Url.
Definition at line 101 of file ldapurl.cpp.
| LdapDN LdapUrl::dn | ( | ) | const |
Returns the dn part of the LDAP Url (same as path(), but slash removed from the beginning).
Definition at line 91 of file ldapurl.cpp.
| QString LdapUrl::extension | ( | const QString & | key, | |
| bool & | critical | |||
| ) | const |
Returns the specified extension.
Definition at line 154 of file ldapurl.cpp.
| LdapUrl::Extension LdapUrl::extension | ( | const QString & | key | ) | const |
Returns the specified extension.
Definition at line 139 of file ldapurl.cpp.
| QString LdapUrl::filter | ( | ) | const |
Returns the filter part of the LDAP Url.
Definition at line 123 of file ldapurl.cpp.
| bool LdapUrl::hasExtension | ( | const QString & | key | ) | const |
Returns if the specified extension exists in the LDAP Url.
Definition at line 134 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 242 of file ldapurl.cpp.
| void LdapUrl::removeExtension | ( | const QString & | key | ) |
Removes the specified extension.
Definition at line 185 of file ldapurl.cpp.
| LdapUrl::Scope LdapUrl::scope | ( | ) | const |
Returns the scope part of the LDAP Url.
Definition at line 112 of file ldapurl.cpp.
| void LdapUrl::setAttributes | ( | const QStringList & | attributes | ) |
Sets the attributes part of the LDAP Url.
Definition at line 106 of file ldapurl.cpp.
| void LdapUrl::setDn | ( | const LdapDN & | dn | ) |
Sets the dn part of the LDAP Url.
Definition at line 82 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 177 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 169 of file ldapurl.cpp.
| void LdapUrl::setExtension | ( | const QString & | key, | |
| const Extension & | ext | |||
| ) |
Sets the specified extension key with the value and criticality in ext.
Definition at line 163 of file ldapurl.cpp.
| void LdapUrl::setFilter | ( | const QString & | filter | ) |
Sets the filter part of the LDAP Url.
Definition at line 128 of file ldapurl.cpp.
| void LdapUrl::setScope | ( | Scope | scope | ) |
Sets the scope part of the LDAP Url.
Definition at line 117 of file ldapurl.cpp.
| void LdapUrl::updateQuery | ( | ) |
Updates the query component from the attributes, scope, filter and extensions.
Definition at line 191 of file ldapurl.cpp.
The documentation for this class was generated from the following files:
KDE 4.3 API Reference