Remote OGC web service store configuration (workspace/datasources/remoteows)

Contents

Basics
Schema location
Configuration details
Further information

Basic ideas on the configuration concept for all types of datasources and datastores are described in the deegree3/DatastoreConfigurationConcepts.

The concept of remote OWS stores is available since deegree 3.1.

1. Basics

Remote OWS store configurations are defined independant of the application using it.
Each remote OWS store configuration may be used by multiple deegree 3 applications.
Each remote OWS store configuration has its own configuration file.
Each configuration file contains exactly one remote OWS store configuration.
Remote OWS store configuration files are located in the datasources/remoteows/ directory of the deegree workspace. See the workspace directory layout for details.
The name of the configuration file (without the file ending) determines the identifier for this remote OWS store configuration.
Configuration files need to refer to a specific schema version.
Currently only remote WMS stores are implemented.

2. Schema location

The schemas for defining deegree 3 feature store data sources may be found at http://schemas.deegree.org/datasource/remoteows/. It is mandatory to always refer to a specific version of the schemas, as the schema may change over time.

3. Configuration details

3.1. Remote WMS stores

A <Remote WMS store> provides access to WMS layers, with some preconfigured parameters.

Current version remote WMS: 3.1.0 (valid since 2011-01-05)

Please note that currently only WMS version 1.1.1 is supported.

3.2. Configuration parameters

CapabilitiesDocumentLocation: its location attribute must point to a capabilities document, this can be a GetCapabilities request or a local document
ConnectionTimeout: optional, specifies the connection timeout in seconds when requesting maps, default is 5 seconds
RequestTimeout: optional, specifies the read timeout in seconds when requesting maps, default is 60 seconds
DefaultRequestOptions: optional, specifies global request options (see below)
RequestedLayer: can occur multiple times. Each one specifies one requested layer using the <Name> subelement, and can optionally have a <RequestOptions> element overriding the global options.

The request options may have the following optional subelements:

ImageFormat: specifies the requested image mime type. It has an optional attribute transparent, with a default value of true. If not specified, the first GetMap format is used.
DefaultCRS: specifies the crs to be used in requests if the layer does not support the requested crs. If the attribute useAlways is set to true, this crs will be used even if the remote service supports the requested crs.
Parameter: specifies other parameters to be used in requests such as STYLES. The attribute "name" defines the parameter's name. With the attribute "use" it is possible to fix the parameter for the request. The "scope" attribute can be used to specify if the parameter shall just be used by GetMap requests or even with GetFeatureInfo ones.

Please note that if no request options have been set for specific layers, all layers can be requested at once, which is obviously a lot more efficient than requesting all layers separately.

3.3. Configuration example

Here's an example snippet, specifying three layers with options (let's say config file name is 'd3_testing.xml':

<?xml version="1.0"?>

<RemoteWMSStore xmlns="http://www.deegree.org/datasource/remoteows/wms" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

  xsi:schemaLocation="http://www.deegree.org/datasource/remoteows/wms http://schemas.deegree.org/datasource/remoteows/wms/3.1.0/remotewms.xsd"

  configVersion="3.1.0">

  <CapabilitiesDocumentLocation

    location="http://deegree3-testing.deegree.org/deegree-utah-demo/services?request=GetCapabilities&amp;service=WMS&amp;version=1.1.1" />

  <RequestedLayer>

    <Name>ZipCodes</Name>

    <RequestOptions>

      <ImageFormat transparent="false">image/png</ImageFormat>

      <DefaultCRS useAlways="true">EPSG:4326</DefaultCRS>

    </RequestOptions>

  </RequestedLayer>

  <RequestedLayer>

    <Name>Roads</Name>

    <RequestOptions>

      <DefaultCRS useAlways="true">EPSG:26912</DefaultCRS>

      <Parameter use="allowOverride" scope="GetMap" name="styles">colorful</Parameter>

    </RequestOptions>

  </RequestedLayer>

  <RequestedLayer>

    <Name>Railroads</Name>

  </RequestedLayer>

</RemoteWMSStore>

3.4. Integration into WMS (example)

Please find a detailed documentation on the WMS configuration in wms layer configuration section.

Just a short example:

Please edit your WMS configuration to add the layer to the WMS layer tree (deegree console -> web services ). Example snippet:

<wms:RequestableLayer>

  <wms:Name>transportation</wms:Name>

  <wms:Title>transportation</wms:Title>

  <wms:RemoteWMSStoreId>d3_testing</wms:RemoteWMSStoreId>

</wms:RequestableLayer>

4. Further information

For other parts of the workspace configuration please consult the following pages:

CategoryDeegree3 CategoryWorkspaceConfiguration