8 Nitrogen release marks the seventh release of YANG Tools components. We have
9 fixed lot of issues ranging from small annoyances to major reworks.
11 Major changes delivered in this release are
13 * Migration to new XML Parser
14 `Bug 5824 <https://bugs.opendaylight.org/show_bug.cgi?id=5824>`_
15 `Bug 5825 <https://bugs.opendaylight.org/show_bug.cgi?id=5825>`_
16 * Fix of new XML parser design flaws
17 `Bug 8675 <https://bugs.opendaylight.org/show_bug.cgi?id=8675>`_
18 `Bug 8715 <https://bugs.opendaylight.org/show_bug.cgi?id=8715>`_
19 `Bug 8745 <https://bugs.opendaylight.org/show_bug.cgi?id=8745>`_.
20 * InMemoryDataTree can be configured to perform full mandatory leaf
22 `Bug 8291 <https://bugs.opendaylight.org/show_bug.cgi?id=8291>`_
23 * Deviation statements are properly activated
24 `Bug 8307 <https://bugs.opendaylight.org/show_bug.cgi?id=8307>`_
25 * TrieMap implementation
26 `Bug 7464 <https://bugs.opendaylight.org/show_bug.cgi?id=7464>`_
27 * Improvements, bug fixing and clean up yang-model-export, yang-parser-impl,
28 yang-model-api, yang-data-impl, yang-data-api
31 odl-yangtools-yang-data
32 -----------------------
34 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=yangtools.git;a=blob_plain;f=features/odl-yangtools-yang-data/pom.xml;hb=refs/heads/v1.2.x
35 * **Feature Description:** to install YANG Data APIs and implementation.
38 * **Experimental:** Yes
39 * **CSIT Test:** System test waiver request pending.
44 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=yangtools.git;a=blob;f=features/odl-yangtools-common/pom.xml;hb=refs/heads/v1.2.x
45 * **Feature Description:** to install common concepts and utilities.
48 * **Experimental:** Yes
49 * **CSIT Test:** System test waiver request pending.
51 odl-yangtools-yang-parser
52 -------------------------
54 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=yangtools.git;a=blob;f=features/odl-yangtools-yang-parser/pom.xml;hb=refs/heads/v1.2.x
55 * **Feature Description:** to install YANG model APIs and YANG Parser
58 * **Experimental:** No
59 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/yangtools/job/yangtools-csit-1node-periodic-system-only-nitrogen/
63 * **Developer Guide(s):**
65 * :ref:`yangtools-developer-guide`
67 Security Considerations
68 =======================
70 * YANG Tools libraries are designed to be embedded and not to be a stand-alone
71 application so security concerns need to be addressed by the application
77 * `Link to Sonar Report <https://sonar.opendaylight.org/overview?id=13079>`_
80 <https://jenkins.opendaylight.org/releng/view/yangtools/job/yangtools-csit-1node-periodic-system-only-nitrogen/>`_
85 * It is possible to migrate from the previous release. Aside from adjusting to
86 the removal of deprecated API elements and changed elements, there are no
87 additional steps needed for migration to this release.
92 * Release is compatible with the previous one.
95 * `XmlParserStream.traverse (DOMSource)
96 <https://git.opendaylight.org/gerrit/#/c/60864/5>`_
97 * `Added UnrecognizedStatement and refactoring of StmtContextUtils
98 <https://git.opendaylight.org/gerrit/#/c/61571/>`_
99 * `Moving of SubstatementValidator into spi.meta package
100 <https://git.opendaylight.org/gerrit/#/c/61570/>`_
101 * EffectiveSchemaContext was moved, users are advised to use
103 * org.opendaylight.yangtools.yang.parser.spi package was adjusted
105 * No configuration changes.
108 * concepts.Registration does not allow nulls
109 * SemVer and the associated Semantic Version is now bound to OpenConfig
110 * YANG/YIN parser is less forgiving in face of ambiguous constructs
111 (like 'mandatory ture' or 'status foobar')
116 * List of fixed `Bugs
117 <https://bugs.opendaylight.org/buglist.cgi?bug_severity=blocker&bug_severity=critical&bug_severity=major&bug_severity=normal&bug_severity=minor&bug_severity=trivial&bug_severity=enhancement&columnlist=product%2Ccomponent%2Cassigned_to%2Cbug_severity%2Ccf_issue_type%2Cshort_desc%2Cbug_status%2Cpriority%2Cdeadline%2Ccf_target_milestone&component=General&f1=cf_target_milestone&known_name=Nitrogen%3A%20Yangtools&list_id=78630&o1=substring&order=bug_id&product=yangtools&query_based_on=Nitrogen%3A%20Yangtools&query_format=advanced&resolution=FIXED&v1=Nitrogen>`_.
123 <https://bugs.opendaylight.org/buglist.cgi?bug_severity=blocker&bug_severity=critical&bug_severity=major&bug_severity=normal&bug_severity=minor&bug_severity=trivial&bug_severity=enhancement&columnlist=product%2Ccomponent%2Cassigned_to%2Cbug_severity%2Ccf_issue_type%2Cshort_desc%2Cbug_status%2Cpriority%2Cdeadline%2Ccf_target_milestone&component=General&f1=cf_target_milestone&known_name=Nitrogen%3A%20Yangtools&list_id=78805&o1=substring&product=yangtools&query_based_on=Nitrogen%3A%20Yangtools&query_format=advanced&resolution=---&v1=Nitrogen>`_
128 * This release has not introduced any new deprecation of a major feature
129 or API. However, there are some minor deprecations such as:
131 * Yang-data-impl XML codec has been deprecated
132 `<https://git.opendaylight.org/gerrit/#/c/60558/>`_
133 * YangParseException has been deprecated
134 `<https://git.opendaylight.org/gerrit/#/c/58751/>`_
136 * Major development is shifting to 2.0.0 version, which is guaranteed to be
137 API incompatible. Users are advised to eliminate any reliance on @Deprecated
138 components as soon as possible after adopting this release.
139 Furthermore, the use of CheckedFuture will be eliminated, hence users should
140 reduce their reliance on this class.
141 Next release will also move Optional, Function, Predicate and others
142 from Guava to their java.util equivalents.
147 * YANG and YIN parser processing according to
148 `RFC 6020 <https://tools.ietf.org/html/rfc6020>`_,
149 `RFC 7950 <https://tools.ietf.org/html/rfc7950>`_ and
150 `RFC 8040 <https://tools.ietf.org/html/rfc8040>`_
151 * XML parser for YANG-modeled data according to
152 `RFC 6020 <https://tools.ietf.org/html/rfc6020>`_ and
153 `RFC 7950 <https://tools.ietf.org/html/rfc7950>`_.
154 * JSON parser for YANG-modeled data according to
155 `RFC 7951 <https://tools.ietf.org/html/rfc7951>`_
160 * `Link to the release plan <https://wiki.opendaylight.org/view/Simultaneous_Release:Nitrogen_Release_Plan>`_