Update Jakarta RESTful Web Services sections for Jakarta EE 10

[kito99]

Recommended approach:

• Add a section at the end that describes the new Java SE Bootstrap feature in the Building RESTful Web Services with Jakarta REST chapter (https://jakarta.ee/learn/docs/jakartaee-tutorial/current/websvcs/jaxrs/jaxrs.html; src/main/antora/modules/websvcs/pages/jaxrs/jaxrs.adoc). Use either the example in the article below or an example from here.
  • BONUS: Create a new example derived from the ones mentioned above in the [examples repo] (https://github.com/eclipse-ee4j/jakartaee-examples/tree/main/focused/rest) and use that instead (please submit a PR to that repo with the example). This repo that has specific, simple examples, and is where future tutorial examples will go. See https://jakarta.ee/learn/docs/jakartaee-tutorial/current/security/security.html for examples of this approach (all of these examples are new).
• Add a CAUTION admonition that explains that @Context has been deprecated and you can use CDI instead. I believe you can use @Inject instead in all cases but I'd prefer that someone verify that before adding it to the text. See: https://jakarta.ee/specifications/restful-ws/3.1/jakarta-restful-ws-spec-3.1#context-injection.
• Update links in the "Further Information about Jakarta REST" section (https://jakarta.ee/learn/docs/jakartaee-tutorial/current/websvcs/jaxrs/jaxrs.html#_configuring_jakarta_rest_applications; src/main/antora/modules/websvcs/pages/jaxrs/jaxrs003.adoc)
  • Update the spec URL to point to the Jakarta REST 3.1: https://jakarta.ee/specifications/restful-ws/3.1/jakarta-restful-ws-spec-3.1.
  • Remove the book reference

I'm not sure we need to say anything about multi-part requests, but if folks feel differently, we can add a new section for that with an example just like the Java SE example above.

References:

• Jakarta RESTful Web Services 3.1 Release page
• Spec
• Article describing new features

NOTE: Going forward, please give new sections meaningful names (i.e. jaxrs-se-bootstrap.adoc instead of jaxrs005.adoc).

[kito99]

...

[kito99]

@spericas please take a look and let me know (a) if this sounds correct, and (b) if you or someone on the committer team would like to contribute. Thanks!

[spericas]

@kito99 You cannot use @Inject as a replacement for @Context in all cases. There may be some implementations that support this in some cases, but for example, @Context can be used in parameter position. Regarding contributions, perhaps you ask for help on the Jakarta REST list.

[kito99]

thanks, @spericas! With respect to @Context, what is the CDI replacement in cases where @Inject doesn't work?

I'll definitely contact the mailing list.

[spericas]

thanks, @spericas! With respect to @Context, what is the CDI replacement in cases where @Inject doesn't work?

I'll definitely contact the mailing list.

For 4.0, we expect to support parameter injection directly, without the use of any special annotation. For that purpose, we plan to introduce a new @Body annotation to identify the request entity (currently identified by having no Jakarta REST annotations).

[kito99]

@spericas ok, so it sounds like perhaps adding a warning admonition now might cause more confusion than necessary and people should just continue to use @Context for now?

[omniprof]

I just completed creating a workshop on REST 3.1 for the Eclipse Foundation. Ivar gave the workshop for the first time at EclipseCon last month and he and I will be giving it at Devnexus this April. In the workshop we look at SeBootstrap so possibly I could contribute some info on this topic to the tutorial.

[kito99]

Hey Ken, that would be awesome. This ticket outlines what I had in mind (short intro and example) but we’re flexible: https://github.com/jakartaee/jakartaee-tutorial/issues/86.

[omniprof]

I will review the ticket later today.

[kito99]

@omniprof have you had a chance to review yet?

[omniprof]

Sorry about running later than expected. Looking at it now.

[omniprof]

I just sent you, via Email, my tutorial on SeBootstrap. If this meets the needs of the Tutorial then I can move on and do the MultiPart tutorial.