qgsservercachefilter.h

Go to the documentation of this file.

/***************************************************************************
                          qgsservercachefilter.h
                          ------------------------
 Cache interface for QGIS Server plugins
 
  begin                : 2018-07-05
  copyright            : (C) 2018 by René-Luc D'Hont
  email                : rldhont 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 QGSSERVERCACHEFILTER_H
#define QGSSERVERCACHEFILTER_H
 
#include "qgis_server.h"
#include "qgis_sip.h"
#include "qgsserverrequest.h"
 
#include <QDomDocument>
#include <QMultiMap>
 
class QgsProject;
 
SIP_IF_MODULE( HAVE_SERVER_PYTHON_PLUGINS )
 
class QgsServerInterface;
 

class SERVER_EXPORT QgsServerCacheFilter
{
  public:

    QgsServerCacheFilter( const QgsServerInterface *serverInterface );
 
    virtual ~QgsServerCacheFilter() = default;

    virtual QByteArray getCachedDocument( const QgsProject *project, const QgsServerRequest &request, const QString &key ) const;

    virtual bool setCachedDocument( const QDomDocument *doc, const QgsProject *project, const QgsServerRequest &request, const QString &key ) const;

    virtual bool deleteCachedDocument( const QgsProject *project, const QgsServerRequest &request, const QString &key ) const;

    virtual bool deleteCachedDocuments( const QgsProject *project ) const;

    virtual QByteArray getCachedImage( const QgsProject *project, const QgsServerRequest &request, const QString &key ) const;

    virtual bool setCachedImage( const QByteArray *img, const QgsProject *project, const QgsServerRequest &request, const QString &key ) const;

    virtual bool deleteCachedImage( const QgsProject *project, const QgsServerRequest &request, const QString &key ) const;

    virtual bool deleteCachedImages( const QgsProject *project ) const;
};

typedef QMultiMap<int, QgsServerCacheFilter *> QgsServerCacheFilterMap;
 
#endif // QGSSERVERCACHEFILTER_H