[NETCONF-1014] Expand netconf.api.messages

Blocks — Mon, 4 Sep 2023 15:53:01 +0000

We have a baseline NetconfMessage, HelloMessage and NotificationMessage. We are notably missing RpcMessage and RpcReplyMessage – which means our object model of NETCONF Messages Layer is incomplete.

This omission actually has a number of repercussions across the code, as we do not end up deferring to the internal document to check its tags over and over again to determine which message we are talking to.

This issue has these deliverables, to be delivered in this order:

move NetconfMessage to netconf.api.messages
introduce RpcMessage and RpcReplyMessage
Make Notification's constructor private and provide a wrapping and non-wrapping static methods yielding NotificationMessage, to go in-line with Rpc- and RpcReplyMessage interface
netty-util's NetconfStartExiMessage should be turned into an utility class that constructs a raw Document and returns an RpcMessage with that Document
make NetconfMessage abstract and sealed, permitting on only the known messages, to be constructed through a 'public static @NonNull NetconfMessage of(Document document)' method. NOTE: This turned out to be more tangled up than anticipated, so it had to be broken down into a few steps:
1. Implement the NetconfMessage.of(Document) method
2. Since the of() method verifies the content of the document and constructs a corresponding subclass of NetconfMessage accordingly, there are some tests that will be failing when using the of() method, because they are using documents with malformed payload. Fix those tests
3. Eliminate all usages of NetconfMessage constructor outside of its inheritors, make the constructor protected, make the class abstract and sealed, permitting only Hello-, Notification-, Rpc-, RpcReply- Message.
improve netconf.server.spi.SubtreeFilter to not take plain org.w3c.Documents, but rather NotificationMessage, RpcMessage, RpcReplyMessage
audit for other opportunities, like NetconfDeviceCommunicator.processMessage(), where we should be able to use instanceof checks and have Request.request be a RpcMessage

OpenDaylight JIRA

[NETCONF-1014] Expand netconf.api.messages