Java API Documentation

[robmoffat]

This pull request introduces significant updates to the WebSocket Connection Protocol (WSCP) and enhances the API documentation, particularly by adding Java language bindings. The main changes include a refactor of the WSCP handshake to use role-specific connect messages, the addition of new JSON schema files for WSCP message types, and comprehensive Java examples and interface details in the Channel API reference.

WebSocket Connection Protocol (WSCP) Refactor and Schema Additions:

• Refactored the WSCP handshake to use role-specific connect messages, where the TCP initiator sends the sharedSecret and the acceptor does not echo it. The assigned app identity is now carried in implementationMetadata.appMetadata.
• Added new JSON schema files for WSCP message types: WSCPApplicationConnect, WSCPDesktopAgentConnect, WSCPConnectFailed, WSCPGoodbye, and the shared WSCPConnectionStep schema. These define the structure and requirements for each protocol message, improving clarity and interoperability. [1] [2] [3] [4] [5]

API Documentation Enhancements:

• Added Java language binding documentation to the API reference, including detailed interface definitions, method signatures, and usage examples for the Channel API. This improves accessibility for Java developers and ensures parity with other supported languages. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11] [12] [13] [14] [15] [16] [17] [18] [19]

[robmoffat]

/netlify

[robmoffat]

@kemerava @bingenito please see @kriswest 's comment #1734 (comment) talking about a Web Socket Connection Protocol, which I've attempted an implementation of here.

I've also implemented this in the fdc3-java-api (finos-labs/fdc3-java-api#7) + Sail project.(tbd) to demonstrate the functionality.

[robmoffat]

Improved WSCP based on @SeeWhatsOn and @kriswest 's review.

• One message type for the DA, one for the App.
• No separate reconnection approach - uses same approach for connect and reconnect
• sharedSecret implicitly uniquely identifies the session between the app and the user.

[codecov-commenter]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 96.18%. Comparing base (f482fa9) to head (37b36be).
⚠️ Report is 1 commits behind head on security-documentation-rebase2.

Additional details and impacted files

@@                       Coverage Diff                        @@
##           security-documentation-rebase2    #1912    +/-   ##
================================================================
  Coverage                           96.18%   96.18%            
================================================================
  Files                                  83       83            
  Lines                                6320     6320            
  Branches                              970      843   -127     
================================================================
  Hits                                 6079     6079            
  Misses                                241      241            

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[kriswest]

@robmoffat I think this auto-closed when the target branch was merged. You may need to edit the base and reopen

[kriswest]

Also are you bringing in another repo for adoption as fdc3-java with code to use teh WSCP?

[robmoffat]

Weird. Ok, I've created: #1941

This is the PR for the protocol support in the FDC3 Java API project: finos-labs/fdc3-java-api#7

My plan was to get this migrated to FINOS once we're ready to merge the first one.