GeoHealthCheck.plugins.probe.wfs
================================

.. py:module:: GeoHealthCheck.plugins.probe.wfs


Classes
-------

.. autoapisummary::

   GeoHealthCheck.plugins.probe.wfs.WfsGetFeatureBbox
   GeoHealthCheck.plugins.probe.wfs.WfsGetFeatureBboxAll


Module Contents
---------------

.. py:class:: WfsGetFeatureBbox

   Bases: :py:obj:`GeoHealthCheck.probe.Probe`


   do WFS GetFeature in BBOX


   .. py:attribute:: NAME
      :value: 'WFS GetFeature in BBOX for SINGLE FeatureType'


      Short name of Plugin. TODO: i18n e.g. NAME_nl_NL ?



   .. py:attribute:: DESCRIPTION
      :value: Multiline-String

      .. raw:: html

         <details><summary>Show Value</summary>

      .. code-block:: python

         """
                 WFS GetFeature in BBOX for SINGLE FeatureType.
                 """

      .. raw:: html

         </details>



      Longer description of Plugin.
      TODO: optional i18n e.g. DESCRIPTION_de_DE ?



   .. py:attribute:: RESOURCE_TYPE
      :value: 'OGC:WFS'


      Type of GHC Resource e.g. 'OGC:WMS', default not applicable.



   .. py:attribute:: REQUEST_METHOD
      :value: 'POST'


      HTTP request method capitalized, GET (default) or POST.



   .. py:attribute:: REQUEST_HEADERS

      `dict` of optional HTTP request headers.



   .. py:attribute:: REQUEST_TEMPLATE
      :value: Multiline-String

      .. raw:: html

         <details><summary>Show Value</summary>

      .. code-block:: python

         """<wfs:GetFeature
         xmlns:wfs="http://www.opengis.net/wfs"
         service="WFS"
         version="1.1.0"
         maxFeatures="{max_count}"
         outputFormat="text/xml; subtype=gml/3.1.1"
         xsi:schemaLocation="http://www.opengis.net/wfs
         http://schemas.opengis.net/wfs/1.1.0/wfs.xsd"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
           <wfs:Query typeName="{type_name}" srsName="{srs}"
                 xmlns:{type_ns_prefix}="{type_ns_uri}">
             <ogc:Filter xmlns:ogc="http://www.opengis.net/ogc">
               <ogc:BBOX>
                 <gml:Envelope xmlns:gml="http://www.opengis.net/gml" srsName="{srs}">
                   <gml:lowerCorner>{bbox[0]} {bbox[1]}</gml:lowerCorner>
                   <gml:upperCorner>{bbox[2]} {bbox[3]}</gml:upperCorner>
                 </gml:Envelope>
               </ogc:BBOX>
             </ogc:Filter>
           </wfs:Query>
         </wfs:GetFeature>
             """

      .. raw:: html

         </details>



      Template in standard Python `str.format(*args)`. The variables
      like {service} and {version} within a template are filled from
      actual values for parameters defined in PARAM_DEFS and substituted
      from values or constant values specified by user in GUI and stored
      in DB.



   .. py:attribute:: PARAM_DEFS

      Param defs



   .. py:attribute:: CHECKS_AVAIL

      Checks for WFS GetFeature Response available.
      Optionally override Check PARAM_DEFS using set_params
      e.g. with specific `value` or even `name`.



   .. py:attribute:: layer_count
      :value: 0



   .. py:method:: get_metadata(resource, version='1.1.0')

      Get metadata, specific per Resource type.
      :param resource:
      :param version:
      :return: Metadata object



   .. py:method:: expand_params(resource)

      Called after creation. Use to expand PARAM_DEFS, e.g. from Resource
      metadata like WMS Capabilities. See e.g. WmsGetMapV1 class.
      :param resource:
      :return: None



.. py:class:: WfsGetFeatureBboxAll

   Bases: :py:obj:`WfsGetFeatureBbox`


   Do WFS GetFeature for each FeatureType in WFS.


   .. py:attribute:: NAME
      :value: 'WFS GetFeature in BBOX for ALL FeatureTypes'


      Short name of Plugin. TODO: i18n e.g. NAME_nl_NL ?



   .. py:attribute:: DESCRIPTION
      :value: Multiline-String

      .. raw:: html

         <details><summary>Show Value</summary>

      .. code-block:: python

         """
                 WFS GetFeature in BBOX for ALL FeatureTypes.
                 """

      .. raw:: html

         </details>



      Longer description of Plugin.
      TODO: optional i18n e.g. DESCRIPTION_de_DE ?



   .. py:attribute:: PARAM_DEFS

      Param defs



   .. py:attribute:: wfs
      :value: None



   .. py:attribute:: feature_types
      :value: None



   .. py:method:: expand_params(resource)

      Called after creation. Use to expand PARAM_DEFS, e.g. from Resource
      metadata like WMS Capabilities. See e.g. WmsGetMapV1 class.
      :param resource:
      :return: None



   .. py:method:: before_request()

      Before request to service, overridden from base class



   .. py:method:: perform_request()

      Perform actual request to service, overridden from base class