QGIS API Documentation  3.9.0-Master (d9ef585e47)
qgsrequesthandler.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgshttprequesthandler.h
3  -----------------------
4  begin : June 29, 2007
5  copyright : (C) 2007 by Marco Hugentobler
6  (C) 2014 by Alessandro Pasotti
7  email : marco dot hugentobler at karto dot baug dot ethz dot ch
8  a dot pasotti at itopen dot it
9  ***************************************************************************/
10 
11 /***************************************************************************
12  * *
13  * This program is free software; you can redistribute it and/or modify *
14  * it under the terms of the GNU General Public License as published by *
15  * the Free Software Foundation; either version 2 of the License, or *
16  * (at your option) any later version. *
17  * *
18  ***************************************************************************/
19 
20 #ifndef QGSREQUESTHANDLER_H
21 #define QGSREQUESTHANDLER_H
22 
23 #include <QMap>
24 #include "qgis_sip.h"
25 #include <QString>
26 #include <QPair>
27 #include <QColor>
28 
29 #include "qgis_server.h"
30 
31 class QgsServerException;
32 class QgsServerRequest;
34 
35 typedef QList< QPair<QRgb, int> > QgsColorBox; //Color / number of pixels
36 typedef QMultiMap< int, QgsColorBox > QgsColorBoxMap; // sum of pixels / color box
37 
43 class SERVER_EXPORT QgsRequestHandler
44 {
45  public:
46 
52  explicit QgsRequestHandler( QgsServerRequest &request, QgsServerResponse &response );
53 
55  void setServiceException( const QgsServerException &ex );
56 
63  void sendResponse();
64 
66  void setResponseHeader( const QString &name, const QString &value );
67 
69  void removeResponseHeader( const QString &name );
70 
72  QString responseHeader( const QString &name ) const;
73 
75  QMap<QString, QString> responseHeaders() const;
76 
78  void setRequestHeader( const QString &name, const QString &value );
79 
81  void removeRequestHeader( const QString &name );
82 
84  QString requestHeader( const QString &name ) const;
85 
87  QMap<QString, QString> requestHeaders() const;
88 
90  void clear();
91 
93  void appendBody( const QByteArray &body );
94 
96  bool exceptionRaised() const;
97 
99  void clearBody();
100 
102  QByteArray body() const;
103 
105  QByteArray data() const;
106 
108  QString url() const;
109 
111  void setStatusCode( int code );
112 
114  int statusCode() const;
115 
121  QMap<QString, QString> parameterMap() const;
122 
124  void setParameter( const QString &key, const QString &value );
125 
127  QString parameter( const QString &key ) const;
128 
130  void removeParameter( const QString &key );
131 
136  void parseInput() SIP_SKIP;
137 
139  QString format() const { return mFormat; }
140 
142  bool headersSent() const;
143 
144  private:
145 
146  void setupParameters();
147 
149  QString mFormat;
150  QString mFormatString; //format string as it is passed in the request (with base)
151  QString mService;
152  bool mExceptionRaised;
153 
154  QgsServerRequest &mRequest;
155  QgsServerResponse &mResponse;
156 
157 };
158 
159 #endif
QString format() const
Returns the requested format string.
#define SIP_SKIP
Definition: qgis_sip.h:126
This class is an interface hiding the details of reading input and writing output from/to a wms reque...
Exception base class for server exceptions.
QgsServerRequest Class defining request interface passed to services QgsService::executeRequest() met...
QMultiMap< int, QgsColorBox > QgsColorBoxMap
QList< QPair< QRgb, int > > QgsColorBox
QgsServerResponse Class defining response interface passed to services QgsService::executeRequest() m...