GeoHealthCheck.plugins.probe.http
=================================

.. py:module:: GeoHealthCheck.plugins.probe.http


Classes
-------

.. autoapisummary::

   GeoHealthCheck.plugins.probe.http.HttpGet
   GeoHealthCheck.plugins.probe.http.HttpGetQuery
   GeoHealthCheck.plugins.probe.http.HttpPost


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

.. py:class:: HttpGet

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


   Do HTTP GET Request, to poll/ping any Resource bare url.


   .. py:attribute:: NAME
      :value: 'HTTP GET Resource URL'


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



   .. py:attribute:: DESCRIPTION
      :value: 'Simple HTTP GET on Resource URL'


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



   .. py:attribute:: RESOURCE_TYPE
      :value: '*:*'


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



   .. py:attribute:: REQUEST_METHOD
      :value: 'GET'


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



   .. py:attribute:: CHECKS_AVAIL

      Checks avail



.. py:class:: HttpGetQuery

   Bases: :py:obj:`HttpGet`


   Do HTTP GET Request, to poll/ping any Resource bare url with query string.


   .. py:attribute:: NAME
      :value: 'HTTP GET Resource URL with query'


      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

         """
                 HTTP GET Resource URL with
                 ?query string to be user-supplied (without ?)
                 """

      .. raw:: html

         </details>



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



   .. py:attribute:: REQUEST_TEMPLATE
      :value: '?{query}'


      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:class:: HttpPost

   Bases: :py:obj:`HttpGet`


   Do HTTP POST Request, to send POST request to
   Resource bare url with POST body.


   .. py:attribute:: NAME
      :value: 'HTTP POST Resource URL with body'


      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

         """
                 HTTP POST to Resource URL with body
                 content(-type) to be user-supplied
                 """

      .. raw:: html

         </details>



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



   .. 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: '{body}'


      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:method:: get_request_headers()

      Overridden from Probe: construct request_headers
      via parameter substitution from content_type Parameter.