certmanager/lib Library API Documentation

cryptobackendfactory.h

00001 /*
00002     kleo/cryptobackendfactory.h
00003 
00004     This file is part of libkleopatra, the KDE keymanagement library
00005     Copyright (c) 2004,2005 Klarälvdalens Datakonsult AB
00006 
00007     Libkleopatra is free software; you can redistribute it and/or
00008     modify it under the terms of the GNU General Public License as
00009     published by the Free Software Foundation; either version 2 of the
00010     License, or (at your option) any later version.
00011 
00012     Libkleopatra is distributed in the hope that it will be useful,
00013     but WITHOUT ANY WARRANTY; without even the implied warranty of
00014     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00015     General Public License for more details.
00016 
00017     You should have received a copy of the GNU General Public License
00018     along with this program; if not, write to the Free Software
00019     Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
00020 
00021     In addition, as a special exception, the copyright holders give
00022     permission to link the code of this program with any edition of
00023     the Qt library by Trolltech AS, Norway (or with modified versions
00024     of Qt that use the same license as Qt), and distribute linked
00025     combinations including the two.  You must obey the GNU General
00026     Public License in all respects for all of the code used other than
00027     Qt.  If you modify this file, you may extend this exception to
00028     your version of the file, but you are not obligated to do so.  If
00029     you do not wish to do so, delete this exception statement from
00030     your version.
00031 */
00032 
00033 #ifndef __KLEO_CRYPTOBACKENDFACTORY_H__
00034 #define __KLEO_CRYPTOBACKENDFACTORY_H__
00035 
00036 #include <qobject.h>
00037 
00038 #include "cryptobackend.h"
00039 
00040 #include <vector>
00041 #include <map>
00042 
00043 namespace Kleo {
00044   class BackendConfigWidget;
00045 }
00046 
00047 class QString;
00048 class KConfig;
00049 
00050 namespace Kleo {
00051 
00052   struct lt_i_str {
00053     bool operator()( const char * one, const char * two ) const {
00054       return qstricmp( one, two ) < 0;
00055     }
00056   };
00057 
00058   class CryptoBackendFactory : public QObject {
00059     Q_OBJECT
00060   protected:
00061     CryptoBackendFactory();
00062     ~CryptoBackendFactory();
00063   public:
00064     static CryptoBackendFactory * instance();
00065 
00066     const CryptoBackend::Protocol * smime() const;
00067     const CryptoBackend::Protocol * openpgp() const;
00068     const CryptoBackend::Protocol * protocol( const char * name ) const;
00069     CryptoConfig * config() const;
00070 
00071     const CryptoBackend * backend( unsigned int idx ) const;
00072 
00073     bool hasBackends() const;
00074 
00075     Kleo::BackendConfigWidget * configWidget( QWidget * parent=0, const char * name=0 ) const;
00076 
00077     KConfig* configObject() const;
00078 
00079     // The preferred backend for smime (can be 0) - currently unused
00080     //const CryptoBackend* smimeBackend() const;
00081     // The preferred backend for openpgp (can be 0) - currently unused
00082     //const CryptoBackend* openpgpBackend() const;
00083 
00084     // For BackendConfigWidget to save the configuration
00085     // 0 means no backend selected.
00086     void setSMIMEBackend( const CryptoBackend* backend );
00087     void setOpenPGPBackend( const CryptoBackend* backend );
00088     void setProtocolBackend( const char * name, const CryptoBackend * backend );
00089 
00090     void scanForBackends( QStringList * reasons=0 );
00091 
00092     const char * enumerateProtocols( int i ) const;
00093 
00094     bool knowsAboutProtocol( const char * name ) const;
00095 
00096   protected:
00097     std::vector<CryptoBackend*> mBackendList;
00098     mutable KConfig* mConfigObject;
00099     typedef std::map<const char *, const CryptoBackend*, lt_i_str> BackendMap;
00100     BackendMap mBackends;
00101     typedef std::vector<const char *> ProtocolSet;
00102     ProtocolSet mAvailableProtocols;
00103 
00104   private:
00105     const CryptoBackend * backendByName( const QString& name ) const;
00106     void readConfig();
00107     CryptoBackendFactory( const CryptoBackendFactory & );
00108     void operator=( const CryptoBackendFactory & );
00109 
00110     static CryptoBackendFactory * mSelf;
00111   };
00112 
00113 
00114 }
00115 
00116 #endif // __KLEO_CRYPTOBACKENDFACTORY_H__
KDE Logo
This file is part of the documentation for certmanager/lib Library Version 3.3.2.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Wed Jan 31 15:53:09 2007 by doxygen 1.4.2 written by Dimitri van Heesch, © 1997-2003