| 
    QGIS API Documentation
    3.26.3-Buenos Aires (65e4edfdad)
    
   | 
 
 
 
 
Go to the documentation of this file.
   19 #ifndef QGSSERVERINTERFACEIMPL_H 
   20 #define QGSSERVERINTERFACEIMPL_H 
   80     QString 
getEnv( 
const QString &name ) 
const override;
 
   92     QString mConfigFilePath;
 
  102 #endif // QGSSERVERINTERFACEIMPL_H 
  
Class defining cache interface for QGIS Server plugins.
 
A cache for capabilities xml documents (by configuration file path)
 
QgsRequestHandler * requestHandler() override
Returns the QgsRequestHandler, to be used only in server plugins.
 
virtual void registerServerCache(QgsServerCacheFilter *serverCache, int priority=0)=0
Register a server cache filter.
 
virtual QString getEnv(const QString &name) const =0
Returns an enrironment variable, used to pass environment variables to Python.
 
virtual void setConfigFilePath(const QString &configFilePath)=0
Set the configuration file path.
 
QgsCapabilitiesCache * capabilitiesCache() override
Gets pointer to the capabiblities cache.
 
QgsServerFiltersMap filters() override
Returns the list of current QgsServerFilter.
 
Interfaces exposed by QGIS Server and made available to plugins.
 
virtual void registerFilter(QgsServerFilter *filter, int priority=0)=0
Register a QgsServerFilter.
 
virtual void clearRequestHandler()=0
Clear the request handler.
 
Provides a way to retrieve settings by prioritizing according to environment variables,...
 
virtual void registerAccessControl(QgsAccessControlFilter *accessControl, int priority=0)=0
Register an access control filter.
 
Class defining I/O filters for QGIS Server and implemented in plugins.
 
A helper class that centralizes caches accesses given by all the server cache filter plugins.
 
Class defining access control interface for QGIS Server plugins.
 
virtual QgsServerSettings * serverSettings()=0
Returns the server settings.
 
virtual void setFilters(QgsServerFiltersMap *filters)=0
Set the filters map.
 
A helper class that centralizes restrictions given by all the access control filter plugins.
 
virtual void removeConfigCacheEntry(const QString &path)=0
Remove entry from config cache.
 
QgsAccessControl * accessControls() const override
Gets the helper over all the registered access control filters.
 
virtual QgsServerCacheManager * cacheManager() const =0
Gets the registered server cache filters.
 
QString configFilePath() override
Returns the configuration file path.
 
QgsServiceRegistry Class defining the registry manager for QGIS server services.
 
QMultiMap< int, QgsServerFilter * > QgsServerFiltersMap
 
This class is an interface hiding the details of reading input and writing output from/to a wms reque...
 
virtual QgsServiceRegistry * serviceRegistry()=0
Returns the service registry.
 
QgsServerInterface Class defining interfaces exposed by QGIS Server and made available to plugins.
 
virtual void setRequestHandler(QgsRequestHandler *requestHandler)=0
Set the request handler.