QGIS API Documentation  3.9.0-Master (6d389215ab)
Namespaces | Classes
server library

The SERVER library is built on top of the CORE library and adds map server components to QGIS. More...

Namespaces

 QgsServerFeatureId
 The QgsServerFeatureId namespace provides a way to use primary keys for feature id.
 
 QgsServerProjectUtils
 The QgsServerProjectUtils namespace provides a way to retrieve specific entries from a QgsProject.
 
 QgsWcs
 WCS implementation.
 
 QgsWfs
 WMS implementation.
 
 QgsWms
 Median cut implementation.
 

Classes

class  QgsAccessControl
 A helper class that centralizes restrictions given by all the access control filter plugins. More...
 
class  QgsAccessControlFilter
 Class defining access control interface for QGIS Server plugins. More...
 
class  QgsWfs::QgsBadRequestException
 Exception thrown in case of malformed request. More...
 
class  QgsWms::QgsBadRequestException
 Exception thrown in case of malformed request. More...
 
class  QgsBadRequestException
 Exception thrown in case of malformed request. More...
 
class  QgsBufferServerRequest
 Class defining request with data. More...
 
class  QgsBufferServerResponse
 Class defining buffered response. More...
 
class  QgsCapabilitiesCache
 A cache for capabilities xml documents (by configuration file path) More...
 
class  QgsConfigCache
 Cache for server configuration. More...
 
class  QgsFcgiServerRequest
 Class defining fcgi request. More...
 
class  QgsFcgiServerResponse
 Class defining fcgi response. More...
 
class  QgsFeatureFilter
 A feature filter provider allowing to set filter expressions on a per-layer basis. More...
 
class  QgsFeatureFilterProviderGroup
 A filter filter provider grouping several filter providers. More...
 
class  QgsFilterResponseDecorator
 Class defining decorator for calling filter's hooks. More...
 
class  QgsLayerRestorer
 RAII class to restore layer configuration on destruction (opacity, filters, ...) More...
 
class  QgsWms::QgsMapRendererJobProxy
 Proxy for sequential or parallel map render job. More...
 
class  QgsMapServiceException
 Exception class for WMS service exceptions (for compatibility only). More...
 
class  QgsOgcServiceException
 Exception base class for service exceptions. More...
 
class  QgsOWSServerFilterRestorer
 RAII class to restore layer filters on destruction. More...
 
class  QgsWms::QgsRenderer
 Map renderer for WMS requests. More...
 
class  QgsRequestHandler
 This class is an interface hiding the details of reading input and writing output from/to a wms request mechanism. More...
 
class  QgsWcs::QgsRequestNotWellFormedException
 Exception thrown in case of malformed request. More...
 
class  QgsWfs::QgsRequestNotWellFormedException
 Exception thrown in case of malformed request. More...
 
class  QgsWcs::QgsSecurityAccessException
 Exception thrown when data access violates access controls. More...
 
class  QgsWfs::QgsSecurityAccessException
 Exception thrown when data access violates access controls. More...
 
class  QgsWms::QgsSecurityException
 Exception thrown when data access violates access controls. More...
 
class  QgsServer
 The QgsServer class provides OGC web services. More...
 
class  QgsServerApi
 Server generic API endpoint abstract base class. More...
 
class  QgsServerApiBadRequestException
 Bad request error API exception. More...
 
class  QgsServerApiContext
 The QgsServerApiContext class encapsulates the resources for a particular client request: the request and response objects, the project (might be NULL) and the server interface, the API root path that matched the request is also added. More...
 
class  QgsServerApiException
 Exception base class for API exceptions. More...
 
class  QgsServerApiImproperlyConfiguredException
 configuration error on the server prevents to serve the request, which would be valid otherwise. More...
 
class  QgsServerApiInternalServerError
 Internal server error API exception. More...
 
class  QgsServerApiInvalidMimeTypeException
 the client sent an invalid mime type in the "Accept" header More...
 
class  QgsServerApiNotFoundError
 Not found error API exception. More...
 
class  QgsServerApiNotImplementedException
 this method is not yet implemented More...
 
class  QgsServerApiUtils
 The QgsServerApiUtils class contains helper functions to handle common API operations. More...
 
class  QgsServerCacheFilter
 Class defining cache interface for QGIS Server plugins. More...
 
class  QgsServerCacheManager
 A helper class that centralizes caches accesses given by all the server cache filter plugins. More...
 
class  QgsServerException
 Exception base class for server exceptions. More...
 
class  QgsServerFilter
 Class defining I/O filters for QGIS Server and implemented in plugins. More...
 
class  QgsServerInterface
 QgsServerInterface Class defining interfaces exposed by QGIS Server and made available to plugins. More...
 
class  QgsServerInterfaceImpl
 Interfaces exposed by QGIS Server and made available to plugins. More...
 
class  QgsServerLogger
 Writes message log into server logfile. More...
 
class  QgsServerOgcApi
 QGIS Server OGC API endpoint. More...
 
class  QgsServerOgcApiHandler
 The QgsServerOgcApiHandler abstract class represents a OGC API handler to be registered in QgsServerOgcApi class. More...
 
class  QgsServerParameter
 Parameter common to all services (WMS, WFS, ...) More...
 
class  QgsServerParameterDefinition
 Definition of a parameter with basic conversion methods. More...
 
class  QgsServerParameters
 QgsServerParameters provides an interface to retrieve and manipulate global parameters received from the client. More...
 
class  QgsServerPlugins
 Initializes Python server plugins and stores a list of server plugin names. More...
 
class  QgsServerQueryStringParameter
 The QgsServerQueryStringParameter class holds the information regarding a query string input parameter and its validation. More...
 
class  QgsServerRequest
 QgsServerRequest Class defining request interface passed to services QgsService::executeRequest() method. More...
 
class  QgsServerResponse
 QgsServerResponse Class defining response interface passed to services QgsService::executeRequest() method. More...
 
class  QgsServerSettings
 Provides a way to retrieve settings by prioritizing according to environment variables, ini file and default values. More...
 
class  QgsServerSettingsEnv
 Provides some enum describing the environment currently supported for configuration. More...
 
class  QgsService
 QgsService Class defining interfaces for QGIS server services. More...
 
class  QgsWcs::QgsServiceException
 Exception class for WFS services. More...
 
class  QgsWfs::QgsServiceException
 Exception class for WFS service exceptions. More...
 
class  QgsWms::QgsServiceException
 Exception class for WMS service exceptions. More...
 
class  QgsServiceModule
 Class defining the service module interface for QGIS server services. More...
 
class  QgsServiceNativeLoader
 Class defining the native service module loader for QGIS server services. More...
 
class  QgsServiceNativeModuleEntry
 Native module (location, the module itself and the unload function). More...
 
class  QgsServiceRegistry
 QgsServiceRegistry Class defining the registry manager for QGIS server services. More...
 
class  QgsStoreBadLayerInfo
 Stores layer ids of bad layers. More...
 
class  QgsWcsModule
 Service module specialized for WCS. More...
 
class  QgsWfsModule
 Module specialized for WFS service. More...
 
class  QgsWfs::QgsWfsParameter
 WFS parameter received from the client. More...
 
class  QgsWfs::QgsWfsParameters
 Provides an interface to retrieve and manipulate WFS parameters received from the client. More...
 
class  QgsWmsModule
 Module specialized for WMS service. More...
 
class  QgsWms::QgsWmsParameter
 WMS parameter received from the client. More...
 
class  QgsWms::QgsWmsParameters
 Provides an interface to retrieve and manipulate WMS parameters received from the client. More...
 
class  QgsWms::QgsWmsRenderContext
 Rendering context for the WMS renderer. More...
 
class  QgsWcs::Service
 OGC web service specialized for WCS. More...
 
class  QgsWfs::Service
 OGC web service specialized for WFS. More...
 
class  QgsWms::Service
 OGC web service specialized for WMS. More...
 

Detailed Description

The SERVER library is built on top of the CORE library and adds map server components to QGIS.