yang/yang-data-util/src/main/java/org/opendaylight/yangtools/yang/data/util/MountPointData.java

   1 /*
   2  * Copyright (c) 2019 PANTHEON.tech s.r.o. 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.yangtools.yang.data.util;
   9
  10 import static com.google.common.base.Preconditions.checkState;
  11 import static java.util.Objects.requireNonNull;
  12
  13 import com.google.common.annotations.Beta;
  14 import java.io.IOException;
  15 import java.util.ArrayList;
  16 import java.util.EnumMap;
  17 import java.util.List;
  18 import java.util.Map;
  19 import java.util.Map.Entry;
  20 import java.util.Optional;
  21 import org.eclipse.jdt.annotation.NonNull;
  22 import org.opendaylight.yangtools.concepts.AbstractIdentifiable;
  23 import org.opendaylight.yangtools.rfc8528.data.api.MountPointIdentifier;
  24 import org.opendaylight.yangtools.rfc8528.data.api.MountPointNodeFactory;
  25 import org.opendaylight.yangtools.rfc8528.data.api.MountPointNodeFactoryResolver;
  26 import org.opendaylight.yangtools.rfc8528.data.api.MountPointNodeFactoryResolver.Inline;
  27 import org.opendaylight.yangtools.rfc8528.data.api.MountPointNodeFactoryResolver.Inline.LibraryContext;
  28 import org.opendaylight.yangtools.rfc8528.data.api.MountPointNodeFactoryResolver.SharedSchema;
  29 import org.opendaylight.yangtools.rfc8528.data.api.MountPointStreamWriter;
  30 import org.opendaylight.yangtools.rfc8528.data.api.YangLibraryConstants.ContainerName;
  31 import org.opendaylight.yangtools.yang.common.QName;
  32 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  33 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  34 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
  35 import org.opendaylight.yangtools.yang.model.parser.api.YangParserException;
  36 import org.slf4j.Logger;
  37 import org.slf4j.LoggerFactory;
  38
  39 /**
  40  * YANG Schema Mount-supported data attached to either a {@code list} item or a {@code container}.
  41  */
  42 @Beta
  43 public final class MountPointData extends AbstractIdentifiable<MountPointIdentifier> {
  44     private static final Logger LOG = LoggerFactory.getLogger(MountPointData.class);
  45
  46     private final Map<ContainerName, MountPointChild> yangLib = new EnumMap<>(ContainerName.class);
  47     private final List<MountPointChild> children = new ArrayList<>();
  48
  49     private MountPointChild schemaMounts;
  50
  51     MountPointData(final QName label) {
  52         super(MountPointIdentifier.of(label));
  53     }
  54
  55     public void setContainer(final @NonNull ContainerName containerName, final @NonNull MountPointChild data) {
  56         final MountPointChild prev = yangLib.putIfAbsent(containerName, requireNonNull(data));
  57         checkState(prev == null, "Attempted to duplicate container %s data %s with %s", containerName, prev, data);
  58         addChild(data);
  59     }
  60
  61     public void setSchemaMounts(final @NonNull MountPointChild data) {
  62         checkState(schemaMounts == null, "Attempted to reset schema-mounts from %s to %s", schemaMounts, data);
  63         schemaMounts = requireNonNull(data);
  64         addChild(data);
  65     }
  66
  67     public void addChild(final @NonNull MountPointChild data) {
  68         children.add(requireNonNull(data));
  69     }
  70
  71     void write(final @NonNull NormalizedNodeStreamWriter writer) throws IOException {
  72         final MountPointStreamWriter mountWriter = writer.getExtensions().getInstance(MountPointStreamWriter.class);
  73         if (mountWriter == null) {
  74             LOG.debug("Writer {} does not support mount points, ignoring data in {}", writer, getIdentifier());
  75             return;
  76         }
  77
  78         final Optional<MountPointNodeFactoryResolver> optResolver = mountWriter.findMountPoint(getIdentifier());
  79         if (!optResolver.isPresent()) {
  80             LOG.debug("Mount point for {} is not present, ignoring it", getIdentifier());
  81             return;
  82         }
  83
  84         final MountPointNodeFactoryResolver resolver = optResolver.get();
  85         if (resolver instanceof SharedSchema) {
  86             writeTo(mountWriter, ((SharedSchema) resolver).getSchema());
  87         } else if (resolver instanceof Inline) {
  88             writeInline(mountWriter, (Inline) resolver);
  89         } else {
  90             throw new IOException("Unhandled resolver " + resolver);
  91         }
  92     }
  93
  94     private void writeInline(final @NonNull MountPointStreamWriter mountWriter, final Inline resolver)
  95             throws IOException {
  96         for (Entry<ContainerName, MountPointChild> entry : yangLib.entrySet()) {
  97             final Optional<LibraryContext> optLibContext = resolver.findSchemaForLibrary(entry.getKey());
  98             if (!optLibContext.isPresent()) {
  99                 LOG.debug("YANG Library context for mount point {} container {} not found", getIdentifier(),
 100                     entry.getKey());
 101                 continue;
 102             }
 103
 104             final LibraryContext libContext = optLibContext.get();
 105             final NormalizedNode<?, ?> data = entry.getValue().normalizeTo(libContext.getLibraryContainerSchema());
 106             if (!(data instanceof ContainerNode)) {
 107                 throw new IOException("Invalid non-container " + data);
 108             }
 109
 110             final MountPointNodeFactory factory;
 111             try {
 112                 factory = libContext.bindTo((ContainerNode) data);
 113             } catch (YangParserException e) {
 114                 throw new IOException("Failed to assemble context for " + data, e);
 115             }
 116
 117             writeTo(mountWriter, factory);
 118             return;
 119         }
 120
 121         LOG.warn("Failed to create a dynamic context for mount point {}, ignoring its data", getIdentifier());
 122     }
 123
 124     private void writeTo(final @NonNull MountPointStreamWriter mountWriter,
 125             final @NonNull MountPointNodeFactory mountMeta) throws IOException {
 126         try (NormalizedNodeStreamWriter writer = mountWriter.startMountPoint(mountMeta)) {
 127             for (MountPointChild child : children) {
 128                 child.writeTo(writer, mountMeta.getSchemaContext());
 129             }
 130         }
 131     }
 132 }