• Skip to content
  • Skip to link menu
KDE 4.0 API Reference
  • KDE API Reference
  • KDE-PIM Libraries
  • Sitemap
  • Contact Us
 

KLDAP Library

KLDAP::LdapUrl

KLDAP::LdapUrl Class Reference

#include <ldapurl.h>

Inherits KUrl.

List of all members.


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 (  ) 

Constructs an empty KLdapUrl.

Definition at line 44 of file ldapurl.cpp.

LdapUrl::LdapUrl ( const KUrl &  url  )  [explicit]

Constructs a KLdapUrl from a KUrl.

Definition at line 49 of file ldapurl.cpp.

LdapUrl::LdapUrl ( const LdapUrl &  that  ) 

Constructs a KLdapUrl from a LdapUrl.

Definition at line 60 of file ldapurl.cpp.


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  ) 

Sets the the dn part of the LDAP Url.

Definition at line 83 of file ldapurl.cpp.

QStringList LdapUrl::attributes (  )  const

Returns the attributes part of the LDAP Url.

Definition at line 102 of file ldapurl.cpp.

void LdapUrl::setAttributes ( const QStringList &  attributes  ) 

Sets the attributes part of the LDAP Url.

Definition at line 107 of file ldapurl.cpp.

LdapUrl::Scope LdapUrl::scope (  )  const

Returns the scope part of the LDAP Url.

Definition at line 113 of file ldapurl.cpp.

void LdapUrl::setScope ( Scope  scope  ) 

Sets the scope part of the LDAP Url.

Definition at line 118 of file ldapurl.cpp.

QString LdapUrl::filter (  )  const

Returns the filter part of the LDAP Url.

Definition at line 124 of file ldapurl.cpp.

void LdapUrl::setFilter ( const QString &  filter  ) 

Sets the filter part of the LDAP Url.

Definition at line 129 of file ldapurl.cpp.

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

Returns the specified extension.

Definition at line 140 of file ldapurl.cpp.

QString LdapUrl::extension ( const QString &  key,
bool &  critical 
) const

Returns the specified extension.

Definition at line 155 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 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  ) 

Removes the specified extension.

Definition at line 186 of file ldapurl.cpp.

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:
  • ldapurl.h
  • ldapurl.cpp

KLDAP Library

Skip menu "KLDAP Library"
  • Main Page
  • Alphabetical List
  • Class List
  • File List
  • Class Members
  • Related Pages

KDE-PIM Libraries

Skip menu "KDE-PIM Libraries"
  • kabc
  • kblog
  • kcal
  • kimap
  • kioslave
  •   imap4
  •   mbox
  • kldap
  • kmime
  • kpimidentities
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Generated for KDE-PIM Libraries by doxygen 1.5.5
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal