Java docs and security - #1941
Conversation
…urrentContextWithMetadata function
… release instructions for new workflow
…ormance test implementation for metadata
…mance test execution
…signatures in metadata
✅ Deploy Preview for fdc3 ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
From the old PR:
|
|
Needs rebasing against main - currently sucking all the commits from fdc3-metadata and fdc3-security PRs and creating conflicts |
|
Ok, rebased. @kemerava could you review please? (Ideally, at some stage we should implement a go binding for WSCP. ) |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1941 +/- ##
=======================================
Coverage 95.32% 95.32%
=======================================
Files 85 85
Lines 6690 6690
Branches 932 1028 +96
=======================================
Hits 6377 6377
Misses 313 313 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
kemerava
left a comment
There was a problem hiding this comment.
Looks good, @robmoffat, a few small suggestions
|
|
||
| ```java | ||
| // desktop-agent scope context listener | ||
| Listener fdc3Listener = desktopAgent.addContextListener(null, (context, metadata) -> {}).toCompletableFuture().get(); |
There was a problem hiding this comment.
Just suggesting this for consistency with other examples
| Listener fdc3Listener = desktopAgent.addContextListener(null, (context, metadata) -> {}).toCompletableFuture().get(); | |
| Listener fdc3Listener = desktopAgent.addContextListener(null, (context, metadata) -> { ... }).toCompletableFuture().get(); |
|
|
||
| ```java | ||
| // Open an app without context, using an AppIdentifier object to specify the target | ||
| AppIdentifier appIdentifier = new AppIdentifier("myApp-v1.0.1"); |
There was a problem hiding this comment.
Another small suggestion - we were encouraging the fully qualified appId, so might make sense to have it here
| AppIdentifier appIdentifier = new AppIdentifier("myApp-v1.0.1"); | |
| AppIdentifier appIdentifier = new AppIdentifier("MyAppId@my.appd.com"); |
| <TabItem value="java" label="Java"> | ||
|
|
||
| ```java | ||
| Not implemented |
There was a problem hiding this comment.
Is it intended to stay unimplemented?
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
ChannelAPI reference.WebSocket Connection Protocol (WSCP) Refactor and Schema Additions:
sharedSecretand the acceptor does not echo it. The assigned app identity is now carried inimplementationMetadata.appMetadata.WSCPApplicationConnect,WSCPDesktopAgentConnect,WSCPConnectFailed,WSCPGoodbye, and the sharedWSCPConnectionStepschema. These define the structure and requirements for each protocol message, improving clarity and interoperability. [1] [2] [3] [4] [5]API Documentation Enhancements:
ChannelAPI. 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]