Document: Jakarta EE 11: Support Jakarta WebSocket 2.2

[volosied]

OpenLiberty/open-liberty#25088

---

Differences between Jakarta WebSocket 2.2 and 2.1

As 2.2 is a minor release, it only offers incremental improvements.

New Additions:

• The getSession method has been added to the jakarta.websocket.SendResult class. This allows futures to acquire the associated websocket session easily.

• The @OnMessage.maxMessageSize annotation cannot be set to a value higher than Integer.MAX_VALUE (2 Gigabytes, in practice) due to type conflict between the annotation (long) and the Session.setMaxTextMessageBufferSize method (int).

Specification Clarification:

• Automated ping / pong notifications will be an implementation responsibility, not the APIs. As there have been no feature requests, no changes have been made in Liberty.

Removals:

• All SecurityManager references within the API have been removed to align with the newer JDKs.

[ramkumar-k-9286]

Hi @volosied

The suggested information has been added to the differences page.

Draft link: https://docs-draft-openlibertyio.mqj6zf7jocq.us-south.codeengine.appdomain.cloud/docs/latest/reference/diff/jakarta-ee11-diff.html#websocket

Please review the same and let me know if you are ok with the content or if we need to add more information in the section.

If that is the case, please explain what changes need to be made ( in this issue), so that those changes can be made.

Regards,
Ramkumar.

[pnicolucci]

@ramkumar-k-9286 this looks good to me. @volosied any comments?

[volosied]

I would use parentheses for Session.setMaxTextMessageBufferSize().

Other than that, it's good.

[ramkumar-k-9286]

Hi @volosied

I had to do some re-work in the differences page. content-wise as well.

Could you have a look at the draft again.

Draft link: https://docs-draft-openlibertyio.mqj6zf7jocq.us-south.codeengine.appdomain.cloud/docs/latest/reference/diff/jakarta-ee11-diff.html#websocket

Please review the same and let me know if you are ok with the content or if we need to add more information in the section.

If that is the case, please explain what changes need to be made ( in this issue), so that those changes can be made.

Please add Developer Reviewed label if you are satisfied with the changes.

Regards,
Ramkumar.

[volosied]

Should there be a bullet under new Additions, like so?

getSession() method

• A new getSession() method is added to the jakarta.websocket.SendResult class. This allows futures to acquire the associated WebSocket session easily.

@OnMessage.maxMessageSize clarification

• The @OnMessage.maxMessageSize attribute cannot be set to a value higher than Integer.MAX_VALUE (approximately 2 GB). This limitation occurs because the annotation uses a long type, while Session.setMaxTextMessageBufferSize() accepts an int.

For Ping and Pong notifications, maybe we should add an extra sentence?

Automated ping and pong notifications are clarified as an implementation responsibility rather than an API function. No changes were made in Open Liberty. If different behavior is desired, users may submit an Aha! idea for consideration.

[ramkumar-k-9286]

Hi @volosied

Suggested updates done.

Draft link: https://docs-draft-openlibertyio.mqj6zf7jocq.us-south.codeengine.appdomain.cloud/docs/latest/reference/diff/jakarta-ee11-diff.html#websocket

Please add Developer Reviewed label if you are satisfied with the changes.

Regards,
Ramkumar.