mirror of
https://github.com/qgis/QGIS.git
synced 2025-02-27 00:33:48 -05:00
b7d6c1e59e
This is the first step to a cleaner and consitent API for server plugin. It also adds some new tests for the base request and response classes
153 lines
3.6 KiB
Plaintext
153 lines
3.6 KiB
Plaintext
/***************************************************************************
|
|
qgsserverrequest.h
|
|
|
|
Define request class for getting request contents
|
|
-------------------
|
|
begin : 2016-12-05
|
|
copyright : (C) 2016 by David Marteau
|
|
email : david dot marteau 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. *
|
|
* *
|
|
***************************************************************************/
|
|
|
|
/**
|
|
* \ingroup server
|
|
* QgsServerRequest
|
|
* Class defining request interface passed to services QgsService::executeRequest() method
|
|
*/
|
|
|
|
class QgsServerRequest
|
|
{
|
|
%TypeHeaderCode
|
|
#include "qgsserverrequest.h"
|
|
%End
|
|
public:
|
|
|
|
typedef QMap<QString, QString> Parameters;
|
|
typedef QMap<QString, QString> Headers;
|
|
|
|
enum Method
|
|
{
|
|
HeadMethod, PutMethod, GetMethod, PostMethod, DeleteMethod
|
|
};
|
|
|
|
/**
|
|
* Constructor
|
|
*/
|
|
QgsServerRequest();
|
|
|
|
/**
|
|
* Constructor
|
|
*
|
|
* @param url the url string
|
|
* @param method the request method
|
|
*/
|
|
QgsServerRequest( const QString &url, Method method );
|
|
|
|
|
|
/**
|
|
* Constructor
|
|
*
|
|
* \param url the url string
|
|
* \param method the request method
|
|
* \param headers
|
|
*/
|
|
QgsServerRequest( const QString &url, Method method = GetMethod, const QgsServerRequest::Headers &headers = QgsServerRequest::Headers( ) );
|
|
|
|
/**
|
|
* Constructor
|
|
*
|
|
* \param url QUrl
|
|
* \param method the request method
|
|
* \param headers
|
|
*/
|
|
QgsServerRequest( const QUrl &url, Method method = GetMethod, const QgsServerRequest::Headers &headers = QgsServerRequest::Headers( ) );
|
|
|
|
|
|
//! destructor
|
|
virtual ~QgsServerRequest();
|
|
|
|
|
|
/**
|
|
* Return the header value
|
|
* @param name of the header
|
|
* @return the header value or an empty string
|
|
*/
|
|
QString header( const QString &name ) const;
|
|
|
|
/**
|
|
* Set an header
|
|
* @param name
|
|
* @param value
|
|
*/
|
|
void setHeader( const QString &name, const QString &value );
|
|
|
|
/**
|
|
* Return the header map
|
|
* @return the headers map
|
|
*/
|
|
QMap<QString, QString> headers( ) const;
|
|
|
|
/**
|
|
* Remove an header
|
|
* @param name
|
|
*/
|
|
void removeHeader( const QString &name );
|
|
|
|
/**
|
|
* @return the request url
|
|
*/
|
|
QUrl url() const;
|
|
|
|
/**
|
|
* @return the request method
|
|
*/
|
|
Method method() const;
|
|
|
|
/**
|
|
* @return query params
|
|
*/
|
|
QMap<QString, QString> parameters() const;
|
|
|
|
/**
|
|
* Set a parameter
|
|
*/
|
|
void setParameter( const QString &key, const QString &value );
|
|
|
|
/**
|
|
* Get a parameter value
|
|
*/
|
|
QString parameter( const QString& key ) const;
|
|
|
|
/**
|
|
* Remove a parameter
|
|
*/
|
|
void removeParameter( const QString &key );
|
|
|
|
/**
|
|
* Return post/put data
|
|
* Check for QByteArray::isNull() to check if data
|
|
* is available.
|
|
*/
|
|
virtual QByteArray data() const;
|
|
|
|
/**
|
|
* Set the request url
|
|
*/
|
|
void setUrl( const QUrl &url );
|
|
|
|
/**
|
|
* Set the request method
|
|
*/
|
|
void setMethod( Method method );
|
|
|
|
};
|
|
|