qgsserviceregistry.h

Go to the documentation of this file.

/***************************************************************************
                          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.                                   *
 *                                                                         *
 ***************************************************************************/
#ifndef QGSSERVICEREGISTRY_H
#define QGSSERVICEREGISTRY_H
 
#include "qgsconfig.h"
 
#include <memory>
 
#include "qgis.h"
#include "qgsservicenativeloader.h"
 
#include <QHash>
#include <QString>
 
class QgsService;
class QgsServerRequest;
class QgsServerApi;
class QgsServerInterface;

class SERVER_EXPORT QgsServiceRegistry
{
  public:
    QgsServiceRegistry() = default;
    ~QgsServiceRegistry();

    QgsService *getService( const QString &name, const QString &version = QString() );

    void registerService( QgsService *service SIP_TRANSFER );

    bool registerApi( QgsServerApi *api SIP_TRANSFER );

    int unregisterApi( const QString &name, const QString &version = QString() );

    QgsServerApi *apiForRequest( const QgsServerRequest &request ) const SIP_SKIP;

    QgsServerApi *getApi( const QString &name, const QString &version = QString() );

    int unregisterService( const QString &name, const QString &version = QString() );

    void init( const QString &nativeModulepath, QgsServerInterface *serverIface = nullptr );

    void cleanUp();
 
  private:
    // XXX consider using QMap because of the few numbers of
    // elements to handle
    typedef QHash<QString, std::shared_ptr<QgsService>> ServiceTable;
    typedef QHash<QString, std::shared_ptr<QgsServerApi>> ApiTable;
    typedef QHash<QString, QPair<QString, QString>> VersionTable;
 
    QgsServiceNativeLoader mNativeLoader;
 
    ServiceTable mServices;
    VersionTable mServiceVersions;
    ApiTable mApis;
    VersionTable mApiVersions;
};
 
#endif