/usr/include/kldap/ldapsearch.h is in kdepimlibs5-dev 4:4.14.10-1ubuntu7.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 | /*
This file is part of libkldap.
Copyright (c) 2004-2006 Szombathelyi György <gyurco@freemail.hu>
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Library General Public
License as published by the Free Software Foundation; either
version 2 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Library General Public License for more details.
You should have received a copy of the GNU Library General Public License
along with this library; see the file COPYING.LIB. If not, write to
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.
*/
#ifndef KLDAP_LDAPSEARCH_H
#define KLDAP_LDAPSEARCH_H
#include <QtCore/QByteArray>
#include <QtCore/QList>
#include <QtCore/QObject>
#include <QtCore/QString>
#include "kldap_export.h"
#include "ldapconnection.h"
#include "ldapcontrol.h"
#include "ldapobject.h"
#include "ldapoperation.h"
#include "ldapserver.h"
#include "ldapurl.h"
namespace KLDAP {
/**
* @brief
* This class starts a search operation on a LDAP server and returns the
* search values via a Qt signal.
*/
class KLDAP_EXPORT LdapSearch : public QObject
{
Q_OBJECT
public:
/**
* Constructs an LdapSearch object
*/
LdapSearch();
/**
* Constructs an LdapConnection object with the given connection. If this
* form of constructor used, then always this connection will be used
* regardless of the LDAP Url or LdapServer object passed to search().
* @param connection the connection used to construct LdapConnection object
*/
explicit LdapSearch( LdapConnection &connection );
virtual ~LdapSearch();
/**
* Sets the connection for this object to use for searches from now
* onwards, regardless of the LDAP Url or LdapServer object passed to
* search().
*/
void setConnection( LdapConnection &connection );
/**
* Sets the client controls which will sent with each operation.
*/
void setClientControls( const LdapControls &ctrls );
/**
* Sets the server controls which will sent with each operation.
*/
void setServerControls( const LdapControls &ctrls );
/**
* Starts a search operation on the LDAP server @param server,
* returning the attributes specified with @param attributes.
* @param count means how many entries to list. If it's >0, then result()
* will be emitted when the number of entries is reached, but with
* isFinished() set to false.
*/
bool search( const LdapServer &server,
const QStringList &attributes = QStringList(), int count = 0 );
/**
* Starts a search operation on the given LDAP URL.
*/
bool search( const LdapUrl &url, int count = 0 );
/**
* Starts a search operation if the LdapConnection object already set
* in the constructor.
*/
bool search( const LdapDN &base,
LdapUrl::Scope scope = LdapUrl::Sub,
const QString &filter = QString(),
const QStringList &attributes = QStringList(),
int pagesize = 0, int count = 0 );
/**
* Continues the search (if you set count to non-zero in search(), and isFinished() is false)
*/
void continueSearch();
/**
* Returns true if the search is finished else returns false.
*/
bool isFinished();
/**
* Tries to abandon the search.
*/
void abandon();
/**
* Returns the error code of the search operation (0 if no error).
*/
int error() const;
/**
* Returns the error description of the search operation.
*/
QString errorString() const;
Q_SIGNALS:
/**
* Emitted for each result object.
*/
void data( KLDAP::LdapSearch *search, const KLDAP::LdapObject &obj );
/**
* Emitted when the searching finished.
*/
void result( KLDAP::LdapSearch *search );
private:
class Private;
Private *const d;
Q_PRIVATE_SLOT( d, void result() )
Q_DISABLE_COPY( LdapSearch )
};
}
#endif
|