restconf/restconf-nb-rfc8040/src/main/java/org/opendaylight/restconf/nb/rfc8040/utils/mapping/RestconfMappingNodeUtil.java

   1 /*
   2  * Copyright (c) 2016 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.restconf.nb.rfc8040.utils.mapping;
   9
  10 import java.net.URI;
  11 import java.time.Instant;
  12 import java.time.OffsetDateTime;
  13 import java.time.ZoneId;
  14 import java.time.format.DateTimeFormatter;
  15 import java.util.Collection;
  16 import java.util.Optional;
  17 import java.util.Set;
  18 import org.opendaylight.restconf.common.errors.RestconfDocumentedException;
  19 import org.opendaylight.restconf.nb.rfc8040.Rfc8040.IetfYangLibrary;
  20 import org.opendaylight.restconf.nb.rfc8040.Rfc8040.MonitoringModule;
  21 import org.opendaylight.restconf.nb.rfc8040.Rfc8040.MonitoringModule.QueryParams;
  22 import org.opendaylight.restconf.nb.rfc8040.utils.parser.ParserIdentifier;
  23 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.library.rev160621.module.list.Module.ConformanceType;
  24 import org.opendaylight.yangtools.yang.common.QName;
  25 import org.opendaylight.yangtools.yang.common.Revision;
  26 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  27 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  28 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
  29 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
  30 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  31 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
  32 import org.opendaylight.yangtools.yang.data.api.schema.LeafSetEntryNode;
  33 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
  34 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
  35 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  36 import org.opendaylight.yangtools.yang.data.api.schema.OrderedMapNode;
  37 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
  38 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.CollectionNodeBuilder;
  39 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.DataContainerNodeBuilder;
  40 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.ListNodeBuilder;
  41 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
  42 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
  43 import org.opendaylight.yangtools.yang.model.api.Deviation;
  44 import org.opendaylight.yangtools.yang.model.api.FeatureDefinition;
  45 import org.opendaylight.yangtools.yang.model.api.GroupingDefinition;
  46 import org.opendaylight.yangtools.yang.model.api.LeafListSchemaNode;
  47 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
  48 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
  49 import org.opendaylight.yangtools.yang.model.api.Module;
  50 import org.opendaylight.yangtools.yang.model.api.NotificationDefinition;
  51 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  52 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
  53
  54 /**
  55  * Util class for mapping nodes.
  56  *
  57  */
  58 public final class RestconfMappingNodeUtil {
  59
  60     private RestconfMappingNodeUtil() {
  61         throw new UnsupportedOperationException("Util class");
  62     }
  63
  64     /**
  65      * Map data from modules to {@link NormalizedNode}.
  66      *
  67      * @param modules
  68      *             modules for mapping
  69      * @param ietfYangLibraryModule
  70      *             ietf-yang-library module
  71      * @param context
  72      *             schema context
  73      * @param moduleSetId
  74      *             module-set-id of actual set
  75      * @return mapped data as {@link NormalizedNode}
  76      */
  77     public static NormalizedNode<NodeIdentifier, Collection<DataContainerChild<? extends PathArgument, ?>>>
  78             mapModulesByIetfYangLibraryYang(final Set<Module> modules, final Module ietfYangLibraryModule,
  79                     final SchemaContext context, final String moduleSetId) {
  80         final DataSchemaNode modulesStateSch =
  81                 ietfYangLibraryModule.getDataChildByName(IetfYangLibrary.MODUELS_STATE_CONT_QNAME);
  82         final DataContainerNodeBuilder<NodeIdentifier, ContainerNode> modulesStateBuilder =
  83                 Builders.containerBuilder((ContainerSchemaNode) modulesStateSch);
  84
  85         final DataSchemaNode moduleSetIdSch =
  86                 ((ContainerSchemaNode) modulesStateSch).getDataChildByName(IetfYangLibrary.MODULE_SET_ID_LEAF_QNAME);
  87         modulesStateBuilder
  88                 .withChild(Builders.leafBuilder((LeafSchemaNode) moduleSetIdSch).withValue(moduleSetId).build());
  89
  90         final DataSchemaNode moduleSch = findNodeInGroupings(IetfYangLibrary.MODULE_QNAME_LIST, ietfYangLibraryModule);
  91         final CollectionNodeBuilder<MapEntryNode, OrderedMapNode> mapBuilder =
  92                 Builders.orderedMapBuilder((ListSchemaNode) moduleSch);
  93         for (final Module module : context.getModules()) {
  94             fillMapByModules(mapBuilder, moduleSch, false, module, ietfYangLibraryModule, context);
  95         }
  96         return modulesStateBuilder.withChild(mapBuilder.build()).build();
  97     }
  98
  99     /**
 100      * Map data by the specific module or submodule.
 101      *
 102      * @param mapBuilder
 103      *             ordered list builder for children
 104      * @param moduleSch
 105      *             schema of list for entryMapBuilder
 106      * @param isSubmodule
 107      *             true if module is specified as submodule, false otherwise
 108      * @param module
 109      *             specific module or submodule
 110      * @param ietfYangLibraryModule
 111      *             ietf-yang-library module
 112      * @param context
 113      *             schema context
 114      */
 115     private static void fillMapByModules(final CollectionNodeBuilder<MapEntryNode, OrderedMapNode> mapBuilder,
 116             final DataSchemaNode moduleSch, final boolean isSubmodule, final Module module,
 117             final Module ietfYangLibraryModule, final SchemaContext context) {
 118         final DataContainerNodeBuilder<NodeIdentifierWithPredicates, MapEntryNode> mapEntryBuilder =
 119                 Builders.mapEntryBuilder((ListSchemaNode) moduleSch);
 120         addCommonLeafs(module, mapEntryBuilder, ietfYangLibraryModule);
 121         addChildOfModuleBySpecificModuleInternal(
 122                 IetfYangLibrary.SPECIFIC_MODULE_SCHEMA_LEAF_QNAME, mapEntryBuilder, IetfYangLibrary.BASE_URI_OF_SCHEMA
 123                         + module.getName() + "/"
 124                         + module.getQNameModule().getRevision().map(Revision::toString).orElse(null),
 125                 ietfYangLibraryModule);
 126         if (!isSubmodule) {
 127             addChildOfModuleBySpecificModuleOfListChild(IetfYangLibrary.SPECIFIC_MODULE_NAMESPACE_LEAF_QNAME,
 128                     mapEntryBuilder, module.getNamespace().toString(), ietfYangLibraryModule);
 129
 130             // features - not mandatory
 131             if (module.getFeatures() != null && !module.getFeatures().isEmpty()) {
 132                 addFeatureLeafList(IetfYangLibrary.SPECIFIC_MODULE_FEATURE_LEAF_LIST_QNAME, mapEntryBuilder,
 133                         module.getFeatures(), ietfYangLibraryModule);
 134             }
 135             // deviations - not mandatory
 136             if (module.getDeviations() != null && !module.getDeviations().isEmpty()) {
 137                 addDeviationList(module, mapEntryBuilder, ietfYangLibraryModule, context);
 138                 addChildOfModuleBySpecificModuleOfListChild(IetfYangLibrary.SPECIFIC_MODULE_CONFORMANCE_LEAF_QNAME,
 139                         mapEntryBuilder, ConformanceType.Implement.getName(), ietfYangLibraryModule);
 140             } else {
 141                 addChildOfModuleBySpecificModuleOfListChild(IetfYangLibrary.SPECIFIC_MODULE_CONFORMANCE_LEAF_QNAME,
 142                         mapEntryBuilder, ConformanceType.Import.getName(), ietfYangLibraryModule);
 143             }
 144             // submodules - not mandatory
 145             if (module.getSubmodules() != null && !module.getSubmodules().isEmpty()) {
 146                 addSubmodules(module, mapEntryBuilder, ietfYangLibraryModule, context);
 147             }
 148         }
 149         mapBuilder.withChild(mapEntryBuilder.build());
 150     }
 151
 152     /**
 153      * Mapping submodules of specific module.
 154      *
 155      * @param module
 156      *             module with submodules
 157      * @param mapEntryBuilder
 158      *             mapEntryBuilder of parent for mapping children
 159      * @param ietfYangLibraryModule
 160      *             ietf-yang-library module
 161      * @param context
 162      *             schema context
 163      */
 164     private static void addSubmodules(final Module module,
 165             final DataContainerNodeBuilder<NodeIdentifierWithPredicates, MapEntryNode> mapEntryBuilder,
 166             final Module ietfYangLibraryModule, final SchemaContext context) {
 167         final DataSchemaNode listSubm = findSchemaInListOfModulesSchema(
 168                 IetfYangLibrary.SPECIFIC_MODULE_SUBMODULE_LIST_QNAME, ietfYangLibraryModule);
 169         final CollectionNodeBuilder<MapEntryNode, OrderedMapNode> mapBuilder =
 170                 Builders.orderedMapBuilder((ListSchemaNode) listSubm);
 171         for (final Module submodule : module.getSubmodules()) {
 172             fillMapByModules(mapBuilder, listSubm, true, submodule, ietfYangLibraryModule, context);
 173         }
 174         mapEntryBuilder.withChild(mapBuilder.build());
 175     }
 176
 177     /**
 178      * Mapping deviations of specific module.
 179      *
 180      * @param module
 181      *             module with deviations
 182      * @param mapEntryBuilder
 183      *             mapEntryBuilder of parent for mapping children
 184      * @param ietfYangLibraryModule
 185      *             ietf-yang-library module
 186      * @param context
 187      *             schema context
 188      */
 189     private static void addDeviationList(final Module module,
 190             final DataContainerNodeBuilder<NodeIdentifierWithPredicates, MapEntryNode> mapEntryBuilder,
 191             final Module ietfYangLibraryModule, final SchemaContext context) {
 192         final DataSchemaNode deviationsSchema = findSchemaInListOfModulesSchema(
 193                 IetfYangLibrary.SPECIFIC_MODULE_DEVIATION_LIST_QNAME, ietfYangLibraryModule);
 194         final CollectionNodeBuilder<MapEntryNode, MapNode> deviations =
 195                 Builders.mapBuilder((ListSchemaNode) deviationsSchema);
 196         for (final Deviation deviation : module.getDeviations()) {
 197             final DataContainerNodeBuilder<NodeIdentifierWithPredicates, MapEntryNode> deviationEntryNode =
 198                     Builders.mapEntryBuilder((ListSchemaNode) deviationsSchema);
 199             final QName lastComponent = deviation.getTargetPath().getLastComponent();
 200             addChildOfModuleBySpecificModuleInternal(IetfYangLibrary.SPECIFIC_MODULE_NAME_LEAF_QNAME,
 201                     deviationEntryNode, context.findModule(lastComponent.getModule()).get().getName(),
 202                     ietfYangLibraryModule);
 203             if (lastComponent.getRevision().isPresent()) {
 204                 addChildOfModuleBySpecificModuleInternal(IetfYangLibrary.SPECIFIC_MODULE_REVISION_LEAF_QNAME,
 205                         deviationEntryNode, lastComponent.getRevision(),
 206                         ietfYangLibraryModule);
 207             }
 208             deviations.withChild(deviationEntryNode.build());
 209         }
 210         mapEntryBuilder.withChild(deviations.build());
 211     }
 212
 213     /**
 214      * Mapping features of specific module.
 215      *
 216      * @param qnameOfFeaturesLeafList
 217      *             qname of feature leaf-list in ietf-yang-library module
 218      * @param mapEntryBuilder
 219      *             mapEntryBuilder of parent for mapping children
 220      * @param features
 221      *             features of specific module
 222      * @param ietfYangLibraryModule
 223      *             ieat-yang-library module
 224      */
 225     private static void addFeatureLeafList(final QName qnameOfFeaturesLeafList,
 226             final DataContainerNodeBuilder<NodeIdentifierWithPredicates, MapEntryNode> mapEntryBuilder,
 227             final Set<FeatureDefinition> features, final Module ietfYangLibraryModule) {
 228         final DataSchemaNode schemaNode =
 229                 findSchemaInListOfModulesSchema(qnameOfFeaturesLeafList, ietfYangLibraryModule);
 230         final ListNodeBuilder<Object, LeafSetEntryNode<Object>> leafSetBuilder =
 231                 Builders.leafSetBuilder((LeafListSchemaNode) schemaNode);
 232         for (final FeatureDefinition feature : features) {
 233             leafSetBuilder.withChild(Builders.leafSetEntryBuilder((LeafListSchemaNode) schemaNode)
 234                     .withValue(feature.getQName().getLocalName()).build());
 235         }
 236         mapEntryBuilder.withChild(leafSetBuilder.build());
 237     }
 238
 239     /**
 240      * Mapping common leafs (grouping common-leafs in ietf-yang-library) of
 241      * specific module.
 242      *
 243      * @param module
 244      *             specific module for getting name and revision
 245      * @param mapEntryBuilder
 246      *             mapEntryBuilder of parent for mapping children
 247      * @param ietfYangLibraryModule
 248      *             ietf-yang-library module
 249      */
 250     private static void addCommonLeafs(final Module module,
 251             final DataContainerNodeBuilder<NodeIdentifierWithPredicates, MapEntryNode> mapEntryBuilder,
 252             final Module ietfYangLibraryModule) {
 253         addChildOfModuleBySpecificModuleInternal(IetfYangLibrary.SPECIFIC_MODULE_NAME_LEAF_QNAME, mapEntryBuilder,
 254                 module.getName(), ietfYangLibraryModule);
 255         addChildOfModuleBySpecificModuleInternal(IetfYangLibrary.SPECIFIC_MODULE_REVISION_LEAF_QNAME, mapEntryBuilder,
 256                 module.getQNameModule().getRevision().map(Revision::toString).orElse(""), ietfYangLibraryModule);
 257     }
 258
 259     /**
 260      * Mapping data child of grouping module-list by ietf-yang-library.
 261      *
 262      * @param specificQName
 263      *             qname of leaf in module-list grouping
 264      * @param mapEntryBuilder
 265      *             mapEntryBuilder of parent for mapping children
 266      * @param value
 267      *             value of leaf
 268      * @param ietfYangLibraryModule
 269      *             ietf-yang-library module
 270      */
 271     private static void addChildOfModuleBySpecificModuleOfListChild(final QName specificQName,
 272             final DataContainerNodeBuilder<NodeIdentifierWithPredicates, MapEntryNode> mapEntryBuilder,
 273             final Object value, final Module ietfYangLibraryModule) {
 274         final DataSchemaNode leafSch = findSchemaInListOfModulesSchema(specificQName, ietfYangLibraryModule);
 275         mapEntryBuilder.withChild(Builders.leafBuilder((LeafSchemaNode) leafSch).withValue(value).build());
 276     }
 277
 278     /**
 279      * Find specific schema in gourping module-lsit.
 280      *
 281      * @param specificQName
 282      *             qname of schema
 283      * @param ietfYangLibraryModule
 284      *             ietf-yang-library module
 285      * @return schemaNode of specific child
 286      */
 287     private static DataSchemaNode findSchemaInListOfModulesSchema(final QName specificQName,
 288             final Module ietfYangLibraryModule) {
 289         for (final GroupingDefinition groupingDefinition : ietfYangLibraryModule.getGroupings()) {
 290             if (groupingDefinition.getQName().equals(IetfYangLibrary.GROUPING_MODULE_LIST_QNAME)) {
 291                 final DataSchemaNode dataChildByName =
 292                         groupingDefinition.getDataChildByName(IetfYangLibrary.MODULE_QNAME_LIST);
 293                 return ((ListSchemaNode) dataChildByName).getDataChildByName(specificQName);
 294             }
 295         }
 296         throw new RestconfDocumentedException(specificQName.getLocalName() + " doesn't exist.");
 297     }
 298
 299     /**
 300      * Mapping data child of internal groupings in module-list grouping.
 301      *
 302      * @param specifiLeafQName
 303      *             qnmae of leaf for mapping
 304      * @param mapEntryBuilder
 305      *             mapEntryBuilder of parent for mapping children
 306      * @param value
 307      *             value of leaf
 308      * @param ietfYangLibraryModule
 309      *             ietf-yang-library module
 310      */
 311     private static void addChildOfModuleBySpecificModuleInternal(final QName specifiLeafQName,
 312             final DataContainerNodeBuilder<NodeIdentifierWithPredicates, MapEntryNode> mapEntryBuilder,
 313             final Object value, final Module ietfYangLibraryModule) {
 314         final DataSchemaNode nameLeaf = findNodeInInternGroupings(specifiLeafQName, ietfYangLibraryModule);
 315         mapEntryBuilder.withChild(Builders.leafBuilder((LeafSchemaNode) nameLeaf).withValue(value).build());
 316     }
 317
 318     /**
 319      * Find schema node of leaf by qname in internal groupings of module-list.
 320      * grouping
 321      *
 322      * @param qnameOfSchema
 323      *             qname of leaf
 324      * @param ietfYangLibraryModule
 325      *             ietf-yang-library module
 326      * @return schema node of specific leaf
 327      */
 328     private static DataSchemaNode findNodeInInternGroupings(final QName qnameOfSchema,
 329             final Module ietfYangLibraryModule) {
 330         for (final GroupingDefinition groupingDefinition : ietfYangLibraryModule.getGroupings()) {
 331             if (groupingDefinition.getQName().equals(IetfYangLibrary.GROUPING_MODULE_LIST_QNAME)) {
 332                 for (final GroupingDefinition internalGrouping : groupingDefinition.getGroupings()) {
 333                     if (internalGrouping.getDataChildByName(qnameOfSchema) != null) {
 334                         return internalGrouping.getDataChildByName(qnameOfSchema);
 335                     }
 336                 }
 337             }
 338         }
 339         throw new RestconfDocumentedException(qnameOfSchema.getLocalName() + " doesn't exist.");
 340     }
 341
 342     /**
 343      * Find schema of specific leaf in list-module grouping.
 344      *
 345      * @param qnameOfSchema
 346      *             qname of leaf
 347      * @param ietfYangLibraryModule
 348      *             ietf-yang-library module
 349      * @return schemaNode of specific leaf
 350      */
 351     private static DataSchemaNode findNodeInGroupings(final QName qnameOfSchema, final Module ietfYangLibraryModule) {
 352         for (final GroupingDefinition groupingDefinition : ietfYangLibraryModule.getGroupings()) {
 353             if (groupingDefinition.getDataChildByName(qnameOfSchema) != null) {
 354                 return groupingDefinition.getDataChildByName(qnameOfSchema);
 355             }
 356         }
 357         throw new RestconfDocumentedException(qnameOfSchema.getLocalName() + " doesn't exist.");
 358     }
 359
 360     /**
 361      * Map capabilites by ietf-restconf-monitoring.
 362      *
 363      * @param monitoringModule
 364      *             ietf-restconf-monitoring module
 365      * @return mapped capabilites
 366      */
 367     public static NormalizedNode<NodeIdentifier, Collection<DataContainerChild<? extends PathArgument, ?>>>
 368             mapCapabilites(final Module monitoringModule) {
 369         final DataSchemaNode restconfState =
 370                 monitoringModule.getDataChildByName(MonitoringModule.CONT_RESTCONF_STATE_QNAME);
 371         final DataContainerNodeBuilder<NodeIdentifier, ContainerNode> restStateContBuilder =
 372                 Builders.containerBuilder((ContainerSchemaNode) restconfState);
 373         final DataSchemaNode capabilitesContSchema =
 374                 getChildOfCont((ContainerSchemaNode) restconfState, MonitoringModule.CONT_CAPABILITES_QNAME);
 375         final DataContainerNodeBuilder<NodeIdentifier, ContainerNode> capabilitesContBuilder =
 376                 Builders.containerBuilder((ContainerSchemaNode) capabilitesContSchema);
 377         final DataSchemaNode leafListCapa = getChildOfCont((ContainerSchemaNode) capabilitesContSchema,
 378                 MonitoringModule.LEAF_LIST_CAPABILITY_QNAME);
 379         final ListNodeBuilder<Object, LeafSetEntryNode<Object>> leafListCapaBuilder =
 380                 Builders.orderedLeafSetBuilder((LeafListSchemaNode) leafListCapa);
 381         fillLeafListCapa(leafListCapaBuilder, (LeafListSchemaNode) leafListCapa);
 382
 383         return restStateContBuilder.withChild(capabilitesContBuilder.withChild(leafListCapaBuilder.build()).build())
 384                 .build();
 385     }
 386
 387     /**
 388      * Map data to leaf-list.
 389      *
 390      * @param builder
 391      *             builder of parent for children
 392      * @param leafListSchema
 393      *             leaf list schema
 394      */
 395     @SuppressWarnings({ "unchecked", "rawtypes" })
 396     private static void fillLeafListCapa(final ListNodeBuilder builder, final LeafListSchemaNode leafListSchema) {
 397         builder.withChild(leafListEntryBuild(leafListSchema, QueryParams.DEPTH));
 398         builder.withChild(leafListEntryBuild(leafListSchema, QueryParams.FIELDS));
 399         builder.withChild(leafListEntryBuild(leafListSchema, QueryParams.FILTER));
 400         builder.withChild(leafListEntryBuild(leafListSchema, QueryParams.REPLAY));
 401         builder.withChild(leafListEntryBuild(leafListSchema, QueryParams.WITH_DEFAULTS));
 402     }
 403
 404     /**
 405      * Map value to leaf list entry node.
 406      *
 407      * @param leafListSchema
 408      *             leaf list schema of leaf list entry
 409      * @param value
 410      *             value of leaf entry
 411      * @return entry node
 412      */
 413     @SuppressWarnings("rawtypes")
 414     private static LeafSetEntryNode leafListEntryBuild(final LeafListSchemaNode leafListSchema, final String value) {
 415         return Builders.leafSetEntryBuilder(leafListSchema).withValue(value).build();
 416     }
 417
 418     /**
 419      * Find specific schema node by qname in parent {@link ContainerSchemaNode}.
 420      *
 421      * @param parent
 422      *             schemaNode
 423      * @param childQName
 424      *             specific qname of child
 425      * @return schema node of child by qname
 426      */
 427     private static DataSchemaNode getChildOfCont(final ContainerSchemaNode parent, final QName childQName) {
 428         for (final DataSchemaNode child : parent.getChildNodes()) {
 429             if (child.getQName().equals(childQName)) {
 430                 return child;
 431             }
 432         }
 433         throw new RestconfDocumentedException(
 434                 childQName.getLocalName() + " doesn't exist in container " + MonitoringModule.CONT_RESTCONF_STATE_NAME);
 435     }
 436
 437     /**
 438      * Map data of yang notification to normalized node according to
 439      * ietf-restconf-monitoring.
 440      *
 441      * @param notifiQName
 442      *             qname of notification from listener
 443      * @param notifications
 444      *             list of notifications for find schema of notification by
 445      *            notifiQName
 446      * @param start
 447      *             start-time query parameter of notification
 448      * @param outputType
 449      *             output type of notification
 450      * @param uri
 451      *             location of registered listener for sending data of
 452      *            notification
 453      * @param monitoringModule
 454      *             ietf-restconf-monitoring module
 455      * @param existParent
 456      *             true if data of parent -
 457      *            ietf-restconf-monitoring:restconf-state/streams - exist in DS
 458      * @return mapped data of notification - map entry node if parent exists,
 459      *         container streams with list and map entry node if not
 460      */
 461     @SuppressWarnings("rawtypes")
 462     public static NormalizedNode mapYangNotificationStreamByIetfRestconfMonitoring(final QName notifiQName,
 463             final Set<NotificationDefinition> notifications, final Instant start, final String outputType,
 464             final URI uri, final Module monitoringModule, final boolean existParent) {
 465         for (final NotificationDefinition notificationDefinition : notifications) {
 466             if (notificationDefinition.getQName().equals(notifiQName)) {
 467                 final DataSchemaNode streamListSchema = ((ContainerSchemaNode) ((ContainerSchemaNode) monitoringModule
 468                         .getDataChildByName(MonitoringModule.CONT_RESTCONF_STATE_QNAME))
 469                                 .getDataChildByName(MonitoringModule.CONT_STREAMS_QNAME))
 470                                         .getDataChildByName(MonitoringModule.LIST_STREAM_QNAME);
 471                 final DataContainerNodeBuilder<NodeIdentifierWithPredicates, MapEntryNode> streamEntry =
 472                         Builders.mapEntryBuilder((ListSchemaNode) streamListSchema);
 473
 474                 final ListSchemaNode listSchema = (ListSchemaNode) streamListSchema;
 475                 prepareLeafAndFillEntryBuilder(streamEntry,
 476                         listSchema.getDataChildByName(MonitoringModule.LEAF_NAME_STREAM_QNAME),
 477                         notificationDefinition.getQName().getLocalName());
 478
 479                 final java.util.Optional<String> optDesc = notificationDefinition.getDescription();
 480                 if (optDesc.isPresent()) {
 481                     prepareLeafAndFillEntryBuilder(streamEntry,
 482                             listSchema.getDataChildByName(MonitoringModule.LEAF_DESCR_STREAM_QNAME), optDesc.get());
 483                 }
 484                 prepareLeafAndFillEntryBuilder(streamEntry,
 485                         listSchema.getDataChildByName(MonitoringModule.LEAF_REPLAY_SUPP_STREAM_QNAME), true);
 486                 if (start != null) {
 487                     prepareLeafAndFillEntryBuilder(streamEntry,
 488                         listSchema.getDataChildByName(MonitoringModule.LEAF_START_TIME_STREAM_QNAME),
 489                         DateTimeFormatter.ISO_OFFSET_DATE_TIME.format(OffsetDateTime.ofInstant(start,
 490                             ZoneId.systemDefault())));
 491                 }
 492                 prepareListAndFillEntryBuilder(streamEntry,
 493                         (ListSchemaNode) listSchema.getDataChildByName(MonitoringModule.LIST_ACCESS_STREAM_QNAME),
 494                         outputType, uri);
 495
 496                 if (!existParent) {
 497                     final DataSchemaNode contStreamsSchema = ((ContainerSchemaNode) monitoringModule
 498                             .getDataChildByName(MonitoringModule.CONT_RESTCONF_STATE_QNAME))
 499                                     .getDataChildByName(MonitoringModule.CONT_STREAMS_QNAME);
 500                     return Builders.containerBuilder((ContainerSchemaNode) contStreamsSchema).withChild(Builders
 501                             .mapBuilder((ListSchemaNode) streamListSchema).withChild(streamEntry.build()).build())
 502                             .build();
 503                 }
 504                 return streamEntry.build();
 505             }
 506         }
 507
 508         throw new RestconfDocumentedException(notifiQName + " doesn't exist in any modul");
 509     }
 510
 511     private static void prepareListAndFillEntryBuilder(
 512             final DataContainerNodeBuilder<NodeIdentifierWithPredicates, MapEntryNode> streamEntry,
 513             final ListSchemaNode listSchemaNode, final String outputType, final URI uriToWebsocketServer) {
 514         final CollectionNodeBuilder<MapEntryNode, MapNode> accessListBuilder = Builders.mapBuilder(listSchemaNode);
 515         final DataContainerNodeBuilder<NodeIdentifierWithPredicates, MapEntryNode> entryAccessList =
 516                 Builders.mapEntryBuilder(listSchemaNode);
 517         prepareLeafAndFillEntryBuilder(entryAccessList,
 518                 listSchemaNode.getDataChildByName(MonitoringModule.LEAF_ENCODING_ACCESS_QNAME), outputType);
 519         prepareLeafAndFillEntryBuilder(entryAccessList,
 520                 listSchemaNode.getDataChildByName(MonitoringModule.LEAF_LOCATION_ACCESS_QNAME),
 521                 uriToWebsocketServer.toString());
 522         streamEntry.withChild(accessListBuilder.withChild(entryAccessList.build()).build());
 523     }
 524
 525     /**
 526      * Prepare leaf and fill entry builder.
 527      *
 528      * @param streamEntry   Stream entry
 529      * @param leafSchema    Leaf schema
 530      * @param value         Value
 531      */
 532     private static void prepareLeafAndFillEntryBuilder(
 533             final DataContainerNodeBuilder<NodeIdentifierWithPredicates, MapEntryNode> streamEntry,
 534             final DataSchemaNode leafSchema, final Object value) {
 535         streamEntry.withChild(Builders.leafBuilder((LeafSchemaNode) leafSchema).withValue(value).build());
 536     }
 537
 538     /**
 539      * Map data of data change notification to normalized node according to
 540      * ietf-restconf-monitoring.
 541      *
 542      * @param path
 543      *             path of data to listen on
 544      * @param start
 545      *             start-time query parameter of notification
 546      * @param outputType
 547      *             output type of notification
 548      * @param uri
 549      *             location of registered listener for sending data of
 550      *            notification
 551      * @param monitoringModule
 552      *             ietf-restconf-monitoring module
 553      * @param existParent
 554      *             true if data of parent -
 555      *            ietf-restconf-monitoring:restconf-state/streams - exist in DS
 556      * @param schemaContext
 557      *             schemaContext for parsing instance identifier to get schema
 558      *            node of data
 559      * @return mapped data of notification - map entry node if parent exists,
 560      *         container streams with list and map entry node if not
 561      */
 562     @SuppressWarnings("rawtypes")
 563     public static NormalizedNode mapDataChangeNotificationStreamByIetfRestconfMonitoring(
 564             final YangInstanceIdentifier path, final Instant start, final String outputType, final URI uri,
 565             final Module monitoringModule, final boolean existParent, final SchemaContext schemaContext) {
 566         final SchemaNode schemaNode = ParserIdentifier
 567                 .toInstanceIdentifier(ParserIdentifier.stringFromYangInstanceIdentifier(path, schemaContext),
 568                         schemaContext, Optional.empty())
 569                 .getSchemaNode();
 570         final DataSchemaNode streamListSchema = ((ContainerSchemaNode) ((ContainerSchemaNode) monitoringModule
 571                 .getDataChildByName(MonitoringModule.CONT_RESTCONF_STATE_QNAME))
 572                         .getDataChildByName(MonitoringModule.CONT_STREAMS_QNAME))
 573                                 .getDataChildByName(MonitoringModule.LIST_STREAM_QNAME);
 574         final DataContainerNodeBuilder<NodeIdentifierWithPredicates, MapEntryNode> streamEntry =
 575                 Builders.mapEntryBuilder((ListSchemaNode) streamListSchema);
 576
 577         final ListSchemaNode listSchema = (ListSchemaNode) streamListSchema;
 578         prepareLeafAndFillEntryBuilder(streamEntry,
 579                 listSchema.getDataChildByName(MonitoringModule.LEAF_NAME_STREAM_QNAME),
 580                 schemaNode.getQName().getLocalName());
 581
 582         final java.util.Optional<String> optDesc = schemaNode.getDescription();
 583         if (optDesc.isPresent()) {
 584             prepareLeafAndFillEntryBuilder(streamEntry,
 585                     listSchema.getDataChildByName(MonitoringModule.LEAF_DESCR_STREAM_QNAME), optDesc.get());
 586         }
 587         prepareLeafAndFillEntryBuilder(streamEntry,
 588                 listSchema.getDataChildByName(MonitoringModule.LEAF_REPLAY_SUPP_STREAM_QNAME), true);
 589         prepareLeafAndFillEntryBuilder(streamEntry,
 590                 listSchema.getDataChildByName(MonitoringModule.LEAF_START_TIME_STREAM_QNAME),
 591                 DateTimeFormatter.ISO_OFFSET_DATE_TIME.format(OffsetDateTime.ofInstant(start, ZoneId.systemDefault())));
 592         prepareListAndFillEntryBuilder(streamEntry,
 593                 (ListSchemaNode) listSchema.getDataChildByName(MonitoringModule.LIST_ACCESS_STREAM_QNAME), outputType,
 594                 uri);
 595
 596         if (!existParent) {
 597             final DataSchemaNode contStreamsSchema = ((ContainerSchemaNode) monitoringModule
 598                     .getDataChildByName(MonitoringModule.CONT_RESTCONF_STATE_QNAME))
 599                             .getDataChildByName(MonitoringModule.CONT_STREAMS_QNAME);
 600             return Builders
 601                     .containerBuilder((ContainerSchemaNode) contStreamsSchema).withChild(Builders
 602                             .mapBuilder((ListSchemaNode) streamListSchema).withChild(streamEntry.build()).build())
 603                     .build();
 604         }
 605         return streamEntry.build();
 606     }
 607 }