QGIS API Documentation  3.21.0-Master (5b68dc587e)
Public Member Functions | List of all members
QgsFcgiServerRequest Class Reference

Class defining fcgi request. More...

#include <qgsfcgiserverrequest.h>

Inheritance diagram for QgsFcgiServerRequest:
Inheritance graph
[legend]

Public Member Functions

 QgsFcgiServerRequest ()
 
QByteArray data () const override
 Returns post/put data Check for QByteArray::isNull() to check if data is available. More...
 
bool hasError () const
 Returns true if an error occurred during initialization. More...
 
QString header (const QString &name) const override
 Returns the header value. More...
 
- Public Member Functions inherited from QgsServerRequest
 QgsServerRequest ()=default
 Constructor. More...
 
 QgsServerRequest (const QgsServerRequest &other)
 Copy constructor. More...
 
 QgsServerRequest (const QString &url, QgsServerRequest::Method method=QgsServerRequest::GetMethod, const QgsServerRequest::Headers &headers=QgsServerRequest::Headers())
 Constructor. More...
 
 QgsServerRequest (const QUrl &url, QgsServerRequest::Method method=QgsServerRequest::GetMethod, const QgsServerRequest::Headers &headers=QgsServerRequest::Headers())
 Constructor. More...
 
virtual ~QgsServerRequest ()=default
 destructor More...
 
QUrl baseUrl () const
 Returns the base URL of QGIS server. More...
 
virtual QString header (const RequestHeader &headerEnum) const
 Returns the header value. More...
 
QMap< QString, QString > headers () const
 Returns the header map. More...
 
QgsServerRequest::Method method () const
 
QgsServerRequestoperator= (const QgsServerRequest &)=default
 
QUrl originalUrl () const
 Returns the request url as seen by the web server, by default this is equal to the url seen by QGIS server. More...
 
QString parameter (const QString &key, const QString &defaultValue=QString()) const
 Gets a parameter value. More...
 
QgsServerRequest::Parameters parameters () const
 Returns a map of query parameters with keys converted to uppercase. More...
 
const QString queryParameter (const QString &name, const QString &defaultValue=QString()) const
 Returns the query string parameter with the given name from the request URL, a defaultValue can be specified. More...
 
void removeHeader (const QString &name)
 Remove an header. More...
 
virtual void removeParameter (const QString &key)
 Remove a parameter. More...
 
QgsServerParameters serverParameters () const
 Returns parameters. More...
 
void setHeader (const QString &name, const QString &value)
 Set an header. More...
 
void setMethod (QgsServerRequest::Method method)
 Set the request method. More...
 
virtual void setParameter (const QString &key, const QString &value)
 Set a parameter. More...
 
virtual void setUrl (const QUrl &url)
 Set the request url. More...
 
QUrl url () const
 

Additional Inherited Members

- Public Types inherited from QgsServerRequest
typedef QMap< QString, QString > Headers
 
enum  Method {
  HeadMethod , PutMethod , GetMethod , PostMethod ,
  DeleteMethod , PatchMethod
}
 HTTP Method (or equivalent) used for the request. More...
 
typedef QMap< QString, QString > Parameters
 
enum  RequestHeader {
  HOST , FORWARDED , X_FORWARDED_FOR , X_FORWARDED_HOST ,
  X_FORWARDED_PROTO , X_QGIS_SERVICE_URL , X_QGIS_WMS_SERVICE_URL , X_QGIS_WFS_SERVICE_URL ,
  X_QGIS_WCS_SERVICE_URL , X_QGIS_WMTS_SERVICE_URL
}
 The internal HTTP Header used for the request as enum. More...
 
- Static Public Member Functions inherited from QgsServerRequest
static QString methodToString (const Method &method)
 Returns a string representation of an HTTP request method. More...
 
- Protected Member Functions inherited from QgsServerRequest
void setBaseUrl (const QUrl &url)
 Set the base URL of QGIS server. More...
 
void setOriginalUrl (const QUrl &url)
 Set the request original url (the request url as seen by the web server) More...
 

Detailed Description

Class defining fcgi request.

Since
QGIS 3.0

Definition at line 32 of file qgsfcgiserverrequest.h.

Constructor & Destructor Documentation

◆ QgsFcgiServerRequest()

QgsFcgiServerRequest::QgsFcgiServerRequest ( )

Definition at line 27 of file qgsfcgiserverrequest.cpp.

Member Function Documentation

◆ data()

QByteArray QgsFcgiServerRequest::data ( ) const
overridevirtual

Returns post/put data Check for QByteArray::isNull() to check if data is available.

Reimplemented from QgsServerRequest.

Definition at line 156 of file qgsfcgiserverrequest.cpp.

◆ hasError()

bool QgsFcgiServerRequest::hasError ( ) const
inline

Returns true if an error occurred during initialization.

Definition at line 42 of file qgsfcgiserverrequest.h.

◆ header()

QString QgsFcgiServerRequest::header ( const QString &  name) const
overridevirtual

Returns the header value.

Parameters
nameof the header
Returns
the header value or an empty string
Since
QGIS 3.20

Reimplemented from QgsServerRequest.

Definition at line 263 of file qgsfcgiserverrequest.cpp.


The documentation for this class was generated from the following files: