• Skip to content
  • Skip to link menu
KDE 4.8 API Reference
  • KDE API Reference
  • KDE-PIM Libraries
  • KDE Home
  • Contact Us
 

KLDAP Library

  • KLDAP
  • LdapServer
Public Types | Public Member Functions
KLDAP::LdapServer Class Reference

#include <ldapserver.h>

List of all members.

Public Types

enum  Auth { Anonymous, Simple, SASL }
enum  Security { None, TLS, SSL }

Public Member Functions

 LdapServer ()
 LdapServer (const LdapUrl &url)
 LdapServer (const LdapServer &other)
virtual ~LdapServer ()
Auth auth () const
LdapDN baseDn () const
QString bindDn () const
void clear ()
QString filter () const
QString host () const
QString mech () const
LdapServer & operator= (const LdapServer &other)
int pageSize () const
QString password () const
int port () const
QString realm () const
LdapUrl::Scope scope () const
Security security () const
void setAuth (Auth authentication)
void setBaseDn (const LdapDN &baseDn)
void setBindDn (const QString &bindDn)
void setFilter (const QString &filter)
void setHost (const QString &host)
void setMech (const QString &mech)
void setPageSize (int size)
void setPassword (const QString &password)
void setPort (int port)
void setRealm (const QString &realm)
void setScope (LdapUrl::Scope scope)
void setSecurity (Security mode)
void setSizeLimit (int sizelimit)
void setTimeLimit (int limit)
void setTimeout (int timeout)
void setUrl (const LdapUrl &url)
void setUser (const QString &user)
void setVersion (int version)
int sizeLimit () const
int timeLimit () const
int timeout () const
LdapUrl url () const
QString user () const
int version () const

Detailed Description

A class that contains LDAP server connection settings.

This class holds various parameters that are needed to connect to an LDAP server.

Definition at line 38 of file ldapserver.h.


Member Enumeration Documentation

enum KLDAP::LdapServer::Auth

Describes the authentication method that can be used for the LDAP connection.

Enumerator:
Anonymous 

Do no authentication.

Simple 

Authenticate via login and password.

SASL 

Azthenticate with the SASL framework.

Definition at line 84 of file ldapserver.h.

enum KLDAP::LdapServer::Security

Describes the encryption settings that can be used for the LDAP connection.

Enumerator:
None 

Do not use any encryption.

TLS 

Use TLS encryption.

SSL 

Use SSL encryption.

Definition at line 73 of file ldapserver.h.


Constructor & Destructor Documentation

LdapServer::LdapServer ( )

Creates an empty LDAP server object.

Definition at line 45 of file ldapserver.cpp.

LdapServer::LdapServer ( const LdapUrl &  url)

Creates a new LDAP server object.

Parameters:
urlThe LDAP url of the server.

Definition at line 51 of file ldapserver.cpp.

LdapServer::LdapServer ( const LdapServer &  other)

Creates a new LDAP server object from an other object.

Definition at line 59 of file ldapserver.cpp.

LdapServer::~LdapServer ( ) [virtual]

Destroys the LDAP server object.

Definition at line 76 of file ldapserver.cpp.


Member Function Documentation

LdapServer::Auth LdapServer::auth ( ) const

Returns the authentication method of the LDAP connection.

Definition at line 166 of file ldapserver.cpp.

LdapDN LdapServer::baseDn ( ) const

Returns the baseDn of the LDAP connection.

Definition at line 106 of file ldapserver.cpp.

QString LdapServer::bindDn ( ) const

Returns the bindDn of the LDAP connection.

Definition at line 116 of file ldapserver.cpp.

void LdapServer::clear ( )

Clears all server settings.

Definition at line 81 of file ldapserver.cpp.

QString LdapServer::filter ( ) const

Returns the filter string of the LDAP connection.

Definition at line 131 of file ldapserver.cpp.

QString LdapServer::host ( ) const

Returns the host of the LDAP connection.

Definition at line 96 of file ldapserver.cpp.

QString LdapServer::mech ( ) const

Returns the mech of the LDAP connection.

Definition at line 171 of file ldapserver.cpp.

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

Overwrites the values of the LDAP server object with the values from an other object.

Definition at line 65 of file ldapserver.cpp.

int LdapServer::pageSize ( ) const

Returns the page size of the LDAP connection.

Definition at line 151 of file ldapserver.cpp.

QString LdapServer::password ( ) const

Returns the password of the LDAP connection.

Definition at line 126 of file ldapserver.cpp.

int LdapServer::port ( ) const

Returns the port of the LDAP connection.

Definition at line 101 of file ldapserver.cpp.

QString LdapServer::realm ( ) const

Returns the realm of the LDAP connection.

Definition at line 121 of file ldapserver.cpp.

LdapUrl::Scope LdapServer::scope ( ) const

Returns the search scope of the LDAP connection.

Definition at line 136 of file ldapserver.cpp.

LdapServer::Security LdapServer::security ( ) const

Returns the security mode of the LDAP connection.

Definition at line 161 of file ldapserver.cpp.

void LdapServer::setAuth ( Auth  authentication)

Sets the authentication method of the LDAP connection.

If no authentication method is set, Anonymous is used as default.

Definition at line 251 of file ldapserver.cpp.

void LdapServer::setBaseDn ( const LdapDN &  baseDn)

Sets the baseDn of the LDAP connection.

Definition at line 191 of file ldapserver.cpp.

void LdapServer::setBindDn ( const QString &  bindDn)

Sets the bindDn of the LDAP connection.

Definition at line 201 of file ldapserver.cpp.

void LdapServer::setFilter ( const QString &  filter)

Sets the filter string of the LDAP connection.

Definition at line 231 of file ldapserver.cpp.

void LdapServer::setHost ( const QString &  host)

Sets the host of the LDAP connection.

Definition at line 181 of file ldapserver.cpp.

void LdapServer::setMech ( const QString &  mech)

Sets the mech of the LDAP connection.

Definition at line 256 of file ldapserver.cpp.

void LdapServer::setPageSize ( int  size)

Sets the page size of the LDAP connection.

Definition at line 226 of file ldapserver.cpp.

void LdapServer::setPassword ( const QString &  password)

Sets the password of the LDAP connection.

Definition at line 211 of file ldapserver.cpp.

void LdapServer::setPort ( int  port)

Sets the port of the LDAP connection.

If not port is set, 389 is used as default.

Definition at line 186 of file ldapserver.cpp.

void LdapServer::setRealm ( const QString &  realm)

Sets the realm of the LDAP connection.

Definition at line 206 of file ldapserver.cpp.

void LdapServer::setScope ( LdapUrl::Scope  scope)

Sets the search scope of the LDAP connection.

Definition at line 236 of file ldapserver.cpp.

void LdapServer::setSecurity ( Security  mode)

Sets the security mode of the LDAP connection.

If no security is set, None is used as default.

Definition at line 246 of file ldapserver.cpp.

void LdapServer::setSizeLimit ( int  sizelimit)

Sets the size limit of the LDAP connection.

Definition at line 221 of file ldapserver.cpp.

void LdapServer::setTimeLimit ( int  limit)

Sets the time limit of the LDAP connection.

Definition at line 216 of file ldapserver.cpp.

void LdapServer::setTimeout ( int  timeout)

Sets the timeout of the LDAP connection.

Definition at line 261 of file ldapserver.cpp.

void LdapServer::setUrl ( const LdapUrl &  url)

Sets the server parameters from an RFC2255 compliant LDAP url.

Definition at line 266 of file ldapserver.cpp.

void LdapServer::setUser ( const QString &  user)

Sets the user of the LDAP connection.

Definition at line 196 of file ldapserver.cpp.

void LdapServer::setVersion ( int  version)

Sets the protocol version of the LDAP connection.

If no version is set, 3 is used as default.

Definition at line 241 of file ldapserver.cpp.

int LdapServer::sizeLimit ( ) const

Returns the size limit of the LDAP connection.

Definition at line 146 of file ldapserver.cpp.

int LdapServer::timeLimit ( ) const

Returns the time limit of the LDAP connection.

Definition at line 141 of file ldapserver.cpp.

int LdapServer::timeout ( ) const

Returns the timeout of the LDAP connection.

Definition at line 176 of file ldapserver.cpp.

LdapUrl LdapServer::url ( ) const

Returns the server parameters as an RFC2255 compliant LDAP Url.

The URL extensions which are supported: Standard: bindname KLDAP extensions: x-tls, x-version, x-sasl, x-mech, x-realm, x-sizelimit, x-timelimit, x-pagesize, x-timeout

Definition at line 349 of file ldapserver.cpp.

QString LdapServer::user ( ) const

Returns the user of the LDAP connection.

Definition at line 111 of file ldapserver.cpp.

int LdapServer::version ( ) const

Returns the protocol version of the LDAP connection.

Definition at line 156 of file ldapserver.cpp.


The documentation for this class was generated from the following files:
  • ldapserver.h
  • ldapserver.cpp

KLDAP Library

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

KDE-PIM Libraries

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