qgsauthmethodregistry.h

Go to the documentation of this file.

/***************************************************************************
    qgsauthmethodregistry.h
    ---------------------
    begin                : September 1, 2015
    copyright            : (C) 2015 by Boundless Spatial, Inc. USA
    author               : Larry Shaffer
    email                : lshaffer at boundlessgeo dot com
 ***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
 
#ifndef QGSAUTHMETHODREGISTRY_H
#define QGSAUTHMETHODREGISTRY_H
 
#define SIP_NO_FILE
 
#include <memory>
 
#include "qgis_core.h"
#include "qgis_sip.h"
 
#include <QDir>
#include <QLibrary>
#include <QMap>
#include <QString>
 
class QgsAuthMethod;
class QgsAuthMethodMetadata;
 

class CORE_EXPORT QgsAuthMethodRegistry
{
 
  public:
    static QgsAuthMethodRegistry *instance( const QString &pluginPath = QString() );
 
    virtual ~QgsAuthMethodRegistry();

    Q_DECL_DEPRECATED QString library( const QString &authMethodKey ) const SIP_DEPRECATED;

    QString pluginList( bool asHtml = false ) const;

    QDir libraryDirectory() const;

    void setLibraryDirectory( const QDir &path );

    QgsAuthMethod *createAuthMethod( const QString &authMethodKey );
 
#if 0

    // int authMethodCapabilities( const QString& authMethodKey ) const;
#endif

    QWidget *editWidget( const QString &authMethodKey, QWidget *parent = nullptr );

    QStringList authMethodList() const;

    const QgsAuthMethodMetadata *authMethodMetadata( const QString &authMethodKey ) const;

    typedef std::map<QString, QgsAuthMethodMetadata *> AuthMethods;
 
  private:

    QgsAuthMethodRegistry( const QString &pluginPath );
 
    void init();
    void clean();

    AuthMethods mAuthMethods;

    QDir mLibraryDirectory;
};
 
#endif // QGSAUTHMETHODREGISTRY_H