[Java] internal config option to use jakarta or javax package #14310

borsch · 2022-12-21T14:11:44Z

Internal option to control whether javax or jakarta package should be used. This option will allow much easier transition to never version of dependencies with jakarta support.

Example - #14276 rest-template to be migrated to jakarta while other libraries might still use javax packages in common templates

PR checklist

Read the contribution guidelines.
Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
Run the following to build the project and update samples:
```
./mvnw clean package 
./bin/generate-samples.sh
./bin/utils/export_docs_generators.sh
```
Commit all changed files.
This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
These must match the expectations made by your contribution.
You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
For Windows users, please run the script in Git BASH.
File the PR against the correct branch: master (6.3.0) (minor release - breaking changes with fallbacks), 7.0.x (breaking changes without fallbacks)
If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

Java	@bbdouglas (2017/07) @sreeshas (2017/08) @jfiala (2017/08) @lukoyanov (2017/09) @cbornet (2017/09) @jeff9finger (2018/01) @karismann (2019/03) @Zomzog (2019/04) @lwlee2608 (2019/10)
Java Spring	@cachescrubber (2022/02) @welshm (2022/02) @MelleD (2022/02) @atextor (2022/02) @manedev79 (2022/02) @javisst (2022/02) @borsch (2022/02) @banlevente (2022/02) @Zomzog (2022/09)

cachescrubber · 2022-12-22T07:41:58Z

...es/openapi-generator/src/main/java/org/openapitools/codegen/languages/JavaClientCodegen.java

@@ -576,7 +576,8 @@ public void processOpts() {
            // The flag below should be set for all Java libraries, but the templates need to be ported
            // one by one for each library.
            supportsAdditionalPropertiesWithComposedSchema = true;
-
+            setUseJakartaEe(true);


What is the plan to expose the option to users via the cli? SpringCodegen has the useSpringBoot3 indirection, which triggers the use of Jakarta EE.

as for now this would be internal config option. later I want to use this config for changes like this one - #14276

rest-template to be migrated to spring 6 which means jakarta should be used, but on the other hand rest-template shares common model.mustache with other libraries which still should use javax package.

that's the reason why this config option is internal - developer of library's template is aware whether javax or jakarta package to be used

Ok, got it. But the default should then be false setUseJakartaEe(false), otherwise this PR would activate jakarta EE for all JavaClientCodegen implementations.

ahhh. got you question) expand this part of code and you will notice that this is only for jersey 3 which already use jakarta package. by default this option is set to false (i.e. we are using javax package)

cachescrubber · 2022-12-22T07:44:07Z

@borsch Thanks for applying this to all Java based Codegen implementation. LGTM.

welshm

Some of the mustaches probably could have been left as-is if they can't support Jakarta anyway, but it doesn't hurt to have the configuration

welshm · 2022-12-23T18:25:19Z

...es/openapi-generator/src/main/java/org/openapitools/codegen/languages/JavaClientCodegen.java

@@ -576,7 +576,8 @@ public void processOpts() {
            // The flag below should be set for all Java libraries, but the templates need to be ported
            // one by one for each library.
            supportsAdditionalPropertiesWithComposedSchema = true;
-
+            setUseJakartaEe(true);
+            applyJavaxPackage();


Hmm... if you did setUseJakartaEe() before the super call, then you wouldn't also need to call applyJavaxPackage(). But then you'd need to duplicate the if statement logic... maybe just some documentation?

// When using `setJakertaEe()` you should also call `applyJavaxPackage()` to capture the property value.

@welshm I've slightly changed approach, please review one more time

borsch · 2022-12-30T08:54:15Z

@wing328 could you please merge this one? This will allow easier update to Spring 6 for some libraries

wing328 · 2022-12-30T14:33:01Z

modules/openapi-generator/src/main/java/org/openapitools/codegen/DefaultCodegen.java

@@ -6455,7 +6455,7 @@ public boolean convertPropertyToBoolean(String propertyKey) {
        return result;
    }

-    public void writePropertyBack(String propertyKey, boolean value) {
+    public void writePropertyBack(String propertyKey, Object value) {


FYI @OpenAPITools/generator-core-team

parenko · 2022-12-30T21:19:20Z

modules/openapi-generator/src/main/resources/Java/libraries/jersey2/ApiClient.mustache

@@ -27,9 +27,9 @@ import java.io.IOException;
 import java.io.InputStream;

 import java.net.URI;
-import javax.net.ssl.SSLContext;


javax.net.ssl package ist unaffected by Jakarta EE.
This change should be reverted.

thanks for spotting. I've create PR for fix this #14341

borsch force-pushed the use-jakarta-package branch from 378fe94 to a2f8e66 Compare December 21, 2022 17:13

borsch marked this pull request as ready for review December 21, 2022 17:17

cachescrubber reviewed Dec 22, 2022

View reviewed changes

borsch mentioned this pull request Dec 22, 2022

[Java][Spring] config option to use Jakarta EE package #14272

Closed

5 tasks

welshm approved these changes Dec 23, 2022

View reviewed changes

[Java] configurable Javax/Jakarta package

94038f3

borsch force-pushed the use-jakarta-package branch from a2f8e66 to 94038f3 Compare December 23, 2022 21:46

wing328 reviewed Dec 30, 2022

View reviewed changes

wing328 merged commit 7c587ce into OpenAPITools:master Dec 30, 2022

parenko reviewed Dec 30, 2022

View reviewed changes

borsch mentioned this pull request Dec 31, 2022

[Java][Jersey2] revert configurable javax package for javax.net #14341

Merged

5 tasks

wing328 added this to the 6.3.0 milestone Jan 20, 2023

parenko mentioned this pull request Jan 25, 2023

[Kotlin-Spring] support to Spring boot3 & jakarta extension #14369

Merged

5 tasks

thmue mentioned this pull request Feb 17, 2023

[Java][jaxrs-spec] Add option to use jakarta imports / namespace #13593

Closed

5 tasks

jpfinne mentioned this pull request May 22, 2024

[BUG][JAVA] optional collection fields are initialized since 7.5.0 #18735

Open

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Java] internal config option to use jakarta or javax package #14310

[Java] internal config option to use jakarta or javax package #14310

borsch commented Dec 21, 2022 •

edited

Loading

cachescrubber Dec 22, 2022

borsch Dec 22, 2022

cachescrubber Dec 22, 2022

borsch Dec 22, 2022

cachescrubber commented Dec 22, 2022

welshm left a comment

welshm Dec 23, 2022

borsch Dec 23, 2022

borsch commented Dec 30, 2022 •

edited

Loading

wing328 Dec 30, 2022

parenko Dec 30, 2022

borsch Dec 31, 2022

[Java] internal config option to use jakarta or javax package #14310

[Java] internal config option to use jakarta or javax package #14310

Conversation

borsch commented Dec 21, 2022 • edited Loading

PR checklist

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cachescrubber commented Dec 22, 2022

welshm left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

borsch commented Dec 30, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

borsch commented Dec 21, 2022 •

edited

Loading

borsch commented Dec 30, 2022 •

edited

Loading