Make ListenerAdapter serialize JSON directly
[netconf.git] / restconf / restconf-nb-rfc8040 / src / main / java / org / opendaylight / restconf / nb / rfc8040 / streams / listeners / NotificationListenerAdapter.java
index c1cbdd98f80ac53ac1e8dc4904fb2d48b7218c35..9745083dc58907be22621d11dbbb89873c225943 100644 (file)
@@ -12,29 +12,20 @@ import static java.util.Objects.requireNonNull;
 
 import com.google.common.annotations.VisibleForTesting;
 import com.google.common.base.MoreObjects;
-import com.google.gson.JsonObject;
-import com.google.gson.JsonParser;
-import java.io.IOException;
-import java.io.StringWriter;
-import java.io.Writer;
 import java.time.Instant;
-import javax.xml.stream.XMLStreamException;
-import javax.xml.transform.dom.DOMResult;
+import java.util.Optional;
+import javax.xml.xpath.XPathExpressionException;
 import org.opendaylight.mdsal.dom.api.DOMNotification;
 import org.opendaylight.mdsal.dom.api.DOMNotificationListener;
-import org.opendaylight.restconf.common.errors.RestconfDocumentedException;
-import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
-import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeWriter;
+import org.opendaylight.restconf.common.formatters.JSONNotificationFormatter;
+import org.opendaylight.restconf.common.formatters.NotificationFormatter;
+import org.opendaylight.restconf.common.formatters.NotificationFormatterFactory;
+import org.opendaylight.restconf.common.formatters.XMLNotificationFormatter;
+import org.opendaylight.yang.gen.v1.urn.sal.restconf.event.subscription.rev140708.NotificationOutputTypeGrouping.NotificationOutputType;
 import org.opendaylight.yangtools.yang.data.codec.gson.JSONCodecFactorySupplier;
-import org.opendaylight.yangtools.yang.data.codec.gson.JSONNormalizedNodeStreamWriter;
-import org.opendaylight.yangtools.yang.data.codec.gson.JsonWriterFactory;
-import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier.Absolute;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
-import org.w3c.dom.Document;
-import org.w3c.dom.Element;
-import org.w3c.dom.Node;
 
 /**
  * {@link NotificationListenerAdapter} is responsible to track events on notifications.
@@ -42,10 +33,15 @@ import org.w3c.dom.Node;
 public class NotificationListenerAdapter extends AbstractCommonSubscriber implements DOMNotificationListener {
 
     private static final Logger LOG = LoggerFactory.getLogger(NotificationListenerAdapter.class);
+    private static final NotificationFormatterFactory JSON_FORMATTER_FACTORY = JSONNotificationFormatter.createFactory(
+            JSONCodecFactorySupplier.RFC7951);
 
     private final String streamName;
     private final Absolute path;
-    private final String outputType;
+    private final NotificationOutputType outputType;
+
+    @VisibleForTesting NotificationFormatter formatter;
+
 
     /**
      * Set path of listener and stream name.
@@ -57,10 +53,41 @@ public class NotificationListenerAdapter extends AbstractCommonSubscriber implem
     NotificationListenerAdapter(final Absolute path, final String streamName, final String outputType) {
         setLocalNameOfPath(path.lastNodeIdentifier().getLocalName());
 
-        this.outputType = requireNonNull(outputType);
+        this.outputType = NotificationOutputType.forName(requireNonNull(outputType)).get();
         this.path = requireNonNull(path);
         this.streamName = requireNonNull(streamName);
         checkArgument(!streamName.isEmpty());
+
+        LOG.info("output type: {}, {}", outputType, this.outputType);
+
+        this.formatter = getFormatterFactory().getFormatter();
+    }
+
+    private NotificationFormatterFactory getFormatterFactory() {
+        switch (outputType) {
+            case JSON:
+                return JSON_FORMATTER_FACTORY;
+            case XML:
+                return XMLNotificationFormatter.FACTORY;
+            default:
+                throw new IllegalArgumentException(("Unsupported outputType" + outputType));
+        }
+    }
+
+    private NotificationFormatter getFormatter(final String filter) throws XPathExpressionException {
+        NotificationFormatterFactory factory = getFormatterFactory();
+        return filter == null || filter.isEmpty() ? factory.getFormatter() : factory.getFormatter(filter);
+    }
+
+    @Override
+    public void setQueryParams(Instant start, Instant stop, String filter, boolean leafNodesOnly,
+                               boolean skipNotificationData) {
+        super.setQueryParams(start, stop, filter, leafNodesOnly, skipNotificationData);
+        try {
+            this.formatter = getFormatter(filter);
+        } catch (XPathExpressionException e) {
+            throw new IllegalArgumentException("Failed to get filter", e);
+        }
     }
 
     /**
@@ -70,20 +97,27 @@ public class NotificationListenerAdapter extends AbstractCommonSubscriber implem
      */
     @Override
     public String getOutputType() {
-        return this.outputType;
+        return this.outputType.getName();
     }
 
     @Override
+    @SuppressWarnings("checkstyle:IllegalCatch")
     public void onNotification(final DOMNotification notification) {
         final Instant now = Instant.now();
         if (!checkStartStop(now, this)) {
             return;
         }
 
-        final EffectiveModelContext schemaContext = schemaHandler.get();
-        final String xml = prepareXml(schemaContext, notification);
-        if (checkFilter(xml)) {
-            post(outputType.equals("JSON") ? prepareJson(schemaContext, notification) : xml);
+        final Optional<String> maybeOutput;
+        try {
+            maybeOutput = formatter.eventData(schemaHandler.get(), notification, now, getLeafNodesOnly(),
+                    isSkipNotificationData());
+        } catch (Exception e) {
+            LOG.error("Failed to process notification {}", notification, e);
+            return;
+        }
+        if (maybeOutput.isPresent()) {
+            post(maybeOutput.get());
         }
     }
 
@@ -106,68 +140,6 @@ public class NotificationListenerAdapter extends AbstractCommonSubscriber implem
         return this.path;
     }
 
-    /**
-     * Creation of JSON from notification data.
-     *
-     * @return Transformed notification data in JSON format.
-     */
-    @VisibleForTesting
-    String prepareJson(final EffectiveModelContext schemaContext, final DOMNotification notification) {
-        final JsonParser jsonParser = new JsonParser();
-        final JsonObject json = new JsonObject();
-        json.add("ietf-restconf:notification", jsonParser.parse(writeBodyToString(schemaContext, notification)));
-        json.addProperty("event-time", ListenerAdapter.toRFC3339(Instant.now()));
-        return json.toString();
-    }
-
-    private static String writeBodyToString(final EffectiveModelContext schemaContext,
-            final DOMNotification notification) {
-        final Writer writer = new StringWriter();
-        final NormalizedNodeStreamWriter jsonStream = JSONNormalizedNodeStreamWriter.createExclusiveWriter(
-                JSONCodecFactorySupplier.DRAFT_LHOTKA_NETMOD_YANG_JSON_02.getShared(schemaContext),
-                notification.getType(), null, JsonWriterFactory.createJsonWriter(writer));
-        final NormalizedNodeWriter nodeWriter = NormalizedNodeWriter.forStreamWriter(jsonStream);
-        try {
-            nodeWriter.write(notification.getBody());
-            nodeWriter.close();
-        } catch (final IOException e) {
-            throw new RestconfDocumentedException("Problem while writing body of notification to JSON. ", e);
-        }
-        return writer.toString();
-    }
-
-    /**
-     * Creation of XML from notification data.
-     *
-     * @return Transformed notification data in XML format.
-     */
-    private String prepareXml(final EffectiveModelContext schemaContext, final DOMNotification notification) {
-        final Document doc = createDocument();
-        final Element notificationElement = basePartDoc(doc);
-
-        final Element notificationEventElement = doc.createElementNS(
-                "urn:opendaylight:params:xml:ns:yang:controller:md:sal:remote", "create-notification-stream");
-        addValuesToNotificationEventElement(doc, notificationEventElement, schemaContext, notification);
-        notificationElement.appendChild(notificationEventElement);
-
-        return transformDoc(doc);
-    }
-
-    private void addValuesToNotificationEventElement(final Document doc, final Element element,
-            final EffectiveModelContext schemaContext, final DOMNotification notification) {
-        try {
-            final DOMResult domResult = writeNormalizedNode(notification.getBody(), schemaContext, path.asSchemaPath());
-            final Node result = doc.importNode(domResult.getNode().getFirstChild(), true);
-            final Element dataElement = doc.createElement("notification");
-            dataElement.appendChild(result);
-            element.appendChild(dataElement);
-        } catch (final IOException e) {
-            LOG.error("Error in writer ", e);
-        } catch (final XMLStreamException e) {
-            LOG.error("Error processing stream", e);
-        }
-    }
-
     @Override
     public String toString() {
         return MoreObjects.toStringHelper(this)