From ff0b9520ec9957612811727fe59c7efc97ecdcd1 Mon Sep 17 00:00:00 2001 From: Lyn Elisa Goltz Date: Wed, 14 Dec 2022 21:23:34 +0100 Subject: [PATCH 1/4] #1102 (#8654) - added config option ReportDeegreeVersion --- .../META-INF/schemas/services/controller/controller.xsd | 1 + 1 file changed, 1 insertion(+) diff --git a/deegree-services/deegree-services-commons/src/main/resources/META-INF/schemas/services/controller/controller.xsd b/deegree-services/deegree-services-commons/src/main/resources/META-INF/schemas/services/controller/controller.xsd index c920242f1a..538329130c 100644 --- a/deegree-services/deegree-services-commons/src/main/resources/META-INF/schemas/services/controller/controller.xsd +++ b/deegree-services/deegree-services-commons/src/main/resources/META-INF/schemas/services/controller/controller.xsd @@ -16,6 +16,7 @@ + From fe2d03a844f2b470b6bd2636eaa8b78f95c0b553 Mon Sep 17 00:00:00 2001 From: Lyn Elisa Goltz Date: Wed, 14 Dec 2022 21:24:04 +0100 Subject: [PATCH 2/4] #1102 (#8654) - add header with version if config option is set --- .../services/controller/OGCFrontController.java | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/deegree-services/deegree-services-commons/src/api/java/org/deegree/services/controller/OGCFrontController.java b/deegree-services/deegree-services-commons/src/api/java/org/deegree/services/controller/OGCFrontController.java index fba93823e7..6c1971f01a 100644 --- a/deegree-services/deegree-services-commons/src/api/java/org/deegree/services/controller/OGCFrontController.java +++ b/deegree-services/deegree-services-commons/src/api/java/org/deegree/services/controller/OGCFrontController.java @@ -194,6 +194,8 @@ public class OGCFrontController extends HttpServlet { private transient String version; + private boolean isReportDeegreeVersion = false; + /** * Returns the only instance of this class. * @@ -295,11 +297,13 @@ public static Collection getModulesInfo() { return getInstance().modulesInfo; } - private static void addHeaders( HttpServletResponse response ) { + private void addHeaders( HttpServletResponse response ) { // add cache control headers response.addHeader( "Cache-Control", "no-cache, no-store" ); // add deegree header - response.addHeader( "deegree-version", getInstance().version ); + if ( isReportDeegreeVersion ) { + response.addHeader( "deegree-version", getInstance().version ); + } } /** @@ -1110,6 +1114,9 @@ private void initWorkspace() serviceConfiguration = workspace.getNewWorkspace().getResourceManager( OwsManager.class ); OwsGlobalConfigLoader loader = workspace.getNewWorkspace().getInitializable( OwsGlobalConfigLoader.class ); mainConfig = loader.getMainConfig(); + if ( mainConfig != null && mainConfig.isReportDeegreeVersion() != null ) { + this.isReportDeegreeVersion = mainConfig.isReportDeegreeVersion(); + } if ( mainConfig != null ) { initHardcodedUrls( mainConfig ); } From 9a61ae8584cec49772800ade1753c0ba3b8e04e9 Mon Sep 17 00:00:00 2001 From: Lyn Elisa Goltz Date: Wed, 21 Dec 2022 13:42:08 +0100 Subject: [PATCH 3/4] #1102 (#8654) - renamed config param --- .../services/controller/OGCFrontController.java | 10 ++++------ .../schemas/services/controller/controller.xsd | 2 +- 2 files changed, 5 insertions(+), 7 deletions(-) diff --git a/deegree-services/deegree-services-commons/src/api/java/org/deegree/services/controller/OGCFrontController.java b/deegree-services/deegree-services-commons/src/api/java/org/deegree/services/controller/OGCFrontController.java index 6c1971f01a..be98ae1a9b 100644 --- a/deegree-services/deegree-services-commons/src/api/java/org/deegree/services/controller/OGCFrontController.java +++ b/deegree-services/deegree-services-commons/src/api/java/org/deegree/services/controller/OGCFrontController.java @@ -85,8 +85,6 @@ import org.apache.axiom.soap.SOAPEnvelope; import org.apache.axiom.soap.SOAPFactory; import org.apache.axiom.soap.impl.builder.StAXSOAPModelBuilder; -import org.apache.axiom.soap.impl.common.SOAP11Factory; -import org.apache.axiom.soap.impl.common.SOAP12Factory; import org.apache.commons.fileupload.FileItem; import org.apache.commons.fileupload.FileItemFactory; import org.apache.commons.fileupload.FileUploadException; @@ -194,7 +192,7 @@ public class OGCFrontController extends HttpServlet { private transient String version; - private boolean isReportDeegreeVersion = false; + private boolean addDeegreeVersionToHeader = false; /** * Returns the only instance of this class. @@ -301,7 +299,7 @@ private void addHeaders( HttpServletResponse response ) { // add cache control headers response.addHeader( "Cache-Control", "no-cache, no-store" ); // add deegree header - if ( isReportDeegreeVersion ) { + if ( addDeegreeVersionToHeader ) { response.addHeader( "deegree-version", getInstance().version ); } } @@ -1114,8 +1112,8 @@ private void initWorkspace() serviceConfiguration = workspace.getNewWorkspace().getResourceManager( OwsManager.class ); OwsGlobalConfigLoader loader = workspace.getNewWorkspace().getInitializable( OwsGlobalConfigLoader.class ); mainConfig = loader.getMainConfig(); - if ( mainConfig != null && mainConfig.isReportDeegreeVersion() != null ) { - this.isReportDeegreeVersion = mainConfig.isReportDeegreeVersion(); + if ( mainConfig != null && mainConfig.isAddDeegreeVersionToHeader() != null ) { + this.addDeegreeVersionToHeader = mainConfig.isAddDeegreeVersionToHeader(); } if ( mainConfig != null ) { initHardcodedUrls( mainConfig ); diff --git a/deegree-services/deegree-services-commons/src/main/resources/META-INF/schemas/services/controller/controller.xsd b/deegree-services/deegree-services-commons/src/main/resources/META-INF/schemas/services/controller/controller.xsd index 538329130c..3e28de0319 100644 --- a/deegree-services/deegree-services-commons/src/main/resources/META-INF/schemas/services/controller/controller.xsd +++ b/deegree-services/deegree-services-commons/src/main/resources/META-INF/schemas/services/controller/controller.xsd @@ -16,7 +16,7 @@ - + From bd2e61a93cebf6b49520941ebfe1e0f3f8ad019a Mon Sep 17 00:00:00 2001 From: Lyn Elisa Goltz Date: Wed, 21 Dec 2022 13:42:37 +0100 Subject: [PATCH 4/4] #1102 (#8654) - describe AddDeegreeVersionToHeader in handbook --- .../src/main/asciidoc/webservices.adoc | 2 ++ 1 file changed, 2 insertions(+) diff --git a/deegree-services/deegree-webservices-handbook/src/main/asciidoc/webservices.adoc b/deegree-services/deegree-webservices-handbook/src/main/asciidoc/webservices.adoc index a34ee64a2f..0a24ce37d9 100644 --- a/deegree-services/deegree-webservices-handbook/src/main/asciidoc/webservices.adoc +++ b/deegree-services/deegree-webservices-handbook/src/main/asciidoc/webservices.adoc @@ -2696,6 +2696,8 @@ specifiying them, their order must be respected. |ReportedUrls |0..1 |Complex |Hardcode reported URLs in service responses +|AddDeegreeVersionToHeader |0..1 |Boolean |Add header "deegree-version" to each response, default: false + |PreventClassloaderLeaks |0..1 |Boolean |TODO |RequestLogging |0..1 |Complex |TODO