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
Added in version 3.0.
QgsServiceRegistry() Constructor
QgsServiceRegistry(a0:
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 | None, version: str | None = '') QgsServerApi | None ¶
Retrieves an API from its name
If the version is not provided the higher version of the service is returned
- Parameters:
name (Optional[str]) – the name of the API
version (Optional[str] = '') – the version string (optional)
- Return type:
Optional[QgsServerApi]
- Returns:
Added in version 3.10.
- getService(self, name: str | None, version: str | None = '') QgsService | None ¶
Retrieve a service from its name
- Parameters:
name (Optional[str]) – the name of the service
version (Optional[str] = '') – the version string (optional)
- Return type:
Optional[QgsService]
- Returns:
If the version is not provided the higher version of the service is returned
- init(self, nativeModulepath: str | None, serverIface: QgsServerInterface | None = None)¶
Initialize registry, load modules and auto register services
- Parameters:
serverIface (Optional[QgsServerInterface] = None) – the server interface
nativeModulepath (Optional[str]) – the native module path
- registerApi(self, api: QgsServerApi | None) bool ¶
Registers the
QgsServerApi
api
The registry takes ownership of services and will call ‘delete’ on cleanup
Added in version 3.10.
- Parameters:
api (Optional[QgsServerApi])
- Return type:
bool
- registerService(self, service: QgsService | None)¶
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 (Optional[QgsService]) – a
QgsService
to be registered
- unregisterApi(self, name: str | None, version: str | None = '') int ¶
Unregisters API from its name and version
- Parameters:
name (Optional[str]) – the name of the service
version (Optional[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
Added in version 3.10.
- unregisterService(self, name: str | None, version: str | None = '') int ¶
Unregister service from its name and version
- Parameters:
name (Optional[str]) – the name of the service
version (Optional[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