qgsserverinterface.h

Go to the documentation of this file.

/***************************************************************************
                          qgsserverinterface.h

  Class defining the interface made available to QGIS Server plugins.
  -------------------
  begin                : 2014-09-10
  copyright            : (C) 2014 by Alessandro Pasotti
  email                : a dot pasotti at itopen dot it
 ***************************************************************************/

/***************************************************************************
 *                                                                         *
 *   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 QGSSERVERINTERFACE_H
#define QGSSERVERINTERFACE_H

#include "qgsconfig.h"
#include "qgis_sip.h"
#include "qgscapabilitiescache.h"
#include "qgsrequesthandler.h"
#include "qgsserverfilter.h"
#include "qgsserversettings.h"
#ifdef HAVE_SERVER_PYTHON_PLUGINS
#include "qgsaccesscontrolfilter.h"
#include "qgsaccesscontrol.h"
#include "qgsservercachefilter.h"
#include "qgsservercachemanager.h"
#else
class QgsAccessControl;
class QgsAccessControlFilter;
class QgsServerCacheManager;
class QgsServerCacheFilter;
#endif
#include "qgsserviceregistry.h"
#include "qgis_server.h"

SIP_IF_MODULE( HAVE_SERVER_PYTHON_PLUGINS )



class SERVER_EXPORT QgsServerInterface
{
  public:

    QgsServerInterface() SIP_SKIP;

    virtual ~QgsServerInterface() = default;

    virtual void setRequestHandler( QgsRequestHandler *requestHandler ) = 0 SIP_SKIP;

    virtual void clearRequestHandler() = 0 SIP_SKIP;

    virtual QgsCapabilitiesCache *capabilitiesCache() = 0 SIP_KEEPREFERENCE;

    virtual QgsRequestHandler *requestHandler() = 0 SIP_KEEPREFERENCE;

    virtual void registerFilter( QgsServerFilter *filter SIP_TRANSFER, int priority = 0 ) = 0;

    virtual void setFilters( QgsServerFiltersMap *filters SIP_TRANSFER ) = 0;

    virtual QgsServerFiltersMap filters() = 0;

    virtual void registerAccessControl( QgsAccessControlFilter *accessControl SIP_TRANSFER, int priority = 0 ) = 0;

    virtual QgsAccessControl *accessControls() const = 0;

    virtual void registerServerCache( QgsServerCacheFilter *serverCache SIP_TRANSFER, int priority = 0 ) = 0;

    virtual QgsServerCacheManager *cacheManager() const = 0;

    virtual QString getEnv( const QString &name ) const = 0;

    virtual QString configFilePath() = 0;

    virtual void setConfigFilePath( const QString &configFilePath ) = 0;

    virtual void removeConfigCacheEntry( const QString &path ) = 0;

    virtual QgsServiceRegistry *serviceRegistry() = 0 SIP_KEEPREFERENCE;

    virtual QgsServerSettings *serverSettings() = 0 SIP_SKIP;

  private:
#ifdef SIP_RUN
    QgsServerInterface();
#endif

    QString mConfigFilePath;
};

#endif // QGSSERVERINTERFACE_H