KLDAPCore::LdapServer Class

A class that contains LDAP server connection settings. More...

Header: #include <KLDAPCore/LdapServer>
CMake: find_package(KPim6LdapCore REQUIRED)
target_link_libraries(mytarget PRIVATE KPim6::LdapCore)

Public Functions

LdapServer()
LdapServer(const KLDAPCore::LdapUrl &url)
LdapServer(const KLDAPCore::LdapServer &other)
~LdapServer()
QStringList activities() const
KLDAPCore::LdapServer::Auth auth() const
KLDAPCore::LdapDN baseDn() const
QString bindDn() const
void clear()
int completionWeight() const
bool enablePlasmaActivities() const
QString filter() const
QString host() const
QString mech() const
int pageSize() const
QString password() const
int port() const
QString realm() const
LdapUrl::Scope scope() const
KLDAPCore::LdapServer::Security security() const
void setActivities(const QStringList &lst)
void setAuth(KLDAPCore::LdapServer::Auth authentication)
void setBaseDn(const KLDAPCore::LdapDN &baseDn)
void setBindDn(const QString &bindDn)
void setCompletionWeight(int value)
void setEnablePlasmaActivities(bool enabled)
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(KLDAPCore::LdapServer::Security mode)
void setSizeLimit(int sizelimit)
void setTLSCACertFile(const QString &caCertFile)
void setTLSRequireCertificate(KLDAPCore::LdapServer::TLSRequireCertificate reqCert)
void setTimeLimit(int limit)
void setTimeout(int timeout)
void setUrl(const KLDAPCore::LdapUrl &url)
void setUser(const QString &user)
void setVersion(int version)
int sizeLimit() const
int timeLimit() const
int timeout() const
QString tlsCACertFile() const
KLDAPCore::LdapServer::TLSRequireCertificate tlsRequireCertificate() const
KLDAPCore::LdapUrl url() const
QString user() const
int version() const
KLDAPCore::LdapServer &operator=(const KLDAPCore::LdapServer &other)

Detailed Description

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

Member Function Documentation

LdapServer::LdapServer()

Creates an empty LDAP server object.

[explicit] LdapServer::LdapServer(const KLDAPCore::LdapUrl &url)

Creates a new LDAP server object from an LDAP URL. url the LDAP URL of the server

LdapServer::LdapServer(const KLDAPCore::LdapServer &other)

Creates a new LDAP server object as a copy of another. other the LDAP server object to copy

[noexcept] LdapServer::~LdapServer()

Destroys the LDAP server object.

QStringList LdapServer::activities() const

Returns the list of activities for this server. Returns the list of activities

See also setActivities().

KLDAPCore::LdapServer::Auth LdapServer::auth() const

Returns the authentication method of the LDAP connection. Returns the authentication method

See also setAuth().

KLDAPCore::LdapDN LdapServer::baseDn() const

Returns the base DN of the LDAP connection. Returns the base DN

See also setBaseDn().

QString LdapServer::bindDn() const

Returns the bind DN of the LDAP connection. Returns the bind DN

See also setBindDn().

void LdapServer::clear()

Clears all server settings.

int LdapServer::completionWeight() const

Returns the completion weight for this server. Returns the completion weight

See also setCompletionWeight().

bool LdapServer::enablePlasmaActivities() const

Returns whether Plasma Activities support is enabled. Returns true if Plasma Activities are enabled

See also setEnablePlasmaActivities().

QString LdapServer::filter() const

Returns the filter string of the LDAP connection. Returns the filter string

See also setFilter().

QString LdapServer::host() const

Returns the host of the LDAP connection. Returns the host name

See also setHost().

QString LdapServer::mech() const

Returns the SASL mechanism of the LDAP connection. Returns the SASL mechanism

See also setMech().

int LdapServer::pageSize() const

Returns the page size of the LDAP connection. Returns the page size

See also setPageSize().

QString LdapServer::password() const

Returns the password of the LDAP connection. Returns the password

See also setPassword().

int LdapServer::port() const

Returns the port of the LDAP connection. Returns the port number

See also setPort().

QString LdapServer::realm() const

Returns the realm of the LDAP connection. Returns the realm

See also setRealm().

LdapUrl::Scope LdapServer::scope() const

Returns the search scope of the LDAP connection. Returns the search scope

See also setScope().

KLDAPCore::LdapServer::Security LdapServer::security() const

Returns the security mode of the LDAP connection. Returns the security mode

See also setSecurity().

void LdapServer::setActivities(const QStringList &lst)

Sets the list of activities for this server. lst the list of activities

See also activities().

void LdapServer::setAuth(KLDAPCore::LdapServer::Auth authentication)

Sets the authentication method of the LDAP connection. If no authentication method is set, Anonymous is used as default. authentication the authentication method to set

See also auth().

void LdapServer::setBaseDn(const KLDAPCore::LdapDN &baseDn)

Sets the base DN of the LDAP connection. baseDn the base DN to set

See also baseDn().

void LdapServer::setBindDn(const QString &bindDn)

Sets the bind DN of the LDAP connection. bindDn the bind DN to set

See also bindDn().

void LdapServer::setCompletionWeight(int value)

Sets the completion weight for this server. value the completion weight to set

See also completionWeight().

void LdapServer::setEnablePlasmaActivities(bool enabled)

Sets whether Plasma Activities support is enabled. enabled true to enable Plasma Activities

See also enablePlasmaActivities().

void LdapServer::setFilter(const QString &filter)

Sets the filter string of the LDAP connection. filter the filter string to set

See also filter().

void LdapServer::setHost(const QString &host)

Sets the host of the LDAP connection. host the host name to set

See also host().

void LdapServer::setMech(const QString &mech)

Sets the SASL mechanism of the LDAP connection. mech the SASL mechanism to set

See also mech().

void LdapServer::setPageSize(int size)

Sets the page size of the LDAP connection. size the page size

See also pageSize().

void LdapServer::setPassword(const QString &password)

Sets the password of the LDAP connection. password the password to set

See also password().

void LdapServer::setPort(int port)

Sets the port of the LDAP connection. If no port is set, 389 is used as default. port the LDAP port to set

See also port().

void LdapServer::setRealm(const QString &realm)

Sets the SASL realm of the LDAP connection. realm the realm to set

See also realm().

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

Sets the search scope of the LDAP connection. scope the search scope to set

See also scope().

void LdapServer::setSecurity(KLDAPCore::LdapServer::Security mode)

Sets the security mode of the LDAP connection. If no security is set, None is used as default. mode the security mode to set

See also security().

void LdapServer::setSizeLimit(int sizelimit)

Sets the size limit of the LDAP connection. sizelimit the size limit

See also sizeLimit().

void LdapServer::setTLSCACertFile(const QString &caCertFile)

Sets the CA certificate file for TLS/SSL connections. caCertFile the path to the CA certificate file

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

Sets the certificate requirement mode for TLS/SSL connections. reqCert the certificate requirement mode to set

void LdapServer::setTimeLimit(int limit)

Sets the time limit of the LDAP connection. limit the time limit in seconds

See also timeLimit().

void LdapServer::setTimeout(int timeout)

Sets the timeout of the LDAP connection. timeout the timeout in seconds

See also timeout().

void LdapServer::setUrl(const KLDAPCore::LdapUrl &url)

Sets the server parameters from an RFC2255 compliant LDAP URL. url the LDAP URL to set

See also url().

void LdapServer::setUser(const QString &user)

Sets the user of the LDAP connection. user the user name to set

See also user().

void LdapServer::setVersion(int version)

Sets the protocol version of the LDAP connection. If no version is set, 3 is used as default. version the protocol version to set

See also version().

int LdapServer::sizeLimit() const

Returns the size limit of the LDAP connection. Returns the size limit

See also setSizeLimit().

int LdapServer::timeLimit() const

Returns the time limit of the LDAP connection. Returns the time limit in seconds

See also setTimeLimit().

int LdapServer::timeout() const

Returns the timeout of the LDAP connection. Returns the timeout in seconds

See also setTimeout().

QString LdapServer::tlsCACertFile() const

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

KLDAPCore::LdapServer::TLSRequireCertificate LdapServer::tlsRequireCertificate() const

Returns the certificate requirement mode for TLS/SSL connections. Returns the certificate requirement mode

KLDAPCore::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 Returns the LDAP URL

See also setUrl().

QString LdapServer::user() const

Returns the user of the LDAP connection. Returns the user name

See also setUser().

int LdapServer::version() const

Returns the protocol version of the LDAP connection. Returns the protocol version

See also setVersion().

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

Assigns the values from another LDAP server object to this object. other the LDAP server object to assign Returns a reference to this object