:tocdepth: 3

:py:mod:`gws.base.ows.server.service`
=====================================

.. py:module:: gws.base.ows.server.service

.. autoapi-nested-parse::

   OWS Service.



**Source code:** :source:`gws.base.ows.server.service<gws/base/ows/server/service.py>`



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



.. py:class:: Config(*args, **kwargs)


   Bases: :py:obj:`gws.ConfigWithAccess`

   Basic config with permissions.

   .. py:attribute:: defaultFeatureCount
      :type:  int
      :value: 1000


      Default number of features per page.

   .. py:attribute:: extent
      :type:  Optional[gws.Extent]

      Service extent.

   .. py:attribute:: imageFormats
      :type:  Optional[list[ImageFormatConfig]]

      Supported image formats. (added in 8.1)

   .. py:attribute:: maxFeatureCount
      :type:  int
      :value: 10000


      Max number of features per page. (added in 8.1)

   .. py:attribute:: metadata
      :type:  Optional[gws.Metadata]

      Service metadata.

   .. py:attribute:: rootLayerUid
      :type:  str
      :value: ''


      Root layer uid.

   .. py:attribute:: searchLimit
      :type:  int
      :value: 10000


      Search limit. (deprecated in 8.1)

   .. py:attribute:: searchTolerance
      :type:  gws.UomValueStr
      :value: '10px'


      Search pixel tolerance.

   .. py:attribute:: supportedCrs
      :type:  Optional[list[gws.CrsName]]

      List of CRS supported by this service.

   .. py:attribute:: templates
      :type:  Optional[list[gws.ext.config.template]]

      XML and HTML templates.

   .. py:attribute:: updateSequence
      :type:  Optional[str]

      Service update sequence.

   .. py:attribute:: withInspireMeta
      :type:  bool
      :value: False


      Emit INSPIRE Metadata.

   .. py:attribute:: withStrictParams
      :type:  bool
      :value: False


      Use strict params checking.


.. py:class:: ImageFormatConfig


   Image format configuration. (added in 8.1)

   .. py:attribute:: mimeTypes
      :type:  list[str]

      Mime types for this format.

   .. py:attribute:: options
      :type:  Optional[dict]

      Image options.


.. py:class:: Object


   Bases: :py:obj:`gws.OwsService`

   Baseclass for OWS services.

   .. py:method:: available_formats(verb: gws.OwsVerb)

   .. py:method:: configure()

      Configuration hook.


   .. py:method:: configure_bounds()

   .. py:method:: configure_image_formats()

   .. py:method:: configure_metadata()

   .. py:method:: configure_operations()

   .. py:method:: configure_templates()

   .. py:method:: dispatch_request(sr: gws.base.ows.server.request.Object)

   .. py:method:: feature_collection(sr: gws.base.ows.server.request.Object, lcs: list[gws.base.ows.server.core.LayerCaps], hits: int, results: list[gws.SearchResult]) -> gws.base.ows.server.core.FeatureCollection

   .. py:method:: find_image_format(mime: str) -> gws.OwsImageFormat

   .. py:method:: handle_request(req: gws.WebRequester) -> gws.ContentResponse

      Handle a service request.


   .. py:method:: image_response(sr: gws.base.ows.server.request.Object, img: Optional[gws.Image], mime: str) -> gws.ContentResponse

   .. py:method:: init_request(req: gws.WebRequester) -> gws.base.ows.server.request.Object

   .. py:method:: post_configure()

      Post-configuration hook.


   .. py:method:: post_configure_root_layer()

   .. py:method:: render_legend(sr: gws.base.ows.server.request.Object, lcs: list[gws.base.ows.server.core.LayerCaps], mime: str) -> gws.ContentResponse

   .. py:method:: template_response(sr: gws.base.ows.server.request.Object, mime: str = '', **kwargs) -> gws.ContentResponse

   .. py:method:: url_path() -> str