Add release notes for Chlorine SR1 MRI projects
[docs.git] / docs / release-notes / projects / mdsal.rst
1 ===============================================
2 Model-Driven Service Abstraction Layer (MD-SAL)
3 ===============================================
4
5 Overview
6 ========
7
8 MD-SAL provides infrastructure for binding YANG models to Java object model and infrastructure
9 for providing YANG-defined interaction patterns:
10 * Reactive datastore update
11 * RPC and Action invocation
12 * Notification sourcing and delivery
13
14 Behavior/Feature Changes
15 ========================
16 The Binding mapping of ``type identityref`` YANG statement has been updated to use singleton objects
17 instead of corresponding ``.class`` references. These singleton objects are exposed as ``VALUE`` constants,
18 hence the migration is a straightforward move from ``Foo.class`` to ``Foo.VALUE``.
19
20 Binding classes generated for ``type enumeration`` YANG statement now have ``ofName()`` and ``ofValue()``
21 methods, which return a non-null object or throw an ``IllegalArgumentException``.
22
23 The ``feature`` YANG statement now has a representation in Binding: it is a final class which subclasses
24 ``YangFeature`` with a singleton value.
25
26 New Features
27 ============
28 Both ``DOMNotificationService`` and ``NotificationService`` have gained the ability to register single-type
29 and flexible multi-type notification listerners. This change allows Binding users to implement only specific
30 listeners, unlike the previous method of using generated interfaces extending ``NotificationListener`` -- which
31 required implementation of methods for every notification defined in a specific module.
32
33 Deprecated Features
34 ===================
35 ``NotificationService.registerNotificationListener()`` method has been deprecated, along with its Binding
36 specification interfaces based on ``NotificationListener``. These will be removed in the next major release.
37
38 Removed Features
39 ===================
40 No removed features.
41
42 Resolved Issues
43 ===============
44 The following table lists the issues resolved in this release.
45
46 .. jira_fixed_issues::
47    :project: MDSAL
48    :versions: 10.0.0-10.0.2
49
50 Known Issues
51 ============
52 The following table lists the known issues that exist in this release.
53
54 .. jira_known_issues::
55    :project: MDSAL
56    :versions: 10.0.0-10.0.2
57
58 Resolved Issues in SR1
59 ======================
60 The following table lists the issues resolved in Service Release 1.
61
62 .. jira_fixed_issues::
63    :project: MDSAL
64    :versions: 10.0.3-10.0.3
65
66 Known Issues in SR1
67 ===================
68 The following table lists the known issues that exist in Service Release 1.
69
70 .. jira_known_issues::
71    :project: MDSAL
72    :versions: 10.0.3-10.0.3