Update 2023.09 Chlorine SR3 release notes
[docs.git] / docs / release-notes / projects / mdsal.rst
index 44474f09667cc7fc30422907efa9e42bc6d03d64..7834ef79f38ab29c8a7cfd28995b169aa5a72d37 100644 (file)
@@ -13,29 +13,31 @@ for providing YANG-defined interaction patterns:
 
 Behavior/Feature Changes
 ========================
-Java Binding generator core has been rewritten from scratch. This has been coming for a long time
-and was finally forced by YANG Tools performance requirements. The implementation now performs
-a better-informed analysis of the required mapping, eliminating a large class of issues and allows
-us to solve some long-standing failures with strange models encountered in the wild.
+The Binding mapping of ``type identityref`` YANG statement has been updated to use singleton objects
+instead of corresponding ``.class`` references. These singleton objects are exposed as ``VALUE`` constants,
+hence the migration is a straightforward move from ``Foo.class`` to ``Foo.VALUE``.
 
-Java Bindings generated by this release break compatibility by not generating legacy bridge methods
-generated by previous releases shipping in Aluminium and Magnesium.
+Binding classes generated for ``type enumeration`` YANG statement now have ``ofName()`` and ``ofValue()``
+methods, which return a non-null object or throw an ``IllegalArgumentException``.
+
+The ``feature`` YANG statement now has a representation in Binding: it is a final class which subclasses
+``YangFeature`` with a singleton value.
 
 New Features
 ============
-Netty Replication feature has been promoted to full production status. It is now available as
-``odl-mdsal-replicate-netty``.
+Both ``DOMNotificationService`` and ``NotificationService`` have gained the ability to register single-type
+and flexible multi-type notification listerners. This change allows Binding users to implement only specific
+listeners, unlike the previous method of using generated interfaces extending ``NotificationListener`` -- which
+required implementation of methods for every notification defined in a specific module.
 
 Deprecated Features
 ===================
-The ability to perform atomic operations on multiple datastores is terminally deprecated and will
-be removed in the next major release.
+``NotificationService.registerNotificationListener()`` method has been deprecated, along with its Binding
+specification interfaces based on ``NotificationListener``. These will be removed in the next major release.
 
 Removed Features
 ===================
-Internal APIs and implementations pertaining to ``DOMDataTreeShard``, ``DataTreeProducer`` and
-``DataTreeConsumer`` have been removed. Functionality offered by these is not currently covered
-by any construct, but we expect to deliver replacements in near future.
+No removed features.
 
 Resolved Issues
 ===============
@@ -43,7 +45,7 @@ The following table lists the issues resolved in this release.
 
 .. jira_fixed_issues::
    :project: MDSAL
-   :versions: 8.0.0-8.0.5
+   :versions: 10.0.0-10.0.2
 
 Known Issues
 ============
@@ -51,4 +53,52 @@ The following table lists the known issues that exist in this release.
 
 .. jira_known_issues::
    :project: MDSAL
-   :versions: 8.0.0-8.0.5
+   :versions: 10.0.0-10.0.2
+
+Resolved Issues in SR1
+======================
+The following table lists the issues resolved in Service Release 1.
+
+.. jira_fixed_issues::
+   :project: MDSAL
+   :versions: 10.0.3-10.0.5
+
+Known Issues in SR1
+===================
+The following table lists the known issues that exist in Service Release 1.
+
+.. jira_known_issues::
+   :project: MDSAL
+   :versions: 10.0.3-10.0.5
+
+Resolved Issues in SR2
+======================
+The following table lists the issues resolved in Service Release 2.
+
+.. jira_fixed_issues::
+   :project: MDSAL
+   :versions: 10.0.6-10.0.6
+
+Known Issues in SR2
+===================
+The following table lists the known issues that exist in Service Release 2.
+
+.. jira_known_issues::
+   :project: MDSAL
+   :versions: 10.0.6-10.0.6
+
+Resolved Issues in SR3
+======================
+The following table lists the issues resolved in Service Release 3.
+
+.. jira_fixed_issues::
+   :project: MDSAL
+   :versions: 10.0.7-10.0.7
+
+Known Issues in SR3
+===================
+The following table lists the known issues that exist in Service Release 3.
+
+.. jira_known_issues::
+   :project: MDSAL
+   :versions: 10.0.7-10.0.7