KLDAP::LdapServer

KLDAP::LdapServer Class Reference

#include <ldapserver.h>

Public Types

enum  Auth { Anonymous, Simple, SASL }
 
enum  Security { None, TLS, SSL }
 
enum  TLSRequireCertificate {
  TLSReqCertDefault, TLSReqCertNever, TLSReqCertDemand, TLSReqCertAllow,
  TLSReqCertTry, TLSReqCertHard
}
 

Public Member Functions

 LdapServer ()
 
 LdapServer (const LdapUrl &url)
 
 LdapServer (const LdapServer &other)
 
 ~LdapServer ()
 
Auth auth () const
 
LdapDN baseDn () const
 
QString bindDn () const
 
void clear ()
 
int completionWeight () const
 
QString filter () const
 
QString host () const
 
QString mech () const
 
LdapServeroperator= (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 setCompletionWeight (int value)
 
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 setTLSCACertFile (const QString &caCertFile)
 
void setTLSRequireCertificate (TLSRequireCertificate reqCert)
 
void setUrl (const LdapUrl &url)
 
void setUser (const QString &user)
 
void setVersion (int version)
 
int sizeLimit () const
 
int timeLimit () const
 
int timeout () const
 
QString tlsCACertFile () const
 
TLSRequireCertificate tlsRequireCertificate () 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 26 of file ldapserver.h.

Member Enumeration Documentation

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 71 of file ldapserver.h.

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 61 of file ldapserver.h.

Describes the certificate request and check behaviour for TLS/SSL connections.

Enumerator
TLSReqCertDefault 

Use system defaults.

TLSReqCertNever 

Do not require any certificates.

TLSReqCertDemand 

Use LDAP_OPT_X_TLS_DEMAND.

TLSReqCertAllow 

Use LDAP_OPT_X_TLS_ALLOW.

TLSReqCertTry 

Use LDAP_OPT_X_TLS_TRY.

TLSReqCertHard 

Use LDAP_OPT_X_TLS_HARD.

Definition at line 81 of file ldapserver.h.

Constructor & Destructor Documentation

LdapServer::LdapServer ( )

Creates an empty LDAP server object.

Definition at line 39 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 45 of file ldapserver.cpp.

LdapServer::LdapServer ( const LdapServer other)

Creates a new LDAP server object from an other object.

Definition at line 53 of file ldapserver.cpp.

LdapServer::~LdapServer ( )

Destroys the LDAP server object.

Definition at line 70 of file ldapserver.cpp.

Member Function Documentation

LdapServer::Auth LdapServer::auth ( ) const

Returns the authentication method of the LDAP connection.

Definition at line 163 of file ldapserver.cpp.

LdapDN LdapServer::baseDn ( ) const

Returns the baseDn of the LDAP connection.

Definition at line 103 of file ldapserver.cpp.

QString LdapServer::bindDn ( ) const

Returns the bindDn of the LDAP connection.

Definition at line 113 of file ldapserver.cpp.

void LdapServer::clear ( )

Clears all server settings.

Definition at line 75 of file ldapserver.cpp.

QString LdapServer::filter ( ) const

Returns the filter string of the LDAP connection.

Definition at line 128 of file ldapserver.cpp.

QString LdapServer::host ( ) const

Returns the host of the LDAP connection.

Definition at line 93 of file ldapserver.cpp.

QString LdapServer::mech ( ) const

Returns the mech of the LDAP connection.

Definition at line 178 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 59 of file ldapserver.cpp.

int LdapServer::pageSize ( ) const

Returns the page size of the LDAP connection.

Definition at line 148 of file ldapserver.cpp.

QString LdapServer::password ( ) const

Returns the password of the LDAP connection.

Definition at line 123 of file ldapserver.cpp.

int LdapServer::port ( ) const

Returns the port of the LDAP connection.

Definition at line 98 of file ldapserver.cpp.

QString LdapServer::realm ( ) const

Returns the realm of the LDAP connection.

Definition at line 118 of file ldapserver.cpp.

LdapUrl::Scope LdapServer::scope ( ) const

Returns the search scope of the LDAP connection.

Definition at line 133 of file ldapserver.cpp.

LdapServer::Security LdapServer::security ( ) const

Returns the security mode of the LDAP connection.

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

Parameters
authenticationthe authentication method to set

Definition at line 258 of file ldapserver.cpp.

void LdapServer::setBaseDn ( const LdapDN &  baseDn)

Sets the baseDn of the LDAP connection.

Definition at line 198 of file ldapserver.cpp.

void LdapServer::setBindDn ( const QString bindDn)

Sets the bindDn of the LDAP connection.

Definition at line 208 of file ldapserver.cpp.

void LdapServer::setFilter ( const QString filter)

Sets the filter string of the LDAP connection.

Definition at line 238 of file ldapserver.cpp.

void LdapServer::setHost ( const QString host)

Sets the host of the LDAP connection.

Definition at line 188 of file ldapserver.cpp.

void LdapServer::setMech ( const QString mech)

Sets the mech of the LDAP connection.

Definition at line 273 of file ldapserver.cpp.

void LdapServer::setPageSize ( int  size)

Sets the page size of the LDAP connection.

Definition at line 233 of file ldapserver.cpp.

void LdapServer::setPassword ( const QString password)

Sets the password of the LDAP connection.

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

Parameters
portthe LDAP port connection to set

Definition at line 193 of file ldapserver.cpp.

void LdapServer::setRealm ( const QString realm)

Sets the realm of the LDAP connection.

Definition at line 213 of file ldapserver.cpp.

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

Sets the search scope of the LDAP connection.

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

Parameters
modethe security mode to set

Definition at line 253 of file ldapserver.cpp.

void LdapServer::setSizeLimit ( int  sizelimit)

Sets the size limit of the LDAP connection.

Definition at line 228 of file ldapserver.cpp.

void LdapServer::setTimeLimit ( int  limit)

Sets the time limit of the LDAP connection.

Definition at line 223 of file ldapserver.cpp.

void LdapServer::setTimeout ( int  timeout)

Sets the timeout of the LDAP connection.

Definition at line 278 of file ldapserver.cpp.

void LdapServer::setTLSCACertFile ( const QString caCertFile)

Sets the CA certificate file for TLS/SSL connections.

Definition at line 268 of file ldapserver.cpp.

void LdapServer::setTLSRequireCertificate ( LdapServer::TLSRequireCertificate  reqCert)

Sets the certificate require mode for TLS/SSL connections.

Definition at line 263 of file ldapserver.cpp.

void LdapServer::setUrl ( const LdapUrl url)

Sets the server parameters from an RFC2255 compliant LDAP url.

Definition at line 283 of file ldapserver.cpp.

void LdapServer::setUser ( const QString user)

Sets the user of the LDAP connection.

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

Parameters
versionthe protocol version to set

Definition at line 248 of file ldapserver.cpp.

int LdapServer::sizeLimit ( ) const

Returns the size limit of the LDAP connection.

Definition at line 143 of file ldapserver.cpp.

int LdapServer::timeLimit ( ) const

Returns the time limit of the LDAP connection.

Definition at line 138 of file ldapserver.cpp.

int LdapServer::timeout ( ) const

Returns the timeout of the LDAP connection.

Definition at line 183 of file ldapserver.cpp.

QString LdapServer::tlsCACertFile ( ) const

Returns the CA certificate file used for TLS/SSL connections.

Definition at line 173 of file ldapserver.cpp.

LdapServer::TLSRequireCertificate LdapServer::tlsRequireCertificate ( ) const

Returns the certificate require mode for TLS/SSL connections.

Definition at line 168 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 366 of file ldapserver.cpp.

QString LdapServer::user ( ) const

Returns the user of the LDAP connection.

Definition at line 108 of file ldapserver.cpp.

int LdapServer::version ( ) const

Returns the protocol version of the LDAP connection.

Definition at line 153 of file ldapserver.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Mon Aug 10 2020 23:14:56 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.