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

KLDAP Library

  • sources
  • kde-4.14
  • kdepimlibs
  • kldap
ldapserver.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_LDAPSERVER_H
22 #define KLDAP_LDAPSERVER_H
23 
24 #include <QtCore/QString>
25 
26 #include "ldapurl.h"
27 #include "ldapdn.h"
28 #include "kldap_export.h"
29 
30 namespace KLDAP {
31 
38 class KLDAP_EXPORT LdapServer
39 {
40  public:
44  LdapServer();
45 
51  LdapServer( const LdapUrl &url );
52 
56  LdapServer( const LdapServer &other );
57 
62  LdapServer &operator=( const LdapServer &other );
63 
67  virtual ~LdapServer();
68 
73  typedef enum {
74  None,
75  TLS,
76  SSL
77  } Security;
78 
83  typedef enum {
84  Anonymous,
85  Simple,
86  SASL
87  } Auth;
88 
92  void clear();
93 
97  void setHost( const QString &host );
98 
102  QString host() const;
103 
109  void setPort( int port );
110 
114  int port() const;
115 
119  void setBaseDn( const LdapDN &baseDn );
120 
124  LdapDN baseDn() const;
125 
129  void setUser( const QString &user );
130 
134  QString user() const;
135 
139  void setBindDn( const QString &bindDn );
140 
144  QString bindDn() const;
145 
149  void setRealm( const QString &realm );
150 
154  QString realm() const;
155 
159  void setPassword( const QString &password );
160 
164  QString password() const;
165 
171  void setVersion( int version );
172 
176  int version() const;
177 
183  void setSecurity( Security mode );
184 
188  Security security() const;
189 
195  void setAuth( Auth authentication );
196 
200  Auth auth() const;
201 
205  void setMech( const QString &mech );
206 
210  QString mech() const;
211 
215  void setTimeout( int timeout );
216 
220  int timeout() const;
221 
225  void setScope( LdapUrl::Scope scope );
226 
230  LdapUrl::Scope scope() const;
231 
235  void setTimeLimit( int limit );
236 
240  int timeLimit() const;
241 
245  void setSizeLimit( int sizelimit );
246 
250  int sizeLimit() const;
251 
255  void setPageSize( int size );
256 
260  int pageSize() const;
261 
265  void setFilter( const QString &filter );
266 
270  QString filter() const;
271 
275  void setUrl( const LdapUrl &url );
276 
284  LdapUrl url() const;
285 
286  private:
287  class LdapServerPrivate;
288  LdapServerPrivate *const d;
289 };
290 
291 }
292 
293 #endif
KLDAP::LdapServer::Simple
Authenticate via login and password.
Definition: ldapserver.h:85
KLDAP::LdapUrl
A special url class for LDAP.
Definition: ldapurl.h:42
KLDAP::LdapServer::Anonymous
Do no authentication.
Definition: ldapserver.h:84
KLDAP::LdapUrl::Scope
Scope
Describes the scope of the LDAP url.
Definition: ldapurl.h:58
KLDAP::LdapServer::None
Do not use any encryption.
Definition: ldapserver.h:74
KLDAP::LdapServer::TLS
Use TLS encryption.
Definition: ldapserver.h:75
KLDAP::LdapServer
A class that contains LDAP server connection settings.
Definition: ldapserver.h:38
QString
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Mon Jun 22 2020 13:37:58 by doxygen 1.8.7 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 API Reference

Skip menu "kdepimlibs 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

Search



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