KLDAP::LdapClient Class Reference

#include <ldapclient.h>

Inheritance diagram for KLDAP::LdapClient:

Signals
void	done ()
void	error (const QString &message)
void	result (const KLDAP::LdapClient &client, const KLDAP::LdapObject &)

Public Member Functions
	LdapClient (int clientNumber, QObject *parent=0)
virtual	~LdapClient ()
QStringList	attributes () const
void	cancelQuery ()
int	clientNumber () const
int	completionWeight () const
bool	isActive () const
const KLDAP::LdapServer	server () const
void	setAttributes (const QStringList &attributes)
void	setCompletionWeight (int weight)
void	setScope (const QString scope)
void	setServer (const KLDAP::LdapServer &server)
void	startQuery (const QString &filter)

Detailed Description

An object that represents a configured LDAP server.

This class represents a client that to an LDAP server that can be used for LDAP lookups. Every client is identified by a unique numeric id.

Since

4.5

Definition at line 48 of file ldapclient.h.

Constructor & Destructor Documentation

LdapClient::LdapClient ( int  clientNumber, QObject *  parent = 0  )

explicit

Creates a new ldap client.

Parameters

clientNumber	The unique number of this client.
parent	The parent object.

Definition at line 93 of file ldapclient.cpp.

LdapClient::~LdapClient ( )

virtual

Destroys the ldap client.

Definition at line 100 of file ldapclient.cpp.

Member Function Documentation

QStringList LdapClient::attributes

(

)

const

Returns the LDAP attributes that should be returned in the query result.

Definition at line 131 of file ldapclient.cpp.

void LdapClient::cancelQuery

(

)

Cancels a running query.

Definition at line 173 of file ldapclient.cpp.

int LdapClient::clientNumber

(

)

const

Returns the number of this client.

Definition at line 307 of file ldapclient.cpp.

int LdapClient::completionWeight

(

)

const

Returns the completion weight of this client.

Definition at line 312 of file ldapclient.cpp.

void KLDAP::LdapClient::done ( )

signal

This signal is emitted when the query has finished.

void KLDAP::LdapClient::error ( const QString &  message )

signal

This signal is emitted in case of an error.

Parameters

message

A message that describes the error.

bool LdapClient::isActive

(

)

const

Returns whether this client is currently running a search query.

Definition at line 105 of file ldapclient.cpp.

void KLDAP::LdapClient::result ( const KLDAP::LdapClient &  client, const KLDAP::LdapObject &    )

signal

This signal is emitted once for each object that is returned from the query.

const KLDAP::LdapServer LdapClient::server

(

)

const

Returns the ldap server information that are used by this client.

Definition at line 120 of file ldapclient.cpp.

void LdapClient::setAttributes

(

const QStringList &

attributes

)

Sets the LDAP attributes that should be returned in the query result.

Pass an empty list to include all available attributes.

Definition at line 125 of file ldapclient.cpp.

void LdapClient::setCompletionWeight

(

int

weight

)

Sets the completion weight of this client.

This value will be used to sort the results of this client when used for auto completion.

Definition at line 317 of file ldapclient.cpp.

void LdapClient::setScope

(

const QString

scope

)

Sets the scope of the LDAP query.

Valid values are 'one' or 'sub'.

Definition at line 136 of file ldapclient.cpp.

void LdapClient::setServer

(

const KLDAP::LdapServer &

server

)

Sets the LDAP server information that shall be used by this client.

Definition at line 110 of file ldapclient.cpp.

void LdapClient::startQuery

(

const QString &

filter

)

Starts the query with the given filter.

Definition at line 141 of file ldapclient.cpp.

---

The documentation for this class was generated from the following files:

• ldapclient.h
• ldapclient.cpp