workspace/libs/solid/control/ifaces/authentication.h

   1 /*  This file is part of the KDE project
   2     Copyright (C) 2006,2007 Will Stephenson <wstephenson@kde.org>
   3
   4     This library is free software; you can redistribute it and/or
   5     modify it under the terms of the GNU Library General Public
   6     License version 2 as published by the Free Software Foundation.
   7
   8     This library is distributed in the hope that it will be useful,
   9     but WITHOUT ANY WARRANTY; without even the implied warranty of
  10     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11     Library General Public License for more details.
  12
  13     You should have received a copy of the GNU Library General Public License
  14     along with this library; see the file COPYING.LIB.  If not, write to
  15     the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  16     Boston, MA 02110-1301, USA.
  17
  18 */
  19
  20 #ifndef SOLID_IFACES_AUTHENTICATION_H
  21 #define SOLID_IFACES_AUTHENTICATION_H
  22
  23 #include <QtCore/QObject>
  24 #include <QtCore/QMap>
  25 #include <QtCore/QString>
  26
  27 #include <solid/control/solid_control_export.h>
  28
  29 namespace Solid
  30 {
  31 namespace Control
  32 {
  33     class Authentication;
  34
  35 namespace Ifaces
  36 {
  37     /**
  38      * Utility interface
  39      * Specifies a backend specific validator class to validate authentication
  40      * Can be used for example to authenticate user input as they type
  41      */
  42     class SOLIDCONTROLIFACES_EXPORT AuthenticationValidator
  43     {
  44         public:
  45             virtual ~AuthenticationValidator();
  46             /**
  47              * Call this to check if an authentication is valid
  48              * (All secrets present, passphrase length correct
  49              */
  50             virtual bool validate(const Authentication *) = 0;
  51     };
  52 } // Ifaces
  53 } // Control
  54 } // Solid
  55
  56 Q_DECLARE_INTERFACE(Solid::Control::Ifaces::AuthenticationValidator, "org.kde.Solid.Control.Ifaces.AuthenticationValidator/0.1")
  57
  58 #endif /* SOLID_IFACES_AUTHENTICATION_H */