• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdepimlibs-4.14.10 API Reference
  • KDE Home
  • Contact Us
 

KLDAP Library

  • kldap
ldapconnection.h
1/*
2 This file is part of libkldap.
3 Copyright (c) 2004-2006 Szombathelyi György <gyurco@freemail.hu>
4
5 This library is free software; you can redistribute it and/or
6 modify it under the terms of the GNU Library General Public
7 License as published by the Free Software Foundation; either
8 version 2 of the License, or (at your option) any later version.
9
10 This library is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 Library General Public License for more details.
14
15 You should have received a copy of the GNU Library General Public License
16 along with this library; see the file COPYING.LIB. If not, write to
17 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
18 Boston, MA 02110-1301, USA.
19*/
20
21#ifndef KLDAP_LDAPCONNECTION_H
22#define KLDAP_LDAPCONNECTION_H
23
24#include <QtCore/QString>
25
26#include "ldapurl.h"
27#include "ldapserver.h"
28#include "kldap_export.h"
29
30namespace KLDAP {
31
36class KLDAP_EXPORT LdapConnection
37{
38 public:
39
40 enum SASL_Fields {
41 SASL_Authname = 0x1,
42 SASL_Authzid = 0x2,
43 SASL_Realm = 0x4,
44 SASL_Password = 0x8
45 };
46
48 LdapConnection();
50 explicit LdapConnection( const LdapUrl &url );
52 explicit LdapConnection( const LdapServer &server );
53
54 virtual ~LdapConnection();
55
61 void setUrl( const LdapUrl &url );
66 const LdapServer &server() const;
72 void setServer( const LdapServer &server );
73
80 int connect();
84 QString connectionError() const;
88 void close();
89
93 bool setSizeLimit( int sizelimit );
95 int sizeLimit() const;
96
100 bool setTimeLimit( int timelimit );
102 int timeLimit() const;
103
109 int getOption( int option, void *value ) const;
112 int setOption( int option, void *value );
113
115 int ldapErrorCode() const;
117 QString ldapErrorString() const;
119 static QString errorString( int code );
120
122 QString saslErrorString() const;
123
128 void *handle() const;
129
134 void *saslHandle() const;
135
136 private:
137 class LdapConnectionPrivate;
138 LdapConnectionPrivate *const d;
139
140 Q_DISABLE_COPY( LdapConnection )
141};
142
143}
144
145#endif
KLDAP::LdapConnection::ldapErrorString
QString ldapErrorString() const
Returns the LDAP error string from the last operation.
Definition ldapconnection.cpp:391
KLDAP::LdapConnection::server
const LdapServer & server() const
Returns the connection parameters which was specified with an LDAP Url or a LdapServer structure.
Definition ldapconnection.cpp:128
KLDAP::LdapConnection::timeLimit
int timeLimit() const
Returns the current time limit.
Definition ldapconnection.cpp:415
KLDAP::LdapConnection::connect
int connect()
Sets up the connection parameters with creating a handle to the LDAP server.
Definition ldapconnection.cpp:421
KLDAP::LdapConnection::LdapConnection
LdapConnection()
Constructs an LdapConnection object.
Definition ldapconnection.cpp:92
KLDAP::LdapConnection::saslErrorString
QString saslErrorString() const
Returns the SASL error string from the last SASL operation.
Definition ldapconnection.cpp:159
KLDAP::LdapConnection::getOption
int getOption(int option, void *value) const
Gets an option from the connection.
Definition ldapconnection.cpp:373
KLDAP::LdapConnection::setUrl
void setUrl(const LdapUrl &url)
Sets the connection parameters via the specified url.
Definition ldapconnection.cpp:118
KLDAP::LdapConnection::sizeLimit
int sizeLimit() const
Returns the current size limit.
Definition ldapconnection.cpp:403
KLDAP::LdapConnection::setOption
int setOption(int option, void *value)
Sets an option in the connection.
Definition ldapconnection.cpp:379
KLDAP::LdapConnection::connectionError
QString connectionError() const
Returns a translated error string if connect() failed.
Definition ldapconnection.cpp:172
KLDAP::LdapConnection::close
void close()
Closes the LDAP connection.
Definition ldapconnection.cpp:431
KLDAP::LdapConnection::setTimeLimit
bool setTimeLimit(int timelimit)
Sets the time limit for the connection.
Definition ldapconnection.cpp:409
KLDAP::LdapConnection::setServer
void setServer(const LdapServer &server)
Sets the connection parameters via the specified server structure.
Definition ldapconnection.cpp:123
KLDAP::LdapConnection::ldapErrorCode
int ldapErrorCode() const
Returns the LDAP error code from the last operation.
Definition ldapconnection.cpp:385
KLDAP::LdapConnection::saslHandle
void * saslHandle() const
Returns the opaqe sasl-library specific SASL object.
Definition ldapconnection.cpp:138
KLDAP::LdapConnection::errorString
static QString errorString(int code)
Returns a translated error message from the specified LDAP error code.
Definition ldapconnection.cpp:143
KLDAP::LdapConnection::handle
void * handle() const
Returns the opaqe client-library specific LDAP object.
Definition ldapconnection.cpp:133
KLDAP::LdapConnection::setSizeLimit
bool setSizeLimit(int sizelimit)
Sets the size limit for the connection.
Definition ldapconnection.cpp:397
KLDAP::LdapServer
A class that contains LDAP server connection settings.
Definition ldapserver.h:39
KLDAP::LdapUrl
A special url class for LDAP.
Definition ldapurl.h:43
This file is part of the KDE documentation.
Documentation copyright © 1996-2025 The KDE developers.
Generated on Fri Jan 17 2025 00:00:00 by doxygen 1.13.2 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

KLDAP Library

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

kdepimlibs-4.14.10 API Reference

Skip menu "kdepimlibs-4.14.10 API Reference"
  • akonadi
  •   contact
  •   kmime
  •   socialutils
  • kabc
  • kalarmcal
  • kblog
  • kcal
  • kcalcore
  • kcalutils
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  •   nntp
  • kldap
  • kmbox
  • kmime
  • kontactinterface
  • kpimidentities
  • kpimtextedit
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • microblog
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal