Skip to content
Permalink
Browse files

Merge pull request #7378 from pblottiere/server_doc

[server] Update doc path for server
  • Loading branch information
pblottiere committed Jul 13, 2018
2 parents 48195e0 + dcb86a0 commit bf56bd3ce1483824424439fc16c3961735783e9b
Showing with 465 additions and 674 deletions.
  1. +1 −1 .ci/travis/code_layout/install.sh
  2. +7 −14 doc/CMakeLists.txt
  3. +3 −2 python/server/auto_generated/qgsaccesscontrol.sip.in
  4. +3 −2 python/server/auto_generated/qgsbufferserverrequest.sip.in
  5. +2 −0 python/server/auto_generated/qgsbufferserverresponse.sip.in
  6. +12 −1 python/server/auto_generated/qgsconfigcache.sip.in
  7. +7 −0 python/server/auto_generated/qgsmapserviceexception.sip.in
  8. +1 −2 python/server/auto_generated/qgsserversettings.sip.in
  9. +9 −7 python/server/auto_generated/qgsservicemodule.sip.in
  10. +1 −1 python/server/server_auto.sip
  11. +1 −2 src/server/CMakeLists.txt
  12. +3 −3 src/server/qgsaccesscontrol.h
  13. +3 −2 src/server/qgsbufferserverrequest.h
  14. +2 −1 src/server/qgsbufferserverresponse.h
  15. +12 −3 src/server/qgsconfigcache.h
  16. +0 −337 src/server/qgsconfigparserutils.cpp
  17. +0 −54 src/server/qgsconfigparserutils.h
  18. +3 −2 src/server/qgsfcgiserverrequest.h
  19. +7 −2 src/server/qgsfcgiserverresponse.h
  20. +7 −1 src/server/qgsfilterresponsedecorator.h
  21. +6 −1 src/server/qgsfilterrestorer.h
  22. +6 −0 src/server/qgsmapserviceexception.h
  23. +0 −1 src/server/qgsserver.h
  24. +0 −1 src/server/qgsserverexception.h
  25. +4 −6 src/server/qgsserverinterfaceimpl.h
  26. +5 −1 src/server/qgsserverlogger.h
  27. +8 −2 src/server/qgsserverplugins.h
  28. +9 −6 src/server/qgsserversettings.h
  29. +0 −29 src/server/qgsservicemodule.cpp
  30. +17 −10 src/server/qgsservicemodule.h
  31. +11 −2 src/server/qgsservicenativeloader.cpp
  32. +6 −5 src/server/qgsservicenativeloader.h
  33. +2 −3 src/server/services/wcs/CMakeLists.txt
  34. +17 −8 src/server/services/wcs/qgswcs.cpp
  35. +33 −11 src/server/services/wcs/qgswcsserviceexception.h
  36. +0 −1 src/server/services/wfs/CMakeLists.txt
  37. +17 −8 src/server/services/wfs/qgswfs.cpp
  38. +21 −17 src/server/services/wfs/qgswfsparameters.h
  39. +43 −7 src/server/services/wfs/qgswfsserviceexception.h
  40. +0 −1 src/server/services/wms/CMakeLists.txt
  41. +13 −1 src/server/services/wms/qgslayerrestorer.h
  42. +17 −14 src/server/services/wms/qgsmaprendererjobproxy.h
  43. +18 −10 src/server/services/wms/qgswms.cpp
  44. +9 −11 src/server/services/wms/qgswmsgetcapabilities.h
  45. +60 −57 src/server/services/wms/qgswmsparameters.h
  46. +24 −19 src/server/services/wms/qgswmsrenderer.h
  47. +35 −5 src/server/services/wms/qgswmsserviceexception.h
@@ -19,6 +19,6 @@ export CORES=2
mkdir build
pushd build || exit

cmake -DUSE_CCACHE=OFF -DWITH_CORE=OFF -DWITH_APIDOC=ON -DWITH_ASTYLE=ON -DENABLE_TESTS=ON ..
cmake -DWITH_SERVER=ON -DUSE_CCACHE=OFF -DWITH_CORE=OFF -DWITH_APIDOC=ON -DWITH_ASTYLE=ON -DENABLE_TESTS=ON ..

popd || exit
@@ -104,23 +104,16 @@ IF(WITH_APIDOC)
${CMAKE_SOURCE_DIR}/src/quickgui/plugin
)

IF(WITH_SERVER_PLUGINS)
IF(WITH_SERVER)
SET(DOXYGEN_INPUT
${DOXYGEN_INPUT}
${CMAKE_SOURCE_DIR}/src/server/qgsserver.h
${CMAKE_SOURCE_DIR}/src/server/qgscapabilitiescache.h
${CMAKE_SOURCE_DIR}/src/server/qgsserverexception.h
${CMAKE_SOURCE_DIR}/src/server/qgsrequesthandler.h
${CMAKE_SOURCE_DIR}/src/server/qgsserverfilter.h
${CMAKE_SOURCE_DIR}/src/server/qgsaccesscontrolfilter.h
${CMAKE_SOURCE_DIR}/src/server/qgsserverinterface.h
${CMAKE_SOURCE_DIR}/src/server/qgsserverrequest.h
${CMAKE_SOURCE_DIR}/src/server/qgsserverresponse.h
${CMAKE_SOURCE_DIR}/src/server/qgsserverrequest.h
${CMAKE_SOURCE_DIR}/src/server/qgsservice.h
${CMAKE_SOURCE_DIR}/src/server/qgsserviceregistry.h
${CMAKE_SOURCE_DIR}/src/server/
${CMAKE_SOURCE_DIR}/src/server/services/
${CMAKE_SOURCE_DIR}/src/server/services/wms
${CMAKE_SOURCE_DIR}/src/server/services/wfs
${CMAKE_SOURCE_DIR}/src/server/services/wcs
)
ENDIF(WITH_SERVER_PLUGINS)
ENDIF(WITH_SERVER)

SET(DOXYGEN_FILE_PATTERNS *.h *.cpp *.dox)

@@ -16,8 +16,9 @@
class QgsAccessControl : QgsFeatureFilterProvider
{
%Docstring
A helper class that centralize the restrictions given by all the
access control filter plugins.
A helper class that centralizes restrictions given by all the access control filter plugins.

.. versionadded:: 2.14
%End

%TypeHeaderCode
@@ -12,8 +12,9 @@
class QgsBufferServerRequest : QgsServerRequest
{
%Docstring
QgsBufferServerRequest
Class defining request with data
Class defining request with data

.. versionadded:: 3.0
%End

%TypeHeaderCode
@@ -13,6 +13,8 @@ class QgsBufferServerResponse: QgsServerResponse
{
%Docstring
Class defining buffered response

.. versionadded:: 3.0
%End

%TypeHeaderCode
@@ -15,19 +15,30 @@ class QgsConfigCache : QObject
{
%Docstring
Cache for server configuration.

.. versionadded:: 2.8
%End

%TypeHeaderCode
#include "qgsconfigcache.h"
%End
public:

static QgsConfigCache *instance();
%Docstring
Returns the current instance.
%End

void removeEntry( const QString &path );
%Docstring
Removes an entry from cache.

:param path: The path of the project
%End

const QgsProject *project( const QString &path );
%Docstring
If the project is not cached yet, then the project is read thank to the
If the project is not cached yet, then the project is read thanks to the
path. If the project is not available, then a None is returned.

:param path: the filename of the QGIS project
@@ -29,7 +29,14 @@ The most important codes are:
#include "qgsmapserviceexception.h"
%End
public:

QgsMapServiceException( const QString &code, const QString &message );
%Docstring
Constructor for QgsMapServiceException.

:param code: HTTP error code
:param message: Exception message to return to the client
%End
};

/************************************************************************
@@ -15,8 +15,7 @@
class QgsServerSettings
{
%Docstring
QgsServerSettings provides a way to retrieve settings by prioritizing
according to environment variables, ini file and default values.
Provides a way to retrieve settings by prioritizing according to environment variables, ini file and default values.

.. versionadded:: 3.0
%End
@@ -14,12 +14,14 @@
class QgsServiceModule
{
%Docstring
QgsServiceModule
Class defining the service module interface for QGIS server services

This class acts as a service registrar for services.

For dynamic modules, a QgsServiceModule instance is returned from the QGS_ServiceModule_Init() entry point
For dynamic modules, a QgsServiceModule instance is returned from the
QGS_ServiceModule_Init() entry point.

.. versionadded:: 3.0
%End

%TypeHeaderCode
@@ -29,21 +31,21 @@ For dynamic modules, a QgsServiceModule instance is returned from the QGS_Servic

QgsServiceModule();
%Docstring
Constructor
Default constructor for QgsServiceModule.
%End

virtual ~QgsServiceModule() = 0;
virtual ~QgsServiceModule();

virtual void registerSelf( QgsServiceRegistry &registry,
QgsServerInterface *serverIface = 0 ) = 0;
%Docstring
Ask module to register all provided services
Asks the module to register all provided services.

:param registry: :py:class:`QgsServiceRegistry`
:param registry: Service registry
:param serverIface: Interface for plugins
%End
};


/************************************************************************
* This file has been generated automatically from *
* *
@@ -1,4 +1,5 @@
// Include auto-generated SIP files
%Include auto_generated/qgsservicemodule.sip
%Include auto_generated/qgsmapserviceexception.sip
%Include auto_generated/qgscapabilitiescache.sip
%Include auto_generated/qgsconfigcache.sip
@@ -15,7 +16,6 @@
%Include auto_generated/qgsserverrequest.sip
%Include auto_generated/qgsserverresponse.sip
%Include auto_generated/qgsservice.sip
%Include auto_generated/qgsservicemodule.sip
%Include auto_generated/qgsserviceregistry.sip
%Include auto_generated/qgsfeaturefilterprovidergroup.sip
%Include auto_generated/qgsfeaturefilter.sip
@@ -24,7 +24,6 @@ SET(QGIS_SERVER_SRCS
qgsbufferserverresponse.cpp
qgscapabilitiescache.cpp
qgsconfigcache.cpp
qgsconfigparserutils.cpp
qgsfcgiserverrequest.cpp
qgsfcgiserverresponse.cpp
qgsfilterresponsedecorator.cpp
@@ -40,14 +39,14 @@ SET(QGIS_SERVER_SRCS
qgsserverresponse.cpp
qgsserversettings.cpp
qgsservice.cpp
qgsservicemodule.cpp
qgsservicenativeloader.cpp
qgsserviceregistry.cpp
qgsfeaturefilterprovidergroup.cpp
qgsfeaturefilter.cpp
)

SET (QGIS_SERVER_HDRS
qgsservicemodule.h
qgsmapserviceexception.h
)

@@ -33,9 +33,9 @@ class QgsAccessControlPlugin;
/**
* \ingroup server
* \class QgsAccessControl
* \brief A helper class that centralize the restrictions given by all the
* access control filter plugins.
**/
* \brief A helper class that centralizes restrictions given by all the access control filter plugins.
* \since QGIS 2.14
*/
class SERVER_EXPORT QgsAccessControl : public QgsFeatureFilterProvider
{
#ifdef SIP_RUN
@@ -28,8 +28,9 @@

/**
* \ingroup server
* QgsBufferServerRequest
* Class defining request with data
* \class QgsBufferServerRequest
* \brief Class defining request with data
* \since QGIS 3.0
*/
class SERVER_EXPORT QgsBufferServerRequest : public QgsServerRequest
{
@@ -30,7 +30,8 @@
/**
* \ingroup server
* \class QgsBufferServerResponse
* Class defining buffered response
* \brief Class defining buffered response
* \since QGIS 3.0
*/
class SERVER_EXPORT QgsBufferServerResponse: public QgsServerResponse
{
@@ -31,20 +31,29 @@
#include "qgsproject.h"

/**
* Cache for server configuration.
* \ingroup server
* \brief Cache for server configuration.
* \since QGIS 2.8
*/
class SERVER_EXPORT QgsConfigCache : public QObject
{
Q_OBJECT
public:

/**
* Returns the current instance.
*/
static QgsConfigCache *instance();

/**
* Removes an entry from cache.
* \param path The path of the project
*/
void removeEntry( const QString &path );

/**
* If the project is not cached yet, then the project is read thank to the
* path. If the project is not available, then a nullptr is returned.
* If the project is not cached yet, then the project is read thanks to the
* path. If the project is not available, then a nullptr is returned.
* \param path the filename of the QGIS project
* \returns the project or nullptr if an error happened
* \since QGIS 3.0

0 comments on commit bf56bd3

Please sign in to comment.
You can’t perform that action at this time.