QGIS API Documentation 3.29.0-Master (da8bb1db43)
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
27#include "qgis_server.h"
28
32
38class SERVER_EXPORT QgsRequestHandler
39{
40 public:
41
47 explicit QgsRequestHandler( QgsServerRequest &request, QgsServerResponse &response );
48
50 void setServiceException( const QgsServerException &ex );
51
58 void sendResponse();
59
61 void setResponseHeader( const QString &name, const QString &value );
62
64 void removeResponseHeader( const QString &name );
65
67 QString responseHeader( const QString &name ) const;
68
70 QMap<QString, QString> responseHeaders() const;
71
73 void setRequestHeader( const QString &name, const QString &value );
74
76 void removeRequestHeader( const QString &name );
77
79 QString requestHeader( const QString &name ) const;
80
82 QMap<QString, QString> requestHeaders() const;
83
85 void clear();
86
88 void appendBody( const QByteArray &body );
89
91 bool exceptionRaised() const;
92
94 void clearBody();
95
97 QByteArray body() const;
98
100 QByteArray data() const;
101
103 QString url() const;
104
109 QString path() const;
110
112 void setStatusCode( int code );
113
115 int statusCode() const;
116
122 QMap<QString, QString> parameterMap() const;
123
125 void setParameter( const QString &key, const QString &value );
126
128 QString parameter( const QString &key ) const;
129
131 void removeParameter( const QString &key );
132
137 void parseInput() SIP_SKIP;
138
140 QString format() const { return mFormat; }
141
143 bool headersSent() const;
144
145 private:
146#ifdef SIP_RUN
147 QgsRequestHandler &operator=( const QgsRequestHandler & );
148#endif
149
150 void setupParameters();
151
153 QString mFormat;
154 QString mFormatString; //format string as it is passed in the request (with base)
155 QString mService;
156 bool mExceptionRaised;
157
158 QgsServerRequest &mRequest;
159 QgsServerResponse &mResponse;
160
161};
162
163#endif
This class is an interface hiding the details of reading input and writing output from/to a wms reque...
QString format() const
Returns the requested format string.
Exception base class for server exceptions.
QgsServerRequest Class defining request interface passed to services QgsService::executeRequest() met...
QgsServerResponse Class defining response interface passed to services QgsService::executeRequest() m...
#define SIP_SKIP
Definition: qgis_sip.h:126