qgsauthmethod.h

Go to the documentation of this file.

/***************************************************************************
    qgsauthmethod.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 QGSAUTHMETHOD_H
#define QGSAUTHMETHOD_H

#include <QObject>
#include <QFlags>
#include <QNetworkReply>
#include <QNetworkRequest>
#include <QStringList>
#include <QUrl>

#include "qgsauthconfig.h"


class CORE_EXPORT QgsAuthMethod : public QObject
{
    Q_OBJECT

  public:

    enum Expansion
    {
      // TODO: Figure out all different authentication expansions current layer providers use
      NetworkRequest       = 0x1,
      NetworkReply         = 0x2,
      DataSourceURI        = 0x4,
      GenericDataSourceURI = 0x8,
      All = NetworkRequest | NetworkReply | DataSourceURI | GenericDataSourceURI
    };
    Q_DECLARE_FLAGS( Expansions, Expansion )

    virtual ~QgsAuthMethod() {}

    virtual QString key() const = 0;

    virtual QString description() const = 0;

    virtual QString displayDescription() const = 0;

    int version() const { return mVersion; }

    QgsAuthMethod::Expansions supportedExpansions() const { return mExpansions; }

    QStringList supportedDataProviders() const { return mDataProviders; }

    virtual bool updateNetworkRequest( QNetworkRequest &request, const QString &authcfg,
                                       const QString &dataprovider = QString() )
    {
      Q_UNUSED( request )
      Q_UNUSED( authcfg )
      Q_UNUSED( dataprovider )
      return true; // noop
    }

    virtual bool updateNetworkReply( QNetworkReply *reply, const QString &authcfg,
                                     const QString &dataprovider = QString() )
    {
      Q_UNUSED( reply )
      Q_UNUSED( authcfg )
      Q_UNUSED( dataprovider )
      return true; // noop
    }

    virtual bool updateDataSourceUriItems( QStringList &connectionItems, const QString &authcfg,
                                           const QString &dataprovider = QString() )
    {
      Q_UNUSED( connectionItems )
      Q_UNUSED( authcfg )
      Q_UNUSED( dataprovider )
      return true; // noop
    }

    virtual void clearCachedConfig( const QString &authcfg ) = 0;

    virtual void updateMethodConfig( QgsAuthMethodConfig &mconfig ) = 0;

  protected:
    explicit QgsAuthMethod()
        : mExpansions( QgsAuthMethod::Expansions( nullptr ) )
        , mDataProviders( QStringList() )
        , mVersion( 0 )
    {}

    static QString authMethodTag() { return QObject::tr( "Authentication method" ); }

    void setVersion( int version ) { mVersion = version; }

    void setExpansions( const QgsAuthMethod::Expansions& expansions ) { mExpansions = expansions; }
    void setDataProviders( const QStringList& dataproviders ) { mDataProviders = dataproviders; }

    QgsAuthMethod::Expansions mExpansions;
    QStringList mDataProviders;
    int mVersion;
};
Q_DECLARE_OPERATORS_FOR_FLAGS( QgsAuthMethod::Expansions )

typedef QHash<QString, QgsAuthMethod*> QgsAuthMethodsMap;

#endif // QGSAUTHMETHOD_H