QGIS API Documentation  2.12.0-Lyon
qgsserverinterface.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgsseerversinterface.h
3  Interface class for exposing functions in QGIS Server for use by plugins
4  -------------------
5  begin : 2014-09-10
6  copyright : (C) 2014 by Alessandro Pasotti
7  email : a dot pasotti at itopen dot it
8  ***************************************************************************/
9 
10 /***************************************************************************
11  * *
12  * This program is free software; you can redistribute it and/or modify *
13  * it under the terms of the GNU General Public License as published by *
14  * the Free Software Foundation; either version 2 of the License, or *
15  * (at your option) any later version. *
16  * *
17  ***************************************************************************/
18 
19 
20 #ifndef QGSSERVERINTERFACE_H
21 #define QGSSERVERINTERFACE_H
22 
23 #include "qgscapabilitiescache.h"
24 #include "qgsrequesthandler.h"
25 #include "qgsserverfilter.h"
26 
34 class SERVER_EXPORT QgsServerInterface
35 {
36 
37  public:
38 
41 
43  virtual ~QgsServerInterface() = 0;
44 
49  virtual void setRequestHandler( QgsRequestHandler* requestHandler ) = 0;
50 
56  virtual void clearRequestHandler( ) = 0;
57 
62  virtual QgsCapabilitiesCache* capabiblitiesCache() = 0;
63 
68  virtual QgsRequestHandler* requestHandler( ) = 0;
69 
75  virtual void registerFilter( QgsServerFilter* filter, int priority = 0 ) = 0;
76 
81  virtual void setFilters( QgsServerFiltersMap* filters ) = 0;
82 
87  virtual QgsServerFiltersMap filters( ) = 0;
88 
90  virtual QString getEnv( const QString& name ) const = 0;
91 
96  virtual QString configFilePath( ) = 0;
97 
102  virtual void setConfigFilePath( QString configFilePath ) = 0;
103 
104  private:
105  QString mConfigFilePath;
106 };
107 
108 #endif // QGSSERVERINTERFACE_H
Class defining I/O filters for QGIS Server and implemented in plugins.
This class is an interface hiding the details of reading input and writing output from/to a wms reque...
A cache for capabilities xml documents (by configuration file path)
QgsServerInterface Class defining interfaces exposed by QGIS Server and made available to plugins...