qgsrequesthandler.h

Go to the documentation of this file.

/***************************************************************************
                              qgshttprequesthandler.h
                              -----------------------
  begin                : June 29, 2007
  copyright            : (C) 2007 by Marco Hugentobler
                         (C) 2014 by Alessandro Pasotti
  email                : marco dot hugentobler at karto dot baug dot ethz dot ch
                         a dot pasotti at itopen dot it
 ***************************************************************************/
 
/***************************************************************************
 *                                                                         *
 *   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 QGSREQUESTHANDLER_H
#define QGSREQUESTHANDLER_H
 
#include "qgis_server.h"
#include "qgis_sip.h"
 
#include <QMap>
#include <QString>
 
class QgsServerException;
class QgsServerRequest;
class QgsServerResponse;

class SERVER_EXPORT QgsRequestHandler
{
  public:
    explicit QgsRequestHandler( QgsServerRequest &request, QgsServerResponse &response );

    void setServiceException( const QgsServerException &ex );

    void sendResponse();

    void setResponseHeader( const QString &name, const QString &value );

    void removeResponseHeader( const QString &name );

    QString responseHeader( const QString &name ) const;

    Q_DECL_DEPRECATED QMap<QString, QString> responseHeaders() const SIP_DEPRECATED;

    QList<QString> fullResponseHeader( const QString &name ) const;

    QMap<QString, QList<QString>> fullResponseHeaders() const;

    void setRequestHeader( const QString &name, const QString &value );

    void removeRequestHeader( const QString &name );

    QString requestHeader( const QString &name ) const;

    QMap<QString, QString> requestHeaders() const;

    void clear();

    void appendBody( const QByteArray &body );

    bool exceptionRaised() const;

    void clearBody();

    QByteArray body() const;

    QByteArray data() const;

    QString url() const;

    QString path() const;

    void setStatusCode( int code );

    int statusCode() const;

    QMap<QString, QString> parameterMap() const;

    void setParameter( const QString &key, const QString &value );

    QString parameter( const QString &key ) const;

    void removeParameter( const QString &key );

    void parseInput() SIP_SKIP;

    QString format() const { return mFormat; }

    bool headersSent() const;
 
  private:
#ifdef SIP_RUN
    QgsRequestHandler &operator=( const QgsRequestHandler & );
#endif
 
    void setupParameters();

    QString mFormat;
    QString mFormatString; //format string as it is passed in the request (with base)
    QString mService;
    bool mExceptionRaised = false;
 
    QgsServerRequest &mRequest;
    QgsServerResponse &mResponse;
};
 
#endif