| 
    QGIS API Documentation 3.99.0-Master (f78f5286a64)
    
   | 
 
The SERVER library is built on top of the CORE library and adds map server components to QGIS. More...
Namespaces | |
| namespace | QgsWcs | 
| WCS implementation.  | |
| namespace | QgsWfs | 
| WMS implementation.  | |
| namespace | QgsWms | 
| Median cut implementation.  | |
Classes | |
| class | QgsAbstractCacheStrategy | 
| Abstract base class for implementing cache invalidation strategy.  More... | |
| class | QgsAccessControl | 
| A helper class that centralizes restrictions given by all the access control filter plugins.  More... | |
| class | QgsAccessControlFilter | 
| Defines access control interface for QGIS Server plugins.  More... | |
| class | QgsWms::QgsBadRequestException | 
| Exception thrown in case of malformed request.  More... | |
| class | QgsWfs::QgsBadRequestException | 
| Exception thrown in case of malformed request.  More... | |
| class | QgsBadRequestException | 
| Exception thrown in case of malformed requests.  More... | |
| class | QgsBufferServerRequest | 
| Defines a request with data.  More... | |
| class | QgsBufferServerResponse | 
| Defines a buffered server response.  More... | |
| class | QgsCapabilitiesCache | 
| A cache for capabilities xml documents (by configuration file path).  More... | |
| class | QgsConfigCache | 
| Cache for server configuration.  More... | |
| class | QgsDimensionFilter | 
| A server filter to apply a dimension filter to a request.  More... | |
| class | QgsFcgiServerRequest | 
| Defines fcgi requests.  More... | |
| class | QgsFcgiServerResponse | 
| Defines fcgi responses.  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 | QgsFileSystemCacheStrategy | 
| File system cache strategy for server configuration.  More... | |
| class | QgsFilterResponseDecorator | 
| A 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 | QgsNullCacheStrategy | 
| Null system cache strategy for server configuration, completely disable cache invalidation invalidation.  More... | |
| class | QgsOgcServiceException | 
| Exception base class for service exceptions.  More... | |
| class | QgsOWSServerFilterRestorer | 
| RAII class to restore layer filters on destruction.  More... | |
| class | QgsPeriodicCacheStrategy | 
| Periodic system cache strategy for server configuration.  More... | |
| class | QgsWms::QgsRenderer | 
| Map renderer for WMS requests.  More... | |
| class | QgsRequestHandler | 
| 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 | 
| A server which 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 | 
| Encapsulates the resources for a particular client request.  More... | |
| class | QgsServerApiException | 
| Exception base class for API exceptions.  More... | |
| class | QgsServerApiImproperlyConfiguredException | 
| Raised when a 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 | 
| Raised when the client sent an invalid mime type in the "Accept" header.  More... | |
| class | QgsServerApiNotFoundError | 
| Not found error API exception.  More... | |
| class | QgsServerApiNotImplementedException | 
| Raised when the client requested a method that is not yet implemented.  More... | |
| class | QgsServerApiPermissionDeniedException | 
| Raised when a request is a Forbidden (permission denied) 403.  More... | |
| class | QgsServerApiUtils | 
| Contains helper functions to handle common API operations.  More... | |
| class | QgsServerCacheFilter | 
| Defines 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 | QgsServerFeatureId | 
| Contains utility functions for using primary keys for feature IDs.  More... | |
| class | QgsServerFilter | 
| Defines I/O filters for QGIS Server and implemented in plugins.  More... | |
| class | QgsServerInterface | 
| Defines 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 log files.  More... | |
| class | QgsServerOgcApi | 
| QGIS Server OGC API endpoint.  More... | |
| class | QgsServerOgcApiHandler | 
| An abstract class which represents an 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 | 
| 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 | QgsServerProjectUtils | 
| Contains utility functions to retrieve specific entries from a QgsProject.  More... | |
| class | QgsServerQueryStringParameter | 
| Holds the information regarding a query string input parameter and its validation.  More... | |
| class | QgsServerRequest | 
| Defines requests passed to QgsService classes.  More... | |
| class | QgsServerResponse | 
| Defines the response interface passed to QgsService.  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 | QgsServerStaticHandler | 
| Serves static files from the static path (resources/server/api/wfs3/static).  More... | |
| class | QgsService | 
| Defines interfaces for QGIS server services.  More... | |
| class | QgsWcs::QgsServiceException | 
| Exception class for WFS services.  More... | |
| class | QgsWms::QgsServiceException | 
| Exception class for WMS service exceptions.  More... | |
| class | QgsWfs::QgsServiceException | 
| Exception class for WFS service exceptions.  More... | |
| class | QgsServiceModule | 
| Defines the service module interface for QGIS server services.  More... | |
| class | QgsServiceNativeLoader | 
| Defines 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 | 
| A registry manager for QGIS server services.  More... | |
| class | QgsSocketMonitoringThread | 
| Thread used to monitor the fcgi socket.  More... | |
| class | QgsStoreBadLayerInfo | 
| Stores layer IDs for bad (broken) layers.  More... | |
| class | QgsWcsModule | 
| Service module specialized for WCS.  More... | |
| class | QgsWfsDescribeFeatureTypeGml | 
| GML output formatter for DescribeFeatureType.  More... | |
| class | QgsWfsDescribeFeatureTypeJson | 
| Json output formatter for DescribeFeatureType.  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 | QgsWmsLayerInfos | 
| WMS Layer infos.  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 | QgsWms::QgsWmsRequest | 
| Defines request interfaces passed to WMS service.  More... | |
| class | QgsWms::QgsWmsRestorer | 
| RAII class to restore the rendering context configuration on destruction.  More... | |
| class | QgsWms::Service | 
| OGC web service specialized for WMS.  More... | |
| class | QgsWfs::Service | 
| OGC web service specialized for WFS.  More... | |
| class | QgsWcs::Service | 
| OGC web service specialized for WCS.  More... | |
The SERVER library is built on top of the CORE library and adds map server components to QGIS.