From dbb3c890d4db0bf7f5a0efce7ed6d40fd8f390ed Mon Sep 17 00:00:00 2001 From: Ron Sigal Date: Tue, 12 Nov 2019 15:17:28 -0500 Subject: [PATCH 1/7] [wFLY-12779] Incorporate MicroProfile Config in RESTEasy --- ...-12779_Use-MicroProfile-Config-in-RESTEasy | 77 +++++++++++++++++++ 1 file changed, 77 insertions(+) create mode 100644 jaxrs/WFLY-12779_Use-MicroProfile-Config-in-RESTEasy diff --git a/jaxrs/WFLY-12779_Use-MicroProfile-Config-in-RESTEasy b/jaxrs/WFLY-12779_Use-MicroProfile-Config-in-RESTEasy new file mode 100644 index 000000000..98bd637f6 --- /dev/null +++ b/jaxrs/WFLY-12779_Use-MicroProfile-Config-in-RESTEasy @@ -0,0 +1,77 @@ += Use MicroProfile Config in RESTEasy +:author: Ron Sigal +:email: rsigal@redhat.com +:toc: left +:icons: font +:idprefix: +:idseparator: - + +== Overview + +Currently, RESTEasy 3.x (targeted to Wildfly) uses servlet context-params to obtain +configuration information. In RESTEasy 4.x, we have updated configuration to access +all standard MicroProfile Config sources. Also, we have added three additional ConfigSources: + +* servlet init-params [ordinal 60] +* filter init-params [ordinal 50] +* servlet context-params [ordinal 40] + +In RESTEasy 4.x, all parameters, both RESTEasy parameters and application parameters, are +available from all ConfigSources to both RESTEasy and application code. In RESTEasy 3.x, we +propose to add a RESTEasy parameter, "resteasy.config.resteasy.parameters.only", which, when +set to "true", will limit the three RESTEasy ConfigSources to returning RESTEasy parameters +only. It will default to "true". + +== Issue Metadata + +=== Issue + +* {issue-base-url}/EAP7-??? [EAP7-???] +* {issue-base-url}/WFLY-12779 [WFLY-12779] + +=== Related Issues + +* {issue-base-url}/RESTEASY-2406 [RESTEASY-2406] + +=== Dev Contacts + +* mailto:rsigal@redhat.com[Ron Sigal] +* mailto:asoldano@redhat.com[Alessio Soldano] + +=== QE Contacts + +* ?? + +=== Testing By + +[x] Engineering + +[ ] QE + +=== Affected Projects or Components + +* RESTEasy, Wildfly + +=== Other Interested Projects + +https://github.com/smallrye/smallrye-config + +== Requirements + +=== Hard Requirements + +* Update RESTEasy to retrieve all configuration parameters from MicroProfile ConfigSources. +* Add to RESTEasy three ConfigSources for servlet context-params, servlet init-params, and filter + init-params. +* Add to RESTEasy a parameter, "resteasy.config.resteasy.parameters.only", which, when set to + "true", will restrict RESTEasy specific ConfigSources to returning RESTEasy parameters. + +== Test Plan + +Tests already exist in the RESTEasy codebase for RESTEasy 4.x These can be ported to +RESTEasy 3.x. + +== Community Documentation + +The RESTEasy 4.x user guide discusses the use of MicroProfile in JAX-RS applications. That +material can be re-used. From 13888c58899f2079fc3e171137236feac6f670cb Mon Sep 17 00:00:00 2001 From: Ron Sigal Date: Tue, 12 Nov 2019 17:30:10 -0500 Subject: [PATCH 2/7] Update WFLY-12779_Use-MicroProfile-Config-in-RESTEasy --- jaxrs/WFLY-12779_Use-MicroProfile-Config-in-RESTEasy | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/jaxrs/WFLY-12779_Use-MicroProfile-Config-in-RESTEasy b/jaxrs/WFLY-12779_Use-MicroProfile-Config-in-RESTEasy index 98bd637f6..e2334bf33 100644 --- a/jaxrs/WFLY-12779_Use-MicroProfile-Config-in-RESTEasy +++ b/jaxrs/WFLY-12779_Use-MicroProfile-Config-in-RESTEasy @@ -26,7 +26,7 @@ only. It will default to "true". === Issue -* {issue-base-url}/EAP7-??? [EAP7-???] +* {issue-base-url}/EAP7-1386 [EAP7-1386] * {issue-base-url}/WFLY-12779 [WFLY-12779] === Related Issues From a6b5da106da3035f9725d714502a70e288828b3c Mon Sep 17 00:00:00 2001 From: Ron Sigal Date: Sat, 18 Apr 2020 19:10:48 -0400 Subject: [PATCH 3/7] Update WFLY-12779_Use-MicroProfile-Config-in-RESTEasy 1. Removed reference to "resteasy.config.resteasy.parameters.only" 2. Moved testing to QE --- jaxrs/WFLY-12779_Use-MicroProfile-Config-in-RESTEasy | 11 ++++------- 1 file changed, 4 insertions(+), 7 deletions(-) diff --git a/jaxrs/WFLY-12779_Use-MicroProfile-Config-in-RESTEasy b/jaxrs/WFLY-12779_Use-MicroProfile-Config-in-RESTEasy index e2334bf33..2d2c74ca2 100644 --- a/jaxrs/WFLY-12779_Use-MicroProfile-Config-in-RESTEasy +++ b/jaxrs/WFLY-12779_Use-MicroProfile-Config-in-RESTEasy @@ -16,11 +16,8 @@ all standard MicroProfile Config sources. Also, we have added three additional C * filter init-params [ordinal 50] * servlet context-params [ordinal 40] -In RESTEasy 4.x, all parameters, both RESTEasy parameters and application parameters, are -available from all ConfigSources to both RESTEasy and application code. In RESTEasy 3.x, we -propose to add a RESTEasy parameter, "resteasy.config.resteasy.parameters.only", which, when -set to "true", will limit the three RESTEasy ConfigSources to returning RESTEasy parameters -only. It will default to "true". +All parameters, both RESTEasy parameters and application parameters, are +available from all ConfigSources to both RESTEasy and application code. == Issue Metadata @@ -44,9 +41,9 @@ only. It will default to "true". === Testing By -[x] Engineering +[ ] Engineering -[ ] QE +[x] QE === Affected Projects or Components From 94f0a02001840bb725ca8aa9c69befb88aa08280 Mon Sep 17 00:00:00 2001 From: Ron Sigal Date: Thu, 23 Apr 2020 15:20:40 -0400 Subject: [PATCH 4/7] [WFLY-12779] Various amendments. --- jaxrs/WFLY-12779_Use-MicroProfile-Config-in-RESTEasy | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/jaxrs/WFLY-12779_Use-MicroProfile-Config-in-RESTEasy b/jaxrs/WFLY-12779_Use-MicroProfile-Config-in-RESTEasy index 2d2c74ca2..cc19433e5 100644 --- a/jaxrs/WFLY-12779_Use-MicroProfile-Config-in-RESTEasy +++ b/jaxrs/WFLY-12779_Use-MicroProfile-Config-in-RESTEasy @@ -19,6 +19,9 @@ all standard MicroProfile Config sources. Also, we have added three additional C All parameters, both RESTEasy parameters and application parameters, are available from all ConfigSources to both RESTEasy and application code. +Since this feature will depend on the MicroProfile Config project, it will be +included in Wildfly by way of the MicroProfile Extension Pack. + == Issue Metadata === Issue @@ -37,7 +40,7 @@ available from all ConfigSources to both RESTEasy and application code. === QE Contacts -* ?? +* Petr Kremensky === Testing By @@ -58,10 +61,9 @@ https://github.com/smallrye/smallrye-config === Hard Requirements * Update RESTEasy to retrieve all configuration parameters from MicroProfile ConfigSources. -* Add to RESTEasy three ConfigSources for servlet context-params, servlet init-params, and filter - init-params. -* Add to RESTEasy a parameter, "resteasy.config.resteasy.parameters.only", which, when set to - "true", will restrict RESTEasy specific ConfigSources to returning RESTEasy parameters. +* Add to RESTEasy a new module, resteasy-microprofile-config, with three ConfigSources for + servlet context-params, servlet init-params, and filter init-params. +* Configure Wildfly with an optional dependency on resteasy-microprofile-config. == Test Plan From 705ccd05f5ba35c6b8e72e19805ea9e35f245bcd Mon Sep 17 00:00:00 2001 From: Ron Sigal Date: Thu, 30 Apr 2020 19:00:59 -0400 Subject: [PATCH 5/7] [WFLY-12779] Some amendments. --- ...9_Use-MicroProfile-Config-in-RESTEasy.adoc | 82 +++++++++++++++++++ 1 file changed, 82 insertions(+) create mode 100644 jaxrs/proposals/WFLY-12779_Use-MicroProfile-Config-in-RESTEasy.adoc diff --git a/jaxrs/proposals/WFLY-12779_Use-MicroProfile-Config-in-RESTEasy.adoc b/jaxrs/proposals/WFLY-12779_Use-MicroProfile-Config-in-RESTEasy.adoc new file mode 100644 index 000000000..7059fe3c8 --- /dev/null +++ b/jaxrs/proposals/WFLY-12779_Use-MicroProfile-Config-in-RESTEasy.adoc @@ -0,0 +1,82 @@ += Use MicroProfile Config in RESTEasy +:author: Ron Sigal +:email: rsigal@redhat.com +:toc: left +:icons: font +:idprefix: +:idseparator: - + +== Overview + +Currently, RESTEasy 3.x (targeted to Wildfly) mostly uses servlet context-params and +init-params to obtain configuration information. In RESTEasy 4.x, we have updated configuration +to access all standard MicroProfile Config sources. Also, we have added three additional ConfigSources: + +* servlet init-params [ordinal 60] +* filter init-params [ordinal 50] +* servlet context-params [ordinal 40] + +All parameters, both RESTEasy parameters and application parameters, are +available from all ConfigSources to both RESTEasy and application code. + +In this feature, we propose to port the same use of MicroProfile Config to Resteasy 3.x. + +This feature will depend on the MicroProfile Config project, which will be +included in Wildfly by way of the MicroProfile Extension Pack. It follows that +MicroProfile Config may or may not be available, and therefore Resteasy will have to +be able to access configuration parameters with or without MicroProfile Config. + +== Issue Metadata + +=== Issue + +* {issue-base-url}/EAP7-1386 [EAP7-1386] +* {issue-base-url}/WFLY-12779 [WFLY-12779] + +=== Related Issues + +* {issue-base-url}/RESTEASY-2406 [RESTEASY-2406] + +=== Dev Contacts + +* mailto:rsigal@redhat.com[Ron Sigal] +* mailto:asoldano@redhat.com[Alessio Soldano] + +=== QE Contacts + +* Petr Kremensky + +=== Testing By + +[ ] Engineering + +[x] QE + +=== Affected Projects or Components + +* RESTEasy, Wildfly + +=== Other Interested Projects + +https://github.com/smallrye/smallrye-config + +== Requirements + +=== Hard Requirements + +* RESTEasy must be able to retrieve configuration parameters whether or not MicroProfile + Config is available. +* If MicroProfile Config is available, RESTEasy will retrieve all configuration parameters + from MicroProfile ConfigSources. +* If MicroProfile Config is not available, RESTEasy will preserve its current behavior. + +== Test Plan + +Tests already exist in the RESTEasy codebase for RESTEasy 4.x These can be ported to +RESTEasy 3.x. Tests to verify that RESTEasy continues to work in the absence of +MicroProfile Config will need to be added. + +== Community Documentation + +The RESTEasy 4.x user guide discusses the use of MicroProfile in JAX-RS applications. That +material can be adapted. From 3bcdbfa141814af249c8f914efb4bbc8120adc36 Mon Sep 17 00:00:00 2001 From: Ron Sigal Date: Thu, 30 Apr 2020 19:06:30 -0400 Subject: [PATCH 6/7] [WFLY-12779] Renamed file with .adoc suffix. --- .../WFLY-12779_Use-MicroProfile-Config-in-RESTEasy.adoc | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename jaxrs/{proposals => }/WFLY-12779_Use-MicroProfile-Config-in-RESTEasy.adoc (100%) diff --git a/jaxrs/proposals/WFLY-12779_Use-MicroProfile-Config-in-RESTEasy.adoc b/jaxrs/WFLY-12779_Use-MicroProfile-Config-in-RESTEasy.adoc similarity index 100% rename from jaxrs/proposals/WFLY-12779_Use-MicroProfile-Config-in-RESTEasy.adoc rename to jaxrs/WFLY-12779_Use-MicroProfile-Config-in-RESTEasy.adoc From 9de75d8b9354c05165e6a5fde8a94ff0d65319d7 Mon Sep 17 00:00:00 2001 From: Ron Sigal Date: Thu, 30 Apr 2020 19:12:32 -0400 Subject: [PATCH 7/7] [WFLY-12779] Deleted WFLY-12779_Use-MicroProfile-Config-in-RESTEasy [without .adoc suffix] --- ...-12779_Use-MicroProfile-Config-in-RESTEasy | 76 ------------------- 1 file changed, 76 deletions(-) delete mode 100644 jaxrs/WFLY-12779_Use-MicroProfile-Config-in-RESTEasy diff --git a/jaxrs/WFLY-12779_Use-MicroProfile-Config-in-RESTEasy b/jaxrs/WFLY-12779_Use-MicroProfile-Config-in-RESTEasy deleted file mode 100644 index cc19433e5..000000000 --- a/jaxrs/WFLY-12779_Use-MicroProfile-Config-in-RESTEasy +++ /dev/null @@ -1,76 +0,0 @@ -= Use MicroProfile Config in RESTEasy -:author: Ron Sigal -:email: rsigal@redhat.com -:toc: left -:icons: font -:idprefix: -:idseparator: - - -== Overview - -Currently, RESTEasy 3.x (targeted to Wildfly) uses servlet context-params to obtain -configuration information. In RESTEasy 4.x, we have updated configuration to access -all standard MicroProfile Config sources. Also, we have added three additional ConfigSources: - -* servlet init-params [ordinal 60] -* filter init-params [ordinal 50] -* servlet context-params [ordinal 40] - -All parameters, both RESTEasy parameters and application parameters, are -available from all ConfigSources to both RESTEasy and application code. - -Since this feature will depend on the MicroProfile Config project, it will be -included in Wildfly by way of the MicroProfile Extension Pack. - -== Issue Metadata - -=== Issue - -* {issue-base-url}/EAP7-1386 [EAP7-1386] -* {issue-base-url}/WFLY-12779 [WFLY-12779] - -=== Related Issues - -* {issue-base-url}/RESTEASY-2406 [RESTEASY-2406] - -=== Dev Contacts - -* mailto:rsigal@redhat.com[Ron Sigal] -* mailto:asoldano@redhat.com[Alessio Soldano] - -=== QE Contacts - -* Petr Kremensky - -=== Testing By - -[ ] Engineering - -[x] QE - -=== Affected Projects or Components - -* RESTEasy, Wildfly - -=== Other Interested Projects - -https://github.com/smallrye/smallrye-config - -== Requirements - -=== Hard Requirements - -* Update RESTEasy to retrieve all configuration parameters from MicroProfile ConfigSources. -* Add to RESTEasy a new module, resteasy-microprofile-config, with three ConfigSources for - servlet context-params, servlet init-params, and filter init-params. -* Configure Wildfly with an optional dependency on resteasy-microprofile-config. - -== Test Plan - -Tests already exist in the RESTEasy codebase for RESTEasy 4.x These can be ported to -RESTEasy 3.x. - -== Community Documentation - -The RESTEasy 4.x user guide discusses the use of MicroProfile in JAX-RS applications. That -material can be re-used.