/usr/include/rds/client/rdsldapsession.h is in librdsclient-dev 1.1.0-0ubuntu1.
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 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 | /***************************************************************************
* Copyright (C) 2011 by Resara LLC *
* brendan@resara.com *
* *
* This program is free software; you can redistribute it and/or modify *
* it under the terms of the GNU Lesser General Public License as *
* published by the Free Software Foundation; either version 2 of the *
* License, or (at your option) any later version. *
* *
* This program 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 *
* Lesser General Public License for more details. *
* *
* You should have received a copy of the GNU Lesser General Public *
* License along with this program; if not, write to the *
* Free Software Foundation, Inc., *
* 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
* *
***************************************************************************/
#ifndef RDSLDAPSESSION_H
#define RDSLDAPSESSION_H
#include <QObject>
#include <QHash>
#include <QString>
#include <QMetaType>
#include <QxtPimpl>
#include <ReturnValue>
#include <QStringList>
#include <ClientProxy>
#include <QtGlobal>
#include <RdsLdapActions>
#include <rdsglobal.h>
class RdsLdapActionsPrivate;
struct LdapAction;
class RdsLdapSessionPrivate;
/**
@author Brendan Powers <brendan@resara.com>
*/
class RDS_CLIENT_EXPORT RdsLdapSession : public QtRpc::ClientProxy
{
QXT_DECLARE_PRIVATE(RdsLdapSession);
Q_OBJECT
public:
RdsLdapSession(QObject *parent = 0);
~RdsLdapSession();
/**
* Gets a pointer to the global ldap session
* @return RdsLdapSession pointer
*/
static RdsLdapSession *globalSession();
/**
* Sets the global session pointer
* @param session A pointer to the new global ldap session
*/
static void setGlobalSession(RdsLdapSession *session);
inline RdsLdapSession& operator=(const ReturnValue &ret)
{
QtRpc::ClientProxy::operator=(ret);
return *this;
}
signals:
/**
* Searches for objects in the basedn that match the filter (recursive)
* @param basedn the dn of the object to search in
* @param filter the search filter
* @return LdapResults containing the results of the search
*/
ReturnValue search(const QString &basedn, const QString &filter) const;
/**
* Searches for objects in the basedn that match the filter
* @param basedn the dn of the object to search in
* @param filter the search filter
* @param recursive whether the search should be recursive or not
* @return Ldap Results containing the results of the search
*/
ReturnValue search(const QString &basedn, const QString &filter, bool recursive) const;
/**
* Reads the values for the attributes of the object
* @param basedn the dn of the object to read the attributes from
* @return LdapResult containing the attrbutes and values
*/
ReturnValue read(const QString &basedn) const;
ReturnValue read(QObject *object, const char *slot, const QString &basedn) const;
/**
* Reads the only the values for the attributes contained in attrs
* @param basedn the dn of the object to read the attributes from
* @param attrs list of attributes to read
* @return LdapResult containing the attributes and values
*/
ReturnValue read(const QString &basedn, const QStringList &attrs) const;
ReturnValue read(QObject *object, const char *slot, const QString &basedn, const QStringList &attrs) const;
/**
* Lists the objects contained in the basedn (recursive)
* @param basedn the dn to list the contents of
* @return QStringList of dn's contained in the base dn
*/
ReturnValue list(const QString &basedn) const;
/**
* Lists the objects contained in the basedn that match the search filter (recursive)
* @param basedn the dn to list the matches from
* @param filter the search filter
* @return QString list of the dn's that matched the filter
*/
ReturnValue list(const QString &basedn, const QString &filter) const;
/**
* Lists the objects contained in the basedn that match the search filter
* @param basedn the dn to list the matches from
* @param filter the search filter
* @param recursive wheather to search recursively or not
* @return QStringList of dn's that matched the search criteria
*/
ReturnValue list(const QString &basedn, const QString &filter, bool recursive) const;
/**
* Adds the actions to a new object with distinguished name dn
* @param dn the distinguished name of the new object
* @param actions the actions to perfomr on the new object
* @return True on success, check error string on failure
*/
ReturnValue add(const QString &dn, const RdsLdapActions &actions);
/**
* Modifies an existing object
* @param dn the dn of the object to modify
* @param actions the changes to make
* @return True on success, check error string on failure
*/
ReturnValue modify(const QString &dn, const RdsLdapActions &actions);
ReturnValue modify(QObject *object, const char * slot, const QString &dn, const RdsLdapActions &actions);
/**
* Removes an object from the directory
* @param dn the dn of the object to remove
* @param recursive also delete child objects
* @return True on success, chech error string on failure
*/
ReturnValue remove(const QString &dn, bool recursive = false);
/**
* Re-names an object
* @param dn dn of the object to rename
* @param rdn the new rdn of the object
* @return True on success, check error string on failure
*/
ReturnValue rename(const QString &dn, const QString &rdn);
/**
* Moves an object to a new location in the directory
* @param dn the dn of the object to move
* @param newparent the dn of the new location in the directory
* @return True on success, check error string on failure
*/
ReturnValue move(const QString &dn, const QString &newparent);
};
typedef QList<QByteArray> LdapValues;
typedef QHash<QString, LdapValues> LdapResult;
typedef QHash<QString, LdapResult> LdapResults;
Q_DECLARE_METATYPE(LdapResults);
Q_DECLARE_METATYPE(LdapResult);
Q_DECLARE_METATYPE(LdapValues);
inline RdsLdapSession *rdsLdapSession()
{
return(RdsLdapSession::globalSession());
}
#endif
|