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