GSIP 178

GSIP 178 - Extra metadata for single and opaque layers groups (enabled and advertised)

Overview

The goal of this improvement is to add the enabled and advertised options that are currently only available for single layers:

Having those options checked will have the same impact that they have on single layers:

• Enabled: a layer group that is not enabled won’t be available to any kind of request, it will just show up in the configuration (and in REST config), layer groups will be enabled by default;
• Advertised: a layer group is advertised by default, a non-advertised layer group will be available in all data access requests (for example, WMS GetMap, WMS GetFeature) but won’t appear in any capabilities document or in the layer preview.

Proposed By

• Nuno Olivera
• Imran Rajjad

Assigned to Release

This proposal is for GeoServer 2.17.x and backport to 2.16.x.

State

• Under Discussion
• In Progress
• Completed
• Rejected
• Deferred

Motivation

This feature will allow to enable/disable visibility and advertisement of layer groups (single and opaque mode) just like a a normal single layer. This options are particularly relevant when creating single layers.

Proposal

Currently

Currently the information necessary to handle the advertised and enabled behavior is hold by the the ResourceInfo interface which requires implementation of the following methods:

• boolean enabled();
• void setEnabled(boolean enabled);
• boolean isAdvertised();
• void setAdvertised(boolean advertised);

This methods are also replicated in LayerInfo interface.

Making this properties available for will require changes on existing interfaces:

                               CatalogInfo
                                    |
                                    |
     -------------------------------------------------------------------
     |                                                                 |
     |                                                                 |
   ResourceInfo                                                 PublishedInfo 
                                                                       |
                                                                       |
                                                                 LayerGroupInfo                                                                                                          

Is worth mentioning that the advertised behavior is handled by AdvertisedCatalog and the enable behavior is mostly handled by DisabledResourceFilter.

Proposed Changes

We have two approaches of adding the two new required attributes:

Option 1: Make the required properties (enabled and advertised) part of LayerGroupInfo just like keywords

Option 2: Move the properties (enabled and advertised) up into CatalogInfo so that both branches can provide implementations of the required methods

Using the two new attributes

For Advertised: changes in AdvertisedCatalogat AdvertisedCatalog.securityFilter

For Enabled: provide an implementation of hideLayerGroup(LayerGroupInfo layerGroup) inside DisabledResourceFilter

For WEB GUI: checkbox will be added and linked to underlying model at LayerGroupEditPage.LayerGroupTab.initUI

Backwards Compatibility

We don't foreseen any backwards compatibility issue:

• the existing concrete implementations will not be changed, so the serialization compatibility will be maintained
• default methods will be provided in the changed interfaces

Feedback

Voting

Project Steering Committee:

• Alessio Fabiani:
• Andrea Aime:
• Brad Hards:
• Ian Turton:
• Jody Garnett:
• Jukka Rahkonen:
• Kevin Smith:
• Simone Giannecchini:

Links

• Email Discussion
• JIRA Ticket
• Pull Request