netconf/mdsal-netconf-notification/src/main/java/org/opendaylight/netconf/mdsal/notification/impl/ops/NotificationsTransformUtil.java

   1 /*
   2  * Copyright (c) 2015 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.netconf.mdsal.notification.impl.ops;
   9
  10 import static com.google.common.base.Preconditions.checkState;
  11 import static java.util.Objects.requireNonNull;
  12
  13 import com.google.common.collect.Collections2;
  14 import com.google.common.collect.Iterables;
  15 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
  16 import java.io.IOException;
  17 import java.util.Collections;
  18 import java.util.Date;
  19 import java.util.Optional;
  20 import javax.xml.stream.XMLStreamException;
  21 import javax.xml.transform.dom.DOMResult;
  22 import org.opendaylight.mdsal.binding.dom.codec.impl.BindingNormalizedNodeCodecRegistry;
  23 import org.opendaylight.mdsal.binding.generator.impl.ModuleInfoBackedContext;
  24 import org.opendaylight.mdsal.binding.generator.util.BindingRuntimeContext;
  25 import org.opendaylight.netconf.api.xml.XmlUtil;
  26 import org.opendaylight.netconf.notifications.NetconfNotification;
  27 import org.opendaylight.netconf.util.NetconfUtil;
  28 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netmod.notification.rev080714.$YangModuleInfoImpl;
  29 import org.opendaylight.yangtools.yang.binding.Notification;
  30 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  31 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
  32 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  33 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  34 import org.w3c.dom.Document;
  35
  36 public final class NotificationsTransformUtil {
  37     static final SchemaContext NOTIFICATIONS_SCHEMA_CTX;
  38     static final BindingNormalizedNodeCodecRegistry CODEC_REGISTRY;
  39     static final RpcDefinition CREATE_SUBSCRIPTION_RPC;
  40
  41     static {
  42         final ModuleInfoBackedContext moduleInfoBackedContext = ModuleInfoBackedContext.create();
  43         moduleInfoBackedContext.addModuleInfos(Collections.singletonList($YangModuleInfoImpl.getInstance()));
  44         moduleInfoBackedContext.addModuleInfos(Collections.singletonList(org.opendaylight.yang.gen.v1.urn.ietf.params
  45                 .xml.ns.yang.ietf.netconf.notifications.rev120206.$YangModuleInfoImpl.getInstance()));
  46         final Optional<SchemaContext> schemaContextOptional = moduleInfoBackedContext.tryToCreateSchemaContext();
  47         checkState(schemaContextOptional.isPresent());
  48         NOTIFICATIONS_SCHEMA_CTX = schemaContextOptional.get();
  49
  50         CREATE_SUBSCRIPTION_RPC = requireNonNull(findCreateSubscriptionRpc());
  51
  52         CODEC_REGISTRY = new BindingNormalizedNodeCodecRegistry(BindingRuntimeContext.create(moduleInfoBackedContext,
  53                 NOTIFICATIONS_SCHEMA_CTX));
  54     }
  55
  56     private NotificationsTransformUtil() {
  57
  58     }
  59
  60     @SuppressFBWarnings(value = "NP_NONNULL_PARAM_VIOLATION", justification = "Unrecognised NullableDecl")
  61     private static RpcDefinition findCreateSubscriptionRpc() {
  62         return Iterables.getFirst(Collections2.filter(NOTIFICATIONS_SCHEMA_CTX.getOperations(),
  63             input -> input.getQName().getLocalName().equals(CreateSubscription.CREATE_SUBSCRIPTION)), null);
  64     }
  65
  66     /**
  67      * Transform base notification for capabilities into NetconfNotification.
  68      */
  69     public static NetconfNotification transform(final Notification notification, final SchemaPath path) {
  70         return transform(notification, Optional.empty(), path);
  71     }
  72
  73     public static NetconfNotification transform(final Notification notification, final Date eventTime,
  74             final SchemaPath path) {
  75         return transform(notification, Optional.ofNullable(eventTime), path);
  76     }
  77
  78     private static NetconfNotification transform(final Notification notification, final Optional<Date> eventTime,
  79             final SchemaPath path) {
  80         final ContainerNode containerNode = CODEC_REGISTRY.toNormalizedNodeNotification(notification);
  81         final DOMResult result = new DOMResult(XmlUtil.newDocument());
  82         try {
  83             NetconfUtil.writeNormalizedNode(containerNode, result, path, NOTIFICATIONS_SCHEMA_CTX);
  84         } catch (final XMLStreamException | IOException e) {
  85             throw new IllegalStateException("Unable to serialize " + notification, e);
  86         }
  87         final Document node = (Document) result.getNode();
  88         return eventTime.isPresent() ? new NetconfNotification(node, eventTime.get()) : new NetconfNotification(node);
  89     }
  90
  91 }