src/core/ldapauthenticator.h

   1 /***************************************************************************
   2  *   Copyright (C) 2005-2015 by the Quassel Project                        *
   3  *   devel@quassel-irc.org                                                 *
   4  *                                                                         *
   5  *   This program is free software; you can redistribute it and/or modify  *
   6  *   it under the terms of the GNU General Public License as published by  *
   7  *   the Free Software Foundation; either version 2 of the License, or     *
   8  *   (at your option) version 3.                                           *
   9  *                                                                         *
  10  *   This program is distributed in the hope that it will be useful,       *
  11  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  12  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  13  *   GNU General Public License for more details.                          *
  14  *                                                                         *
  15  *   You should have received a copy of the GNU General Public License     *
  16  *   along with this program; if not, write to the                         *
  17  *   Free Software Foundation, Inc.,                                       *
  18  *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.         *
  19  ***************************************************************************/
  20
  21 #ifndef LDAPAUTHENTICATOR_H
  22 #define LDAPAUTHENTICATOR_H
  23
  24 #include "authenticator.h"
  25
  26 class LdapAuthenticator : public Authenticator
  27 {
  28     Q_OBJECT
  29
  30 public:
  31     LdapAuthenticator(QObject *parent = 0);
  32     virtual ~LdapAuthenticator();
  33
  34 public slots:
  35     /* General */
  36     virtual bool isAvailable() const;
  37     virtual QString displayName() const;
  38     virtual QString description() const;
  39     virtual QStringList setupKeys() const;
  40     virtual QVariantMap setupDefaults() const;
  41
  42     /* User handling */
  43     virtual UserId getUserId(const QString &username);
  44
  45 protected:
  46         // Protecte methods for retrieving info about the LDAP connection.
  47         inline virtual QString hostName() { return _hostName; }
  48         inline virtual int port() { return _port; }
  49         inline virtual QString bindDN() { return _bindDN; }
  50         inline virtual QString baseDN() { return _baseDN; }
  51
  52 private:
  53     QString _hostName;
  54     int _port;
  55         QString _bindDN;
  56         QString _baseDN;
  57 };
  58
  59
  60 #endif