9.3.1.13.1.2.1.12. GeoHealthCheck.plugins.probe.wms

9.3.1.13.1.2.1.12.1. Classes

WmsGetMapV1	Get WMS map image using the OGC WMS GetMap v1.1.1 Operation
WmsGetMapV1All	Get WMS map image for each Layer using the WMS GetMap operation.

9.3.1.13.1.2.1.12.2. Module Contents

class GeoHealthCheck.plugins.probe.wms.WmsGetMapV1

Bases: GeoHealthCheck.probe.Probe

Get WMS map image using the OGC WMS GetMap v1.1.1 Operation for single Layer.

NAME = 'WMS GetMap WMS v1.1.1. operation on SINGLE Layer'

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

DESCRIPTION = Multiline-String

Show Value

"""
    Do WMS GetMap v1.1.1 request with user-specified parameters
    for single Layer.
    """

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

RESOURCE_TYPE = 'OGC:WMS'

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

REQUEST_METHOD = 'GET'

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

REQUEST_TEMPLATE = '?SERVICE=WMS&VERSION=1.1.1&REQUEST=GetMap&LAYERS={layers}&SRS={srs}&BBOX={bbox[0]},{bbox[1]},{bb...

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.

PARAM_DEFS

Param defs

CHECKS_AVAIL

Checks for WMS GetMap Response available. Optionally override Check PARAM_DEFS using set_params e.g. with specific value or even name.

layer_count = 0

get_metadata(resource, version='1.1.1')

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

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

class GeoHealthCheck.plugins.probe.wms.WmsGetMapV1All

Bases: WmsGetMapV1

Get WMS map image for each Layer using the WMS GetMap operation.

NAME = 'WMS GetMap WMS v1.1.1. operation on ALL Layers'

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

DESCRIPTION = Multiline-String

Show Value

"""
    Do WMS GetMap v1.1.1 request for all Layers with
    user-specified parameters.
    """

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

PARAM_DEFS

Param defs

wms = None

layers = None

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

before_request()

Before request to service, overridden from base class

perform_request()

Perform actual request to service, overridden from base class