ldapconnection.h

/*
  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_LDAPCONNECTION_H
#define KLDAP_LDAPCONNECTION_H

#include <QtCore/QString>

#include "ldapurl.h"
#include "ldapserver.h"
#include "kldap_export.h"

namespace KLDAP {

class KLDAP_EXPORT LdapConnection
{
  public:

    enum SASL_Fields {
      SASL_Authname = 0x1,
      SASL_Authzid = 0x2,
      SASL_Realm = 0x4,
      SASL_Password = 0x8
    };

    LdapConnection();
    explicit LdapConnection( const LdapUrl &url );
    explicit LdapConnection( const LdapServer &server );

    virtual ~LdapConnection();

    void setUrl( const LdapUrl &url );
    const LdapServer &server() const;
    void setServer( const LdapServer &server );

    int connect();
    QString connectionError() const;
    void close();

    bool setSizeLimit( int sizelimit );
    int sizeLimit() const;

    bool setTimeLimit( int timelimit );
    int timeLimit() const;

    int getOption( int option, void *value ) const;
    int setOption( int option, void *value );

    int ldapErrorCode() const;
    QString ldapErrorString() const;
    static QString errorString( int code );

    QString saslErrorString() const;

    void *handle() const;

    void *saslHandle() const;

  private:
    class LdapConnectionPrivate;
    LdapConnectionPrivate *const d;

    Q_DISABLE_COPY( LdapConnection )
};

}

#endif