From a2bd50129fc256e66a8c128b3ba0f95a4e60ce62 Mon Sep 17 00:00:00 2001 From: Julian Zilz Date: Fri, 16 Oct 2026 15:17:07 +0200 Subject: [PATCH 1/2] #1857- Implement formatting of GML responses using IndentingXMLStreamWriter --- .../oaf/io/response/gml/FeaturesResponseGmlWriter.java | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/deegree-ogcapi-features/src/main/java/org/deegree/services/oaf/io/response/gml/FeaturesResponseGmlWriter.java b/deegree-ogcapi-features/src/main/java/org/deegree/services/oaf/io/response/gml/FeaturesResponseGmlWriter.java index df054d32..238332dc 100644 --- a/deegree-ogcapi-features/src/main/java/org/deegree/services/oaf/io/response/gml/FeaturesResponseGmlWriter.java +++ b/deegree-ogcapi-features/src/main/java/org/deegree/services/oaf/io/response/gml/FeaturesResponseGmlWriter.java @@ -21,6 +21,7 @@ */ package org.deegree.services.oaf.io.response.gml; +import org.deegree.commons.xml.stax.IndentingXMLStreamWriter; import org.deegree.cs.coordinatesystems.ICRS; import org.deegree.cs.exceptions.TransformationException; import org.deegree.cs.exceptions.UnknownCRSException; @@ -80,7 +81,8 @@ public void writeTo(AbstractFeatureResponse features, Class type, Type generi throws WebApplicationException { GMLStreamWriter gmlStreamWriter = null; try { - XMLStreamWriter xmlStreamWriter = XMLOutputFactory.newFactory().createXMLStreamWriter(out); + XMLStreamWriter xmlStreamWriter = new IndentingXMLStreamWriter( + XMLOutputFactory.newFactory().createXMLStreamWriter(out)); gmlStreamWriter = GMLOutputFactory.createGMLStreamWriter(GMLVersion.GML_32, xmlStreamWriter); Map prefixToNs = new HashMap<>(); prefixToNs.putAll(features.getFeatureTypeNsPrefixes()); From 7795390de8c7de16260c6f9dd8813cf44fef3190 Mon Sep 17 00:00:00 2001 From: Julian Zilz Date: Mon, 2 Nov 2026 20:02:41 +0100 Subject: [PATCH 2/2] #1857 - Make GML response formatting optional via tunable --- .../src/main/asciidoc/configuration.adoc | 6 ++ .../gml/FeaturesResponseGmlWriter.java | 15 +++- .../response/FeaturesResponseGmlWriterIT.java | 79 +++++++++++++++++++ 3 files changed, 98 insertions(+), 2 deletions(-) diff --git a/deegree-ogcapi-documentation/src/main/asciidoc/configuration.adoc b/deegree-ogcapi-documentation/src/main/asciidoc/configuration.adoc index f968e71f..8c8cda0c 100644 --- a/deegree-ogcapi-documentation/src/main/asciidoc/configuration.adoc +++ b/deegree-ogcapi-documentation/src/main/asciidoc/configuration.adoc @@ -503,6 +503,12 @@ By default, collections include the links "Download all features as GeoJSON" and To hide these links set the system property `deegree.oaf.links.enclosure.enabled` to _false_. The default is _true_. This setting only controls link visibility. Direct requests with `bulk=true` remain available. +=== Format GML responses + +By default, GML responses are written without added line breaks or indentation. +To enable formatting for both single-item and collection responses, set the system property +`deegree.oaf.gml.response.format.enabled` to _true_. The default is _false_. + [[config_logging]] === Logging configuration diff --git a/deegree-ogcapi-features/src/main/java/org/deegree/services/oaf/io/response/gml/FeaturesResponseGmlWriter.java b/deegree-ogcapi-features/src/main/java/org/deegree/services/oaf/io/response/gml/FeaturesResponseGmlWriter.java index 238332dc..6881119f 100644 --- a/deegree-ogcapi-features/src/main/java/org/deegree/services/oaf/io/response/gml/FeaturesResponseGmlWriter.java +++ b/deegree-ogcapi-features/src/main/java/org/deegree/services/oaf/io/response/gml/FeaturesResponseGmlWriter.java @@ -21,6 +21,7 @@ */ package org.deegree.services.oaf.io.response.gml; +import org.deegree.commons.utils.TunableParameter; import org.deegree.commons.xml.stax.IndentingXMLStreamWriter; import org.deegree.cs.coordinatesystems.ICRS; import org.deegree.cs.exceptions.TransformationException; @@ -63,6 +64,14 @@ @Produces({ APPLICATION_GML }) public class FeaturesResponseGmlWriter implements MessageBodyWriter { + /** + * Controls whether GML responses are formatted with line breaks and indentation + * (default: false). + */ + public static final String PARAMETER_GML_RESPONSE_FORMAT_ENABLED = "deegree.oaf.gml.response.format.enabled"; + + private final boolean formatEnabled = TunableParameter.get(PARAMETER_GML_RESPONSE_FORMAT_ENABLED, false); + @Override public boolean isWriteable(Class type, Type genericType, Annotation[] annotations, MediaType mediaType) { return FeaturesResponse.class == type || FeatureResponse.class == type; @@ -81,8 +90,10 @@ public void writeTo(AbstractFeatureResponse features, Class type, Type generi throws WebApplicationException { GMLStreamWriter gmlStreamWriter = null; try { - XMLStreamWriter xmlStreamWriter = new IndentingXMLStreamWriter( - XMLOutputFactory.newFactory().createXMLStreamWriter(out)); + XMLStreamWriter xmlStreamWriter = XMLOutputFactory.newFactory().createXMLStreamWriter(out); + if (formatEnabled) { + xmlStreamWriter = new IndentingXMLStreamWriter(xmlStreamWriter); + } gmlStreamWriter = GMLOutputFactory.createGMLStreamWriter(GMLVersion.GML_32, xmlStreamWriter); Map prefixToNs = new HashMap<>(); prefixToNs.putAll(features.getFeatureTypeNsPrefixes()); diff --git a/deegree-ogcapi-features/src/test/java/org/deegree/services/oaf/io/response/FeaturesResponseGmlWriterIT.java b/deegree-ogcapi-features/src/test/java/org/deegree/services/oaf/io/response/FeaturesResponseGmlWriterIT.java index 5e5b4d28..7b42b1c5 100644 --- a/deegree-ogcapi-features/src/test/java/org/deegree/services/oaf/io/response/FeaturesResponseGmlWriterIT.java +++ b/deegree-ogcapi-features/src/test/java/org/deegree/services/oaf/io/response/FeaturesResponseGmlWriterIT.java @@ -22,6 +22,7 @@ package org.deegree.services.oaf.io.response; import org.deegree.commons.utils.CloseableIterator; +import org.deegree.commons.utils.TunableParameter; import org.deegree.feature.Feature; import org.deegree.feature.FeatureCollection; import org.deegree.feature.stream.EmptyFeatureInputStream; @@ -31,7 +32,12 @@ import org.deegree.gml.GMLStreamReader; import org.deegree.services.oaf.io.response.gml.FeaturesResponseGmlWriter; import org.deegree.services.oaf.link.Link; +import org.junit.jupiter.api.AfterEach; +import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; +import org.junit.jupiter.params.ParameterizedTest; +import org.junit.jupiter.params.provider.NullSource; +import org.junit.jupiter.params.provider.ValueSource; import javax.xml.namespace.QName; import javax.xml.transform.stream.StreamSource; @@ -39,6 +45,7 @@ import java.io.IOException; import java.io.OutputStream; import java.net.URL; +import java.nio.charset.StandardCharsets; import java.util.Collection; import java.util.Collections; import java.util.HashMap; @@ -49,6 +56,7 @@ import static org.deegree.gml.GMLVersion.GML_32; import static org.deegree.services.oaf.OgcApiFeaturesConstants.XML_SF_NS_URL; import static org.deegree.services.oaf.OgcApiFeaturesConstants.XML_SF_SCHEMA_URL; +import static org.deegree.services.oaf.io.response.gml.FeaturesResponseGmlWriter.PARAMETER_GML_RESPONSE_FORMAT_ENABLED; import static org.hamcrest.CoreMatchers.is; import static org.hamcrest.MatcherAssert.assertThat; import static org.xmlunit.matchers.EvaluateXPathMatcher.hasXPath; @@ -63,6 +71,77 @@ class FeaturesResponseGmlWriterIT { private static final String SCHEMA_LOCATION = "http://schemalocation/datasets/dataset/collections/collection/appschema"; + private String originalFormatEnabled; + + @BeforeEach + void resetFormatParameter() { + originalFormatEnabled = System.getProperty(PARAMETER_GML_RESPONSE_FORMAT_ENABLED); + System.clearProperty(PARAMETER_GML_RESPONSE_FORMAT_ENABLED); + TunableParameter.resetCache(); + } + + @AfterEach + void restoreFormatParameter() { + if (originalFormatEnabled == null) { + System.clearProperty(PARAMETER_GML_RESPONSE_FORMAT_ENABLED); + } + else { + System.setProperty(PARAMETER_GML_RESPONSE_FORMAT_ENABLED, originalFormatEnabled); + } + TunableParameter.resetCache(); + } + + @ParameterizedTest + @NullSource + @ValueSource(strings = { "true", "false" }) + void writeToWithFormatting(String formatEnabled) throws Exception { + assertFormatting(createFeatureResponse(), formatEnabled, 5); + } + + @ParameterizedTest + @NullSource + @ValueSource(strings = { "true", "false" }) + void writeSingleFeatureWithFormatting(String formatEnabled) throws Exception { + FeaturesResponse featuresResponse = createFeatureResponse(); + FeatureInputStream featureStream = featuresResponse.getFeatures(); + try { + Feature feature = featureStream.iterator().next(); + FeatureResponse featureResponse = new FeaturesResponseBuilder(feature) + .withFeatureTypeNsPrefixes(featuresResponse.getFeatureTypeNsPrefixes()) + .withSchemaLocation(NAMESPACE_URI, SCHEMA_LOCATION) + .buildFeatureResponse(); + assertFormatting(featureResponse, formatEnabled, 1); + } + finally { + featureStream.close(); + } + } + + private void assertFormatting(AbstractFeatureResponse response, String formatEnabled, int expectedCount) { + if (formatEnabled != null) { + System.setProperty(PARAMETER_GML_RESPONSE_FORMAT_ENABLED, formatEnabled); + } + FeaturesResponseGmlWriter writer = new FeaturesResponseGmlWriter(); + ByteArrayOutputStream output = new ByteArrayOutputStream(); + writer.writeTo(response, null, null, null, null, null, output); + String xml = output.toString(StandardCharsets.UTF_8); + + boolean formatted = Boolean.parseBoolean(formatEnabled); + assertThat(xml.lines().count() > 1, is(formatted)); + assertThat(xml.matches("(?s).*?>\\R\\h+\\R\\h+<.*"), is(formatted)); + assertThat(xml, hasXPath("count(/sf:FeatureCollection/sf:featureMember/app:strassenbaumkataster)", + is(Integer.toString(expectedCount))) + .withNamespaceContext(nsContext())); + assertThat(xml, hasXPath("/sf:FeatureCollection/sf:featureMember[1]/app:strassenbaumkataster/app:gattung", + is("Quercus / Eiche")) + .withNamespaceContext(nsContext())); + assertThat(xml, + hasXPath( + "/sf:FeatureCollection/sf:featureMember[1]/app:strassenbaumkataster/app:geom/gml:Point/gml:pos", + is("53.553667 10.014337")) + .withNamespaceContext(nsContext())); + } + @Test void writeTo() throws Exception { FeaturesResponseGmlWriter featureResponeWriter = new FeaturesResponseGmlWriter();