mirror of
https://github.com/qgis/QGIS.git
synced 2025-02-27 00:33:48 -05:00
82 lines
2.6 KiB
Plaintext
82 lines
2.6 KiB
Plaintext
/***************************************************************************
|
|
qgsserviceregistry.h
|
|
|
|
Class defining the service manager for QGIS server services.
|
|
-------------------
|
|
begin : 2016-12-05
|
|
copyright : (C) 2016 by David Marteau
|
|
email : david dot marteau at 3liz dot com
|
|
***************************************************************************/
|
|
|
|
/***************************************************************************
|
|
* *
|
|
* This program is free software; you can redistribute it and/or modify *
|
|
* it under the terms of the GNU General Public License as published by *
|
|
* the Free Software Foundation; either version 2 of the License, or *
|
|
* (at your option) any later version. *
|
|
* *
|
|
***************************************************************************/
|
|
|
|
/**
|
|
* \ingroup server
|
|
* QgsServiceRegistry
|
|
* Class defining the cegistry manager for QGIS server services
|
|
*
|
|
* This class provides methods for registering and retrieving
|
|
* services.
|
|
*
|
|
* IMPORTANT: The registry hold ownership of registered services and
|
|
* will call 'delete' on cleanup
|
|
*
|
|
*/
|
|
class QgsServiceRegistry
|
|
{
|
|
%TypeHeaderCode
|
|
#include "qgsserviceregistry.h"
|
|
#include "qgsservice.h"
|
|
%End
|
|
public:
|
|
|
|
//! Constructor
|
|
QgsServiceRegistry();
|
|
|
|
//! Destructor
|
|
~QgsServiceRegistry();
|
|
|
|
/**
|
|
* Retrieve a service from its name
|
|
* @param name the name of the service
|
|
* @param version the required version (optional)
|
|
* @return QgsService
|
|
*/
|
|
QgsService* getService( const QString& name, const QString& version = QString() );
|
|
|
|
/**
|
|
* Register a service by its name
|
|
*
|
|
* This method is intended to be called by modules for registering
|
|
* services. A module may register multiple services.
|
|
* The registry gain ownership of services.
|
|
*
|
|
* @param service a QgsServerResponse to be registered
|
|
*/
|
|
void registerService( QgsService* service /Transfer/ );
|
|
|
|
/**
|
|
* Initialize registry, load modules and auto register services
|
|
* @param nativeModulepath the native module path
|
|
* @param pythonModulePath the python module path
|
|
*
|
|
* If pythonModulePath is not specified the environnement variables QGIS_PYTHON_SERVICE_PATH
|
|
* is examined.
|
|
*/
|
|
void init( const QString& nativeModulepath, const QString& pythonModulePath = QString() );
|
|
|
|
/**
|
|
* Clean up registered service and unregister modules
|
|
*/
|
|
void cleanUp();
|
|
};
|
|
|
|
|