Skip to content

adjust jersey2/jersey3 templates #21171

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Apr 29, 2025

Conversation

martin-mfg
Copy link
Contributor

Make jersey2 and jersey3 templates as similar to each other as possible. As requested by @wing328.

Jersey 3 doesn't work with useJakartaEe=false. And Jersey 2 doesn't work with useJakartaEe=true.
Jersey 2 is hard-wired to the javax namespace. See e.g. the Jersey 2 class ClientConfig - it implements javax.ws.rs.core.Configurable<ClientConfig> and javax.ws.rs.core.Configuration, but nothing from the jakarta namespace. And vice versa for Jersey 3. You can verify the problem by generating something with library=jersey2 and useJakartaEe=true - the output won't compile due to incompatible types.
It's still beneficial to make the Jersey 2 and Jersey 3 templates as similar as possible, for maintainability. I also added a warning when using useJakartaEe=true with Jersey 2.

Now the only remaining differences between Jersey 2 and Jersey 3 are dependency versions:

$ diff -r modules/openapi-generator/src/main/resources/Java/libraries/jersey2 modules/openapi-generator/src/main/resources/Java/libraries/jersey3
diff -r modules/openapi-generator/src/main/resources/Java/libraries/jersey2/build.gradle.mustache modules/openapi-generator/src/main/resources/Java/libraries/jersey3/build.gradle.mustache
107c107
<     jakarta_annotation_version = "1.3.5"
---
>     jakarta_annotation_version = "2.1.0"
111c111
<     jersey_version = "2.35"
---
>     jersey_version = "3.0.4"
diff -r modules/openapi-generator/src/main/resources/Java/libraries/jersey2/build.sbt.mustache modules/openapi-generator/src/main/resources/Java/libraries/jersey3/build.sbt.mustache
14,18c14,18
<       "org.glassfish.jersey.core" % "jersey-client" % "2.35",
<       "org.glassfish.jersey.inject" % "jersey-hk2" % "2.35",
<       "org.glassfish.jersey.media" % "jersey-media-multipart" % "2.35",
<       "org.glassfish.jersey.media" % "jersey-media-json-jackson" % "2.35",
<       "org.glassfish.jersey.connectors" % "jersey-apache-connector" % "2.35",
---
>       "org.glassfish.jersey.core" % "jersey-client" % "3.0.4",
>       "org.glassfish.jersey.inject" % "jersey-hk2" % "3.0.4",
>       "org.glassfish.jersey.media" % "jersey-media-multipart" % "3.0.4",
>       "org.glassfish.jersey.media" % "jersey-media-json-jackson" % "3.0.4",
>       "org.glassfish.jersey.connectors" % "jersey-apache-connector" % "3.0.4",
35c35
<       "jakarta.annotation" % "jakarta.annotation-api" % "1.3.5" % "compile",
---
>       "jakarta.annotation" % "jakarta.annotation-api" % "2.1.0" % "compile",
Only in modules/openapi-generator/src/main/resources/Java/libraries/jersey3: generatedAnnotation.mustache
diff -r modules/openapi-generator/src/main/resources/Java/libraries/jersey2/pom.mustache modules/openapi-generator/src/main/resources/Java/libraries/jersey3/pom.mustache
407c407
<         <jersey-version>2.37</jersey-version>
---
>         <jersey-version>3.1.1</jersey-version>

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 || exit
    ./bin/generate-samples.sh ./bin/configs/*.yaml || exit
    ./bin/utils/export_docs_generators.sh || exit
    
    (For Windows users, please run the script in Git BASH)
    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*.
    IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
  • File the PR against the correct branch: master (upcoming 7.x.0 minor release - breaking changes with fallbacks), 8.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.
    @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) @martin-mfg (2023/08)

@wing328
Copy link
Member

wing328 commented Apr 29, 2025

nice 👍

let's give it a try

@wing328 wing328 merged commit 9a289e9 into OpenAPITools:master Apr 29, 2025
71 checks passed
@wing328 wing328 added Client: Java Enhancement: Code Cleanup General refactoring, removal of deprecated things, commenting, etc. labels Apr 29, 2025
@wing328 wing328 added this to the 7.14.0 milestone Jun 19, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Client: Java Enhancement: Code Cleanup General refactoring, removal of deprecated things, commenting, etc.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants