1 <?xml version="1.0" encoding="UTF-8"?>
2 <!-- vi: set et smarttab sw=4 tabstop=4: -->
4 Copyright (c) 2013 Cisco Systems, Inc. and others. All rights reserved.
6 This program and the accompanying materials are made available under the
7 terms of the Eclipse Public License v1.0 which accompanies this distribution,
8 and is available at http://www.eclipse.org/legal/epl-v10.html
10 <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
11 <modelVersion>4.0.0</modelVersion>
13 <groupId>org.opendaylight.mdsal</groupId>
14 <artifactId>bundle-parent</artifactId>
15 <version>13.0.4-SNAPSHOT</version>
16 <relativePath>../bundle-parent</relativePath>
19 <artifactId>mdsal-docs</artifactId>
20 <packaging>jar</packaging>
21 <name>${project.artifactId}</name>
22 <description>MD-SAL documentation</description>
25 <!-- FIXME: fix these up and set maven.javadoc.failOnWarnings=true -->
26 <doclint>all,-missing</doclint>
31 <groupId>org.opendaylight.mdsal</groupId>
32 <artifactId>mdsal-common-api</artifactId>
35 <groupId>org.opendaylight.mdsal</groupId>
36 <artifactId>mdsal-dom-api</artifactId>
39 <groupId>org.opendaylight.mdsal</groupId>
40 <artifactId>mdsal-dom-spi</artifactId>
43 <groupId>org.opendaylight.mdsal</groupId>
44 <artifactId>mdsal-dom-broker</artifactId>
47 <groupId>org.opendaylight.mdsal</groupId>
48 <artifactId>mdsal-dom-schema-osgi</artifactId>
51 <groupId>org.opendaylight.mdsal</groupId>
52 <artifactId>mdsal-dom-inmemory-datastore</artifactId>
55 <groupId>org.opendaylight.mdsal</groupId>
56 <artifactId>mdsal-binding-loader</artifactId>
59 <groupId>org.opendaylight.mdsal</groupId>
60 <artifactId>mdsal-binding-model-api</artifactId>
63 <groupId>org.opendaylight.mdsal</groupId>
64 <artifactId>mdsal-binding-model-ri</artifactId>
67 <groupId>org.opendaylight.mdsal</groupId>
68 <artifactId>mdsal-binding-generator</artifactId>
71 <groupId>org.opendaylight.mdsal</groupId>
72 <artifactId>mdsal-binding-java-api-generator</artifactId>
75 <groupId>org.opendaylight.mdsal</groupId>
76 <artifactId>yang-binding</artifactId>
79 <groupId>org.opendaylight.mdsal</groupId>
80 <artifactId>mdsal-binding-spec-util</artifactId>
83 <groupId>org.opendaylight.mdsal</groupId>
84 <artifactId>mdsal-binding-test-model</artifactId>
85 <scope>provided</scope>
89 <groupId>org.opendaylight.mdsal</groupId>
90 <artifactId>mdsal-binding-api</artifactId>
93 <groupId>org.opendaylight.mdsal</groupId>
94 <artifactId>mdsal-binding-dom-adapter</artifactId>
97 <groupId>org.opendaylight.mdsal</groupId>
98 <artifactId>mdsal-binding-dom-adapter</artifactId>
100 <scope>provided</scope>
103 <groupId>org.opendaylight.mdsal</groupId>
104 <artifactId>mdsal-binding-dom-codec</artifactId>
107 <groupId>org.opendaylight.mdsal</groupId>
108 <artifactId>mdsal-binding-dom-codec-api</artifactId>
111 <groupId>org.opendaylight.mdsal</groupId>
112 <artifactId>mdsal-binding-dom-codec-spi</artifactId>
115 <groupId>org.opendaylight.mdsal</groupId>
116 <artifactId>mdsal-binding-dom-codec-osgi</artifactId>
119 <groupId>org.opendaylight.mdsal</groupId>
120 <artifactId>mdsal-binding-runtime-api</artifactId>
123 <groupId>org.opendaylight.mdsal</groupId>
124 <artifactId>mdsal-binding-runtime-spi</artifactId>
127 <groupId>org.opendaylight.mdsal</groupId>
128 <artifactId>mdsal-binding-runtime-osgi</artifactId>
131 <groupId>org.opendaylight.mdsal</groupId>
132 <artifactId>mdsal-binding-spi</artifactId>
135 <groupId>org.opendaylight.mdsal</groupId>
136 <artifactId>mdsal-binding-util</artifactId>
139 <groupId>org.opendaylight.mdsal</groupId>
140 <artifactId>mdsal-binding-test-utils</artifactId>
141 <scope>compile</scope>
145 <groupId>org.opendaylight.mdsal.model</groupId>
146 <artifactId>yang-ext</artifactId>
149 <groupId>org.opendaylight.mdsal.model</groupId>
150 <artifactId>general-entity</artifactId>
154 <groupId>org.opendaylight.mdsal</groupId>
155 <artifactId>mdsal-eos-common-api</artifactId>
158 <groupId>org.opendaylight.mdsal</groupId>
159 <artifactId>mdsal-eos-dom-api</artifactId>
162 <groupId>org.opendaylight.mdsal</groupId>
163 <artifactId>mdsal-eos-dom-simple</artifactId>
166 <groupId>org.opendaylight.mdsal</groupId>
167 <artifactId>mdsal-eos-binding-api</artifactId>
170 <groupId>org.opendaylight.mdsal</groupId>
171 <artifactId>mdsal-eos-binding-adapter</artifactId>
174 <groupId>org.opendaylight.mdsal</groupId>
175 <artifactId>mdsal-singleton-api</artifactId>
178 <groupId>org.opendaylight.mdsal</groupId>
179 <artifactId>mdsal-singleton-impl</artifactId>
183 <groupId>org.opendaylight.mdsal</groupId>
184 <artifactId>mdsal-trace-api</artifactId>
187 <groupId>org.opendaylight.mdsal</groupId>
188 <artifactId>mdsal-trace-cli</artifactId>
191 <groupId>org.opendaylight.mdsal</groupId>
192 <artifactId>mdsal-trace-impl</artifactId>
196 <groupId>org.opendaylight.mdsal</groupId>
197 <artifactId>mdsal-yanglib-api</artifactId>
200 <groupId>org.opendaylight.mdsal</groupId>
201 <artifactId>mdsal-yanglib-rfc8525</artifactId>
205 <groupId>org.opendaylight.mdsal</groupId>
206 <artifactId>mdsal-replicate-common</artifactId>
209 <groupId>org.opendaylight.mdsal</groupId>
210 <artifactId>mdsal-replicate-netty</artifactId>
214 <groupId>org.opendaylight.mdsal</groupId>
215 <artifactId>mdsal-rfc8294-netty</artifactId>
219 <groupId>org.opendaylight.mdsal.model</groupId>
220 <artifactId>opendaylight-l2-types</artifactId>
223 <groupId>org.opendaylight.mdsal.binding.model.ietf</groupId>
224 <artifactId>rfc6991-ietf-inet-types</artifactId>
227 <groupId>org.opendaylight.mdsal.binding.model.ietf</groupId>
228 <artifactId>rfc6991-ietf-yang-types</artifactId>
231 <groupId>org.opendaylight.mdsal.model</groupId>
232 <artifactId>ietf-type-util</artifactId>
235 <groupId>org.opendaylight.mdsal.binding.model.ietf</groupId>
236 <artifactId>rfc7952</artifactId>
239 <groupId>org.opendaylight.mdsal.binding.model.ietf</groupId>
240 <artifactId>rfc8040</artifactId>
243 <groupId>org.opendaylight.mdsal.binding.model.ietf</groupId>
244 <artifactId>rfc8294-ietf-routing-types</artifactId>
247 <groupId>org.opendaylight.mdsal.binding.model.ietf</groupId>
248 <artifactId>rfc8342-ietf-datastores</artifactId>
251 <groupId>org.opendaylight.mdsal.binding.model.ietf</groupId>
252 <artifactId>rfc8342-ietf-origin</artifactId>
255 <groupId>org.opendaylight.mdsal.binding.model.ietf</groupId>
256 <artifactId>rfc8343</artifactId>
259 <groupId>org.opendaylight.mdsal.binding.model.ietf</groupId>
260 <artifactId>rfc8344</artifactId>
263 <groupId>org.opendaylight.mdsal.binding.model.ietf</groupId>
264 <artifactId>rfc8345-ietf-network</artifactId>
267 <groupId>org.opendaylight.mdsal.binding.model.ietf</groupId>
268 <artifactId>rfc8345-ietf-network-state</artifactId>
271 <groupId>org.opendaylight.mdsal.binding.model.ietf</groupId>
272 <artifactId>rfc8345-ietf-network-topology</artifactId>
275 <groupId>org.opendaylight.mdsal.binding.model.ietf</groupId>
276 <artifactId>rfc8345-ietf-network-topology-state</artifactId>
279 <groupId>org.opendaylight.mdsal.binding.model.ietf</groupId>
280 <artifactId>rfc8346-ietf-l3-unicast-topology</artifactId>
283 <groupId>org.opendaylight.mdsal.binding.model.ietf</groupId>
284 <artifactId>rfc8346-ietf-l3-unicast-topology-state</artifactId>
287 <groupId>org.opendaylight.mdsal.binding.model.ietf</groupId>
288 <artifactId>rfc8348-ietf-hardware</artifactId>
291 <groupId>org.opendaylight.mdsal.binding.model.ietf</groupId>
292 <artifactId>rfc8348-ietf-hardware-state</artifactId>
295 <groupId>org.opendaylight.mdsal.binding.model.ietf</groupId>
296 <artifactId>rfc8349-ietf-routing</artifactId>
299 <groupId>org.opendaylight.mdsal.binding.model.ietf</groupId>
300 <artifactId>rfc8349-ietf-ipv4-unicast-routing</artifactId>
303 <groupId>org.opendaylight.mdsal.binding.model.ietf</groupId>
304 <artifactId>rfc8349-ietf-ipv6-unicast-routing</artifactId>
307 <groupId>org.opendaylight.mdsal.binding.model.ietf</groupId>
308 <artifactId>rfc8519-ietf-access-control-list</artifactId>
311 <groupId>org.opendaylight.mdsal.binding.model.ietf</groupId>
312 <artifactId>rfc8519-ietf-ethertypes</artifactId>
315 <groupId>org.opendaylight.mdsal.binding.model.ietf</groupId>
316 <artifactId>rfc8519-ietf-packet-fields</artifactId>
319 <groupId>org.opendaylight.mdsal.binding.model.ietf</groupId>
320 <artifactId>rfc8520-ietf-acldns</artifactId>
323 <groupId>org.opendaylight.mdsal.binding.model.ietf</groupId>
324 <artifactId>rfc8520-ietf-mud</artifactId>
327 <groupId>org.opendaylight.mdsal.binding.model.ietf</groupId>
328 <artifactId>rfc8525</artifactId>
331 <groupId>org.opendaylight.mdsal.binding.model.ietf</groupId>
332 <artifactId>rfc8528</artifactId>
335 <groupId>org.opendaylight.mdsal.binding.model.ietf</groupId>
336 <artifactId>rfc8529</artifactId>
339 <groupId>org.opendaylight.mdsal.binding.model.ietf</groupId>
340 <artifactId>rfc8530</artifactId>
343 <groupId>org.opendaylight.mdsal.binding.model.ietf</groupId>
344 <artifactId>rfc8542-ietf-dc-fabric-topology</artifactId>
347 <groupId>org.opendaylight.mdsal.binding.model.ietf</groupId>
348 <artifactId>rfc8542-ietf-dc-fabric-types</artifactId>
351 <groupId>org.opendaylight.mdsal.binding.model.ietf</groupId>
352 <artifactId>rfc8776-ietf-te-types</artifactId>
355 <groupId>org.opendaylight.mdsal.binding.model.ietf</groupId>
356 <artifactId>rfc8776-ietf-te-packet-types</artifactId>
359 <groupId>org.opendaylight.mdsal.binding.model.ietf</groupId>
360 <artifactId>rfc8795-ietf-te-topology-state</artifactId>
363 <groupId>org.opendaylight.mdsal.binding.model.iana</groupId>
364 <artifactId>iana-hardware</artifactId>
367 <groupId>org.opendaylight.mdsal.binding.model.iana</groupId>
368 <artifactId>iana-if-type</artifactId>
371 <groupId>org.opendaylight.mdsal.binding.model.iana</groupId>
372 <artifactId>iana-routing-types</artifactId>
375 <groupId>org.opendaylight.mdsal.model</groupId>
376 <artifactId>ietf-topology</artifactId>
379 <!-- Also add dependencies we are using -->
381 <groupId>com.github.spotbugs</groupId>
382 <artifactId>spotbugs-annotations</artifactId>
385 <groupId>com.guicedee.services</groupId>
386 <artifactId>javax.inject</artifactId>
389 <groupId>jakarta.annotation</groupId>
390 <artifactId>jakarta.annotation-api</artifactId>
391 <scope>provided</scope>
394 <groupId>org.apache.karaf.shell</groupId>
395 <artifactId>org.apache.karaf.shell.core</artifactId>
396 <scope>provided</scope>
399 <groupId>org.gaul</groupId>
400 <artifactId>modernizer-maven-annotations</artifactId>
403 <groupId>org.immutables</groupId>
404 <artifactId>value</artifactId>
405 <classifier>annotations</classifier>
406 <scope>provided</scope>
409 <groupId>org.kohsuke.metainf-services</groupId>
410 <artifactId>metainf-services</artifactId>
411 <scope>provided</scope>
414 <groupId>org.osgi</groupId>
415 <artifactId>org.osgi.framework</artifactId>
416 <scope>provided</scope>
419 <groupId>org.osgi</groupId>
420 <artifactId>org.osgi.service.component</artifactId>
421 <scope>provided</scope>
424 <groupId>org.osgi</groupId>
425 <artifactId>org.osgi.service.component.annotations</artifactId>
426 <scope>provided</scope>
429 <groupId>org.osgi</groupId>
430 <artifactId>org.osgi.service.metatype.annotations</artifactId>
431 <scope>provided</scope>
434 <groupId>org.osgi</groupId>
435 <artifactId>org.osgi.util.tracker</artifactId>
436 <scope>provided</scope>
439 <groupId>junit</groupId>
440 <artifactId>junit</artifactId>
441 <scope>provided</scope>
444 <groupId>org.ow2.asm</groupId>
445 <artifactId>asm</artifactId>
446 <scope>provided</scope>
449 <groupId>org.apache.karaf.features</groupId>
450 <artifactId>org.apache.karaf.features.core</artifactId>
453 <groupId>io.netty</groupId>
454 <artifactId>netty-transport-native-epoll</artifactId>
455 <scope>provided</scope>
462 <groupId>org.asciidoctor</groupId>
463 <artifactId>asciidoctor-maven-plugin</artifactId>
464 <version>1.5.7.1</version>
468 <phase>generate-resources</phase>
470 <goal>process-asciidoc</goal>
473 <sourceHighlighter>coderay</sourceHighlighter>
474 <backend>html</backend>
477 <linkcss>false</linkcss>
483 <outputDirectory>${project.build.directory}/classes</outputDirectory>
485 <revnumber>${project.version}</revnumber>
486 <revdate>${maven.build.timestamp}</revdate>
487 <organization>${project.organization.name}</organization>
493 <artifactId>maven-dependency-plugin</artifactId>
496 <id>unpack-sources</id>
497 <phase>prepare-package</phase>
499 <goal>unpack-dependencies</goal>
502 <silent>true</silent>
503 <classifier>sources</classifier>
504 <includes>org/opendaylight/**</includes>
505 <includeGroupIds>org.opendaylight.mdsal</includeGroupIds>
506 <outputDirectory>${project.build.directory}/src</outputDirectory>
513 <groupId>org.codehaus.mojo</groupId>
514 <artifactId>build-helper-maven-plugin</artifactId>
518 <!-- post-compile, but before prepare-package -->
519 <phase>process-classes</phase>
521 <goal>add-source</goal>
525 <source>${project.build.directory}/src</source>
533 <artifactId>maven-source-plugin</artifactId>
536 <id>attach-sources</id>
537 <!-- prepare-package so we build the source package before javadoc -->
538 <phase>prepare-package</phase>
540 <goal>jar-no-fork</goal>
547 <artifactId>maven-clean-plugin</artifactId>
550 <id>remove-undocumented-sources</id>
551 <!-- Before javadoc runs -->
552 <phase>prepare-package</phase>
557 <excludeDefaultDirectories>true</excludeDefaultDirectories>
560 <directory>${project.build.directory}/src</directory>
562 <include>**/$YangModelBindingProvider.java</include>
563 <include>**/$YangModuleInfoImpl.java</include>
572 <artifactId>maven-javadoc-plugin</artifactId>
575 <id>attach-javadocs</id>
581 <!-- FIXME: remove this section once we can activate javadoc-links profile -->
582 <configuration combine.children="append">
584 <link>https://junit.org/junit4/javadoc/4.13/</link>
585 <link>https://hamcrest.org/JavaHamcrest/javadoc/2.2/</link>
586 <link>https://www.slf4j.org/apidocs/</link>
587 <link>https://guava.dev/releases/32.1.2-jre/api/docs/</link>
588 <link>https://commons.apache.org/proper/commons-lang/javadocs/api-release/</link>
590 <link>https://www.javadoc.io/doc/org.opendaylight.odlparent/odlparent-docs/13.1.2/</link>
591 <link>https://www.javadoc.io/doc/org.opendaylight.yangtools/yangtools-docs/13.0.2/</link>
595 <title>Common interfaces</title>
596 <packages>org.opendaylight.mdsal.common*</packages>
599 <title>Low-level (DOM) MD-SAL</title>
600 <packages>org.opendaylight.mdsal.dom*</packages>
603 <title>Type-safe (Binding) MD-SAL</title>
604 <packages>org.opendaylight.mdsal.binding*:org.opendaylight.yangtools.yang.binding*</packages>
607 <title>Entity Ownership Service</title>
608 <packages>org.opendaylight.mdsal.eos*:org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.mdsal.core.general.entity*</packages>
611 <title>Cluster Singleton Service</title>
612 <packages>org.opendaylight.mdsal.singleton*</packages>
615 <title>MD-SAL Tracing Utilities</title>
616 <packages>org.opendaylight.mdsal.trace*:org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.mdsaltrace*</packages>
619 <title>Baseline utilities for interacting with RFC6991 models</title>
620 <packages>org.opendaylight.mdsal.model.ietf.util</packages>
623 <title>Java Bindings for iana-hardware.yang</title>
624 <packages>org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.iana.hardware*</packages>
627 <title>Java Bindings for iana-if-type.yang</title>
628 <packages>org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.iana._if.type*</packages>
631 <title>Java Bindings for iana-routing-type.yang</title>
632 <packages>org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.iana.routing.type*</packages>
635 <title>Java Bindings for ietf-access-control-list.yang</title>
636 <packages>org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.access.control.list*</packages>
639 <title>Java Bindings for ietf-datastores.yang</title>
640 <packages>org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.datastores*</packages>
643 <title>Java Bindings for ietf-hardware.yang</title>
644 <packages>org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.hardware*</packages>
647 <title>Java Bindings for ietf-inet-types.yang</title>
648 <packages>org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types*</packages>
651 <title>Java Bindings for ietf-interfaces.yang</title>
652 <packages>org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces*</packages>
655 <title>Java Bindings for ietf-ip.yang</title>
656 <packages>org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ip.rev*</packages>
659 <title>Java Bindings for ietf-network.yang</title>
660 <packages>org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.rev*</packages>
663 <title>Java Bindings for ietf-network-topology.yang</title>
664 <packages>org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev*</packages>
667 <title>Java Bindings for ietf-network-state.yang</title>
668 <packages>org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.state*</packages>
671 <title>Java Bindings for ietf-network-topology-state.yang</title>
672 <packages>org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.state*</packages>
675 <title>Java Bindings for ietf-origin.yang</title>
676 <packages>org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.origin*</packages>
679 <title>Java Bindings for ietf-packet-fields.yang</title>
680 <packages>org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.packet.fields*</packages>
683 <title>Java Bindings for ietf-ipv4-unicast-routing.yang</title>
684 <packages>org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ipv4.unicast.routing*</packages>
687 <title>Java Bindings for ietf-ipv6-unicast-routing.yang</title>
688 <packages>org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ipv6.unicast.routing*</packages>
691 <title>Java Bindings for ietf-routing.yang</title>
692 <packages>org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.routing.rev*</packages>
695 <title>Java Bindings for ietf-routing-types.yang</title>
696 <packages>org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.routing.types*</packages>
699 <title>Java Bindings for ietf-yang-library.yang</title>
700 <packages>org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.library*</packages>
703 <title>Java Bindings for ietf-yang-schema-mount.yang</title>
704 <packages>org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.schema.mount*</packages>
707 <title>Java Bindings for ietf-yang-types.yang</title>
708 <packages>org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types*</packages>
711 <title>Java Bindings for opendaylight-l2-types.yang</title>
712 <packages>org.opendaylight.yang.gen.v1.urn.opendaylight.l2.types*</packages>
715 <title>Other model-driven Java Bindings</title>
716 <packages>org.opendaylight.yang.gen.v1*</packages>