QGIS API Documentation 3.28.0-Firenze (ed3ad0430f)
•All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
Public Member Functions | List of all members
QgsServerInterfaceImpl Class Reference
server library

Interfaces exposed by QGIS Server and made available to plugins. More...

#include <qgsserverinterfaceimpl.h>

Inheritance diagram for QgsServerInterfaceImpl:
Inheritance graph
[legend]

Public Member Functions

 QgsServerInterfaceImpl (QgsCapabilitiesCache *capCache, QgsServiceRegistry *srvRegistry, QgsServerSettings *serverSettings)
 Constructor. More...
 
 ~QgsServerInterfaceImpl () override
 
QgsAccessControl * accessControls () const override
 Gets the helper over all the registered access control filters. More...
 
QgsServerCacheManager * cacheManager () const override
 Gets the helper over all the registered server cache filters. More...
 
QgsCapabilitiesCache * capabilitiesCache () override
 Gets pointer to the capabiblities cache. More...
 
void clearRequestHandler () override
 Clear the request handler. More...
 
QString configFilePath () override
 Returns the configuration file path. More...
 
QgsServerFiltersMap filters () override
 Returns the list of current QgsServerFilter. More...
 
QString getEnv (const QString &name) const override
 Returns an enrironment variable, used to pass environment variables to Python. More...
 
void registerAccessControl (QgsAccessControlFilter *accessControl, int priority=0) override
 Register an access control filter. More...
 
void registerFilter (QgsServerFilter *filter, int priority=0) override
 Register a QgsServerFilter. More...
 
void registerServerCache (QgsServerCacheFilter *serverCache, int priority=0) override
 Registers a server cache filter. More...
 
void reloadSettings () override
 Reloads the server settings re-reading the configuration. More...
 
void removeConfigCacheEntry (const QString &path) override
 Remove entry from config cache. More...
 
QgsRequestHandler * requestHandler () override
 Returns the QgsRequestHandler, to be used only in server plugins. More...
 
QgsServerSettings * serverSettings () override
 Returns the server settings. More...
 
QgsServiceRegistry * serviceRegistry () override
 Returns the service registry. More...
 
void setConfigFilePath (const QString &configFilePath) override
 Set the configuration file path. More...
 
void setFilters (QgsServerFiltersMap *filters) override
 Set the filters map. More...
 
void setRequestHandler (QgsRequestHandler *requestHandler) override
 Set the request handler. More...
 
- Public Member Functions inherited from QgsServerInterface
 QgsServerInterface ()
 Constructor. More...
 
virtual ~QgsServerInterface ()=default
 
virtual QgsAccessControl * accessControls () const =0
 Gets the registered access control filters. More...
 
virtual QgsServerCacheManager * cacheManager () const =0
 Gets the registered server cache filters. More...
 
virtual QgsCapabilitiesCache * capabilitiesCache ()=0
 Gets pointer to the capabiblities cache. More...
 
virtual void clearRequestHandler ()=0
 Clear the request handler. More...
 
virtual QString configFilePath ()=0
 Returns the configuration file path. More...
 
virtual QgsServerFiltersMap filters ()=0
 Returns the list of current QgsServerFilter. More...
 
virtual QString getEnv (const QString &name) const =0
 Returns an enrironment variable, used to pass environment variables to Python. More...
 
virtual void registerAccessControl (QgsAccessControlFilter *accessControl, int priority=0)=0
 Register an access control filter. More...
 
virtual void registerFilter (QgsServerFilter *filter, int priority=0)=0
 Register a QgsServerFilter. More...
 
virtual void registerServerCache (QgsServerCacheFilter *serverCache, int priority=0)=0
 Register a server cache filter. More...
 
virtual void reloadSettings ()=0
 Reloads the server settings re-reading the configuration. More...
 
virtual void removeConfigCacheEntry (const QString &path)=0
 Remove entry from config cache. More...
 
virtual QgsRequestHandler * requestHandler ()=0
 Gets pointer to the request handler. More...
 
virtual QgsServerSettings * serverSettings ()=0
 Returns the server settings. More...
 
virtual QgsServiceRegistry * serviceRegistry ()=0
 Returns the service registry. More...
 
virtual void setConfigFilePath (const QString &configFilePath)=0
 Set the configuration file path. More...
 
virtual void setFilters (QgsServerFiltersMap *filters)=0
 Set the filters map. More...
 
virtual void setRequestHandler (QgsRequestHandler *requestHandler)=0
 Set the request handler. More...
 

Detailed Description

Interfaces exposed by QGIS Server and made available to plugins.

Since
QGIS 2.8

Definition at line 35 of file qgsserverinterfaceimpl.h.

Constructor & Destructor Documentation

◆ QgsServerInterfaceImpl()

QgsServerInterfaceImpl::QgsServerInterfaceImpl ( QgsCapabilitiesCache *  capCache,
QgsServiceRegistry *  srvRegistry,
QgsServerSettings *  serverSettings 
)
explicit

Constructor.

Definition at line 24 of file qgsserverinterfaceimpl.cpp.

◆ ~QgsServerInterfaceImpl()

QgsServerInterfaceImpl::~QgsServerInterfaceImpl ( )
override

Definition at line 42 of file qgsserverinterfaceimpl.cpp.

Member Function Documentation

◆ accessControls()

QgsAccessControl * QgsServerInterfaceImpl::accessControls ( ) const
inlineoverridevirtual

Gets the helper over all the registered access control filters.

Returns
the access control helper

Implements QgsServerInterface.

Definition at line 62 of file qgsserverinterfaceimpl.h.

◆ cacheManager()

QgsServerCacheManager * QgsServerInterfaceImpl::cacheManager ( ) const
overridevirtual

Gets the helper over all the registered server cache filters.

Returns
the server cache helper
Since
QGIS 3.4

Implements QgsServerInterface.

Definition at line 98 of file qgsserverinterfaceimpl.cpp.

◆ capabilitiesCache()

QgsCapabilitiesCache * QgsServerInterfaceImpl::capabilitiesCache ( )
inlineoverridevirtual

Gets pointer to the capabiblities cache.

Returns
QgsCapabilitiesCache

Implements QgsServerInterface.

Definition at line 49 of file qgsserverinterfaceimpl.h.

◆ clearRequestHandler()

void QgsServerInterfaceImpl::clearRequestHandler ( )
overridevirtual

Clear the request handler.

Note
not available in Python bindings

Implements QgsServerInterface.

Definition at line 51 of file qgsserverinterfaceimpl.cpp.

◆ configFilePath()

QString QgsServerInterfaceImpl::configFilePath ( )
inlineoverridevirtual

Returns the configuration file path.

Returns
QString containing the configuration file path

Implements QgsServerInterface.

Definition at line 81 of file qgsserverinterfaceimpl.h.

◆ filters()

QgsServerFiltersMap QgsServerInterfaceImpl::filters ( )
inlineoverridevirtual

Returns the list of current QgsServerFilter.

Returns
QgsServerFiltersMap list of QgsServerFilter

Implements QgsServerInterface.

Definition at line 53 of file qgsserverinterfaceimpl.h.

◆ getEnv()

QString QgsServerInterfaceImpl::getEnv ( const QString &  name) const
overridevirtual

Returns an enrironment variable, used to pass environment variables to Python.

Implements QgsServerInterface.

Definition at line 36 of file qgsserverinterfaceimpl.cpp.

◆ registerAccessControl()

void QgsServerInterfaceImpl::registerAccessControl ( QgsAccessControlFilter *  accessControl,
int  priority = 0 
)
overridevirtual

Register an access control filter.

Register a new access control filter.

Implements QgsServerInterface.

Definition at line 77 of file qgsserverinterfaceimpl.cpp.

◆ registerFilter()

void QgsServerInterfaceImpl::registerFilter ( QgsServerFilter *  filter,
int  priority = 0 
)
overridevirtual

Register a QgsServerFilter.

Parameters
filterthe QgsServerFilter to add
priorityan optional priority for the filter order

Implements QgsServerInterface.

Definition at line 66 of file qgsserverinterfaceimpl.cpp.

◆ registerServerCache()

void QgsServerInterfaceImpl::registerServerCache ( QgsServerCacheFilter *  serverCache,
int  priority = 0 
)
overridevirtual

Registers a server cache filter.

Register a new access control filter.

Parameters
serverCachethe server cache to register
prioritythe priority used to order them
Since
QGIS 3.4

Implements QgsServerInterface.

Definition at line 88 of file qgsserverinterfaceimpl.cpp.

◆ reloadSettings()

void QgsServerInterfaceImpl::reloadSettings ( )
overridevirtual

Reloads the server settings re-reading the configuration.

Since
QGIS 3.28

Implements QgsServerInterface.

Definition at line 122 of file qgsserverinterfaceimpl.cpp.

◆ removeConfigCacheEntry()

void QgsServerInterfaceImpl::removeConfigCacheEntry ( const QString &  path)
overridevirtual

Remove entry from config cache.

Parameters
paththe path of the file to remove

Implements QgsServerInterface.

Definition at line 103 of file qgsserverinterfaceimpl.cpp.

◆ requestHandler()

QgsRequestHandler * QgsServerInterfaceImpl::requestHandler ( )
inlineoverridevirtual

Returns the QgsRequestHandler, to be used only in server plugins.

Implements QgsServerInterface.

Definition at line 51 of file qgsserverinterfaceimpl.h.

◆ serverSettings()

QgsServerSettings * QgsServerInterfaceImpl::serverSettings ( )
overridevirtual

Returns the server settings.

Returns
QgsServerSettings
Note
not available in Python bindings

Implements QgsServerInterface.

Definition at line 117 of file qgsserverinterfaceimpl.cpp.

◆ serviceRegistry()

QgsServiceRegistry * QgsServerInterfaceImpl::serviceRegistry ( )
overridevirtual

Returns the service registry.

Returns
QgsServiceResgistry

Implements QgsServerInterface.

Definition at line 112 of file qgsserverinterfaceimpl.cpp.

◆ setConfigFilePath()

void QgsServerInterfaceImpl::setConfigFilePath ( const QString &  configFilePath)
overridevirtual

Set the configuration file path.

Parameters
configFilePathQString with the configuration file path

Implements QgsServerInterface.

Definition at line 61 of file qgsserverinterfaceimpl.cpp.

◆ setFilters()

void QgsServerInterfaceImpl::setFilters ( QgsServerFiltersMap *  filters)
overridevirtual

Set the filters map.

Parameters
filtersthe QgsServerFiltersMap

Implements QgsServerInterface.

Definition at line 71 of file qgsserverinterfaceimpl.cpp.

◆ setRequestHandler()

void QgsServerInterfaceImpl::setRequestHandler ( QgsRequestHandler *  requestHandler)
overridevirtual

Set the request handler.

Parameters
requestHandlerrequest handler
Note
not available in Python bindings

Implements QgsServerInterface.

Definition at line 56 of file qgsserverinterfaceimpl.cpp.

The documentation for this class was generated from the following files:
Generated on Sat Oct 22 2022 16:10:47 for QGIS API Documentation by doxygen 1.9.4