LDAPAsynConnection.h

Go to the documentation of this file.

// $OpenLDAP$
/*
 * Copyright 2000-2011 The OpenLDAP Foundation, All Rights Reserved.
 * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
 */


#ifndef LDAP_ASYN_CONNECTION_H
#define LDAP_ASYN_CONNECTION_H

#include<iostream>
#include<string>

#include<ldap.h>

#include <LDAPEntry.h>
#include <LDAPException.h>
#include <LDAPMessageQueue.h>
#include <LDAPConstraints.h>
#include <LDAPModification.h>
#include <LDAPModList.h>
#include <LDAPUrl.h>
#include <LDAPUrlList.h>
#include <SaslInteractionHandler.h>
#include <TlsOptions.h>

//* Main class for an asynchronous LDAP connection 
class LDAPAsynConnection{
    public :
        static const int SEARCH_BASE=0;
        
        static const int SEARCH_ONE=1;
        
        static const int SEARCH_SUB=2;

        LDAPAsynConnection(const std::string& url=std::string("localhost"),
                int port=0, LDAPConstraints *cons=new LDAPConstraints() );

        //* Destructor
        virtual ~LDAPAsynConnection();
        void init(const std::string& hostname, int port);

        void initialize(const std::string& uri);

        void start_tls();

        LDAPMessageQueue* bind(const std::string& dn="", 
                const std::string& passwd="",
                const LDAPConstraints *cons=0);

        LDAPMessageQueue* saslBind(const std::string& mech, 
                const std::string& cred, 
                const LDAPConstraints *cons=0);

        LDAPMessageQueue* saslInteractiveBind(const std::string& mech,
                int flags=0,
                SaslInteractionHandler *sih=0,
                const LDAPConstraints *cons=0);

        LDAPMessageQueue* search(const std::string& base="", int scope=0, 
                                 const std::string& filter="objectClass=*", 
                                 const StringList& attrs=StringList(), 
                                 bool attrsOnly=false,
                                 const LDAPConstraints *cons=0);

        LDAPMessageQueue* del(const std::string& dn, const LDAPConstraints *cons=0);

        LDAPMessageQueue* compare(const std::string& dn, 
                const LDAPAttribute& attr, 
                const LDAPConstraints *cons=0);

        LDAPMessageQueue* add( const LDAPEntry* le,
                const LDAPConstraints *const=0);

        LDAPMessageQueue* modify(const std::string& dn, 
                const LDAPModList *modlist,
                const LDAPConstraints *cons=0);

        LDAPMessageQueue* rename(const std::string& dn, 
                const std::string& newRDN,
                bool delOldRDN=false, const std::string& newParentDN="",
                const LDAPConstraints* cons=0);

        LDAPMessageQueue* extOperation(const std::string& oid, 
                const std::string& value="", const LDAPConstraints *cons=0);

        void abandon(LDAPMessageQueue *q);

        void unbind();

        LDAP* getSessionHandle() const ;

        const std::string& getHost() const;

        int getPort() const;

        void setConstraints(LDAPConstraints *cons);

        const LDAPConstraints* getConstraints() const;
        TlsOptions getTlsOptions() const;
        LDAPAsynConnection* referralConnect(const LDAPUrlList& urls,
                LDAPUrlList::const_iterator& usedUrl,
                const LDAPConstraints* cons) const;

    private :
        LDAPAsynConnection(const LDAPAsynConnection& lc){};

        LDAP *cur_session;

        LDAPConstraints *m_constr;

        LDAPUrl m_uri;

    protected:
        bool m_cacheEnabled;
};
#endif //LDAP_ASYN_CONNECTION_H