libkdepim Library API Documentation

KPIM::LDAPUrl Class Reference

LDAPUrl. More...

#include <ldapurl.h>

Collaboration diagram for KPIM::LDAPUrl:

Collaboration graph
[legend]
List of all members.

Public Types

enum  Scope { Base, One, Sub }

Public Member Functions

 LDAPUrl ()
 LDAPUrl (const KURL &url)
const QStringdn () const
void setDn (const QString &dn)
const QStringListattributes ()
void setAttributes (const QStringList &attributes)
Scope scope () const
void setScope (Scope scope)
const QStringfilter () const
void setFilter (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 removeExtension (const QString &key)
void updateQuery ()

Protected Member Functions

void parseQuery ()

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 42 of file ldapurl.h.


Constructor & Destructor Documentation

LDAPUrl::LDAPUrl  ) 
 

Constructs an empty KLDAPUrl.

Definition at line 28 of file ldapurl.cpp.

LDAPUrl::LDAPUrl const KURL &  url  ) 
 

Constructs a KLDAPUrl from a KURL.

Definition at line 33 of file ldapurl.cpp.


Member Function Documentation

const QString& KPIM::LDAPUrl::dn  )  const [inline]
 

Returns the dn part of the LDAP Url (same as path(), but slash removed from the beginning).

Definition at line 62 of file ldapurl.h.

void LDAPUrl::setDn const QString dn  ) 
 

Sets the the dn part of the LDAP Url.

Definition at line 42 of file ldapurl.cpp.

const QStringList& KPIM::LDAPUrl::attributes  )  [inline]
 

Returns the attributes part of the LDAP Url.

Definition at line 67 of file ldapurl.h.

void KPIM::LDAPUrl::setAttributes const QStringList attributes  )  [inline]
 

Sets the attributes part of the LDAP Url.

Definition at line 69 of file ldapurl.h.

References updateQuery().

Scope KPIM::LDAPUrl::scope  )  const [inline]
 

Returns the scope part of the LDAP Url.

Definition at line 73 of file ldapurl.h.

void KPIM::LDAPUrl::setScope Scope  scope  )  [inline]
 

Sets the scope part of the LDAP Url.

Definition at line 75 of file ldapurl.h.

References updateQuery().

const QString& KPIM::LDAPUrl::filter  )  const [inline]
 

Returns the filter part of the LDAP Url.

Definition at line 78 of file ldapurl.h.

void KPIM::LDAPUrl::setFilter QString  filter  )  [inline]
 

Sets the filter part of the LDAP Url.

Definition at line 80 of file ldapurl.h.

References updateQuery().

bool LDAPUrl::hasExtension const QString key  )  const
 

Returns if the specified extension exists in the LDAP Url.

Definition at line 50 of file ldapurl.cpp.

LDAPUrl::Extension LDAPUrl::extension const QString key  )  const
 

Returns the specified extension.

Definition at line 55 of file ldapurl.cpp.

Referenced by extension().

QString LDAPUrl::extension const QString key,
bool &  critical
const
 

Returns the specified extension.

Definition at line 70 of file ldapurl.cpp.

References extension().

void LDAPUrl::setExtension const QString key,
const Extension &  ext
 

Sets the specified extension key with the value and criticality in ext.

Definition at line 79 of file ldapurl.cpp.

References updateQuery().

Referenced by setExtension().

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 85 of file ldapurl.cpp.

References setExtension().

void LDAPUrl::removeExtension const QString key  ) 
 

Removes the specified extension.

Definition at line 93 of file ldapurl.cpp.

References updateQuery().

void LDAPUrl::updateQuery  ) 
 

Updates the query component from the attributes, scope, filter and extensions.

Definition at line 99 of file ldapurl.cpp.

Referenced by removeExtension(), setAttributes(), setExtension(), setFilter(), and setScope().


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for libkdepim Library Version 3.3.2.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Fri Dec 21 14:23:28 2007 by doxygen 1.4.2 written by Dimitri van Heesch, © 1997-2003