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

KLDAP Library

KLDAP::LdapUrl

KLDAP::LdapUrl Class Reference

A special url class for LDAP. More...

#include <ldapurl.h>

Inherits KUrl.

List of all members.

Classes

struct  Extension
 A class holding the extension name and state whether the extension is critical. More...

Public Types

enum  Scope { Base, One, Sub }

Public Member Functions

 LdapUrl (const LdapUrl &other)
 LdapUrl (const KUrl &url)
 LdapUrl ()
virtual ~LdapUrl ()
QStringList attributes () const
LdapDN dn () const
QString extension (const QString &extension, bool &critical) const
Extension extension (const QString &extension) const
QString filter () const
bool hasExtension (const QString &extension) const
LdapUrl & operator= (const LdapUrl &other)
void parseQuery ()
void removeExtension (const QString &extension)
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 &extension)
void setFilter (const QString &filter)
void setScope (Scope scope)
void updateQuery ()

Detailed Description

A special url class for LDAP.

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.


Member Enumeration Documentation

enum KLDAP::LdapUrl::Scope

Describes the scope of the LDAP url.

Enumerator:
Base 

Only the same level as the url.

One 

The level of the url and the one below.

Sub 

All levels below the url's level.

Definition at line 58 of file ldapurl.h.


Constructor & Destructor Documentation

LdapUrl::LdapUrl (  ) 

Constructs an empty LDAP url.

Definition at line 43 of file ldapurl.cpp.

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

Constructs a LDAP url from a KUrl url.

Definition at line 48 of file ldapurl.cpp.

LdapUrl::LdapUrl ( const LdapUrl &  other  ) 

Constructs a LDAP url from an other url.

Definition at line 59 of file ldapurl.cpp.

LdapUrl::~LdapUrl (  )  [virtual]

Destroys the LDAP url.

Definition at line 77 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.

This is equal to path() with the slash removed from the beginning.

Definition at line 91 of file ldapurl.cpp.

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

Returns the specified extension.

Definition at line 154 of file ldapurl.cpp.

LdapUrl::Extension LdapUrl::extension ( const QString &  extension  )  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 &  extension  )  const

Returns whether the specified extension exists in the LDAP url.

Definition at line 134 of file ldapurl.cpp.

LdapUrl & LdapUrl::operator= ( const LdapUrl &  other  ) 

Overwrites the values of the LDAP url with values from an other url.

Definition at line 65 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 &  extension  ) 

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 &  extension 
)

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

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

KLDAP Library

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

KDE-PIM Libraries

Skip menu "KDE-PIM Libraries"
  • akonadi
  •   contact
  •   kmime
  • kabc
  • kblog
  • kcal
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  •   nntp
  • kldap
  • kmime
  • kontactinterface
  • kpimidentities
  • kpimtextedit
  •   richtextbuilders
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • microblog
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Generated for KDE-PIM Libraries by doxygen 1.6.1
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