qgsserverinterface.h

Go to the documentation of this file.

/***************************************************************************
                          qgsseerversinterface.h
 Interface class for exposing functions in QGIS Server for use by 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 "qgscapabilitiescache.h"
#include "qgsrequesthandler.h"
#include "qgsserverfilter.h"
#include "qgsaccesscontrolfilter.h"
#include "qgsaccesscontrol.h"

class SERVER_EXPORT QgsServerInterface
{

  public:

    QgsServerInterface();

    virtual ~QgsServerInterface() = 0;

    virtual void setRequestHandler( QgsRequestHandler* requestHandler ) = 0;

    virtual void clearRequestHandler() = 0;

    virtual QgsCapabilitiesCache* capabiblitiesCache() = 0;

    virtual QgsRequestHandler* requestHandler() = 0;

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

    virtual void setFilters( QgsServerFiltersMap* filters ) = 0;

    virtual QgsServerFiltersMap filters() = 0;
    virtual void registerAccessControl( QgsAccessControlFilter* accessControl, int priority = 0 ) = 0;
    virtual const QgsAccessControl* accessControls() 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 void removeProjectLayers( const QString& path ) = 0;




  private:
    QString mConfigFilePath;
};

#endif // QGSSERVERINTERFACE_H