Class: QgsServiceRegistry¶
- class qgis.server.QgsServiceRegistry¶
Bases:
sip.wrapper
QgsServiceRegistry
Class defining the registry manager for QGIS server servicesThis class provides methods for registering and retrieving services.
IMPORTANT: The registry hold ownership of registered services and will call ‘delete’ on cleanup
New in version 3.0.
QgsServiceRegistry() Constructor
QgsServiceRegistry(
QgsServiceRegistry
)Methods
Clean up registered service and unregister modules
Retrieves an API from its name
Retrieve a service from its name
Initialize registry, load modules and auto register services
Registers the
QgsServerApi
api
Register a service by its name and version
Unregisters API from its name and version
Unregister service from its name and version
- cleanUp(self)¶
Clean up registered service and unregister modules
- getApi(self, name: str, version: str = '') QgsServerApi ¶
Retrieves an API from its name
If the version is not provided the higher version of the service is returned
- Parameters
name (str) – the name of the API
version (str = '') – the version string (optional)
- Return type
- Returns
New in version 3.10.
- getService(self, name: str, version: str = '') QgsService ¶
Retrieve a service from its name
- Parameters
name (str) – the name of the service
version (str = '') – the version string (optional)
- Return type
- Returns
If the version is not provided the higher version of the service is returned
- init(self, nativeModulepath: str, serverIface: QgsServerInterface = None)¶
Initialize registry, load modules and auto register services
- Parameters
serverIface (
QgsServerInterface
= None) – the server interfacenativeModulepath (str) – the native module path
- registerApi(self, api: QgsServerApi) bool ¶
Registers the
QgsServerApi
api
The registry takes ownership of services and will call ‘delete’ on cleanup
New in version 3.10.
- Parameters
api (QgsServerApi) –
- Return type
bool
- registerService(self, service: QgsService)¶
Register a service by its name and version
This method is intended to be called by modules for registering services. A module may register multiple services.
The registry takes ownership of services and will call ‘delete’ on cleanup
- Parameters
service (QgsService) – a
QgsService
to be registered
- unregisterApi(self, name: str, version: str = '') int ¶
Unregisters API from its name and version
- Parameters
name (str) – the name of the service
version (str = '') – (optional) the specific version to unload
- Return type
int
- Returns
the number of APIs unregistered
If the version is not specified then all versions from the specified API are unloaded
New in version 3.10.
- unregisterService(self, name: str, version: str = '') int ¶
Unregister service from its name and version
- Parameters
name (str) – the name of the service
version (str = '') – (optional) the specific version to unload
- Return type
int
- Returns
the number of services unregistered
If the version is not specified then all versions from the specified service are unloaded