restconf/restconf-nb-bierman02/src/main/java/org/opendaylight/netconf/sal/streams/listeners/AbstractQueryParams.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.netconf.sal.streams.listeners;
   9
  10 import static java.util.Objects.requireNonNull;
  11
  12 import com.google.common.annotations.VisibleForTesting;
  13 import java.io.StringReader;
  14 import java.time.Instant;
  15 import java.util.Optional;
  16 import javax.xml.XMLConstants;
  17 import javax.xml.parsers.DocumentBuilderFactory;
  18 import javax.xml.parsers.ParserConfigurationException;
  19 import javax.xml.xpath.XPath;
  20 import javax.xml.xpath.XPathConstants;
  21 import javax.xml.xpath.XPathFactory;
  22 import org.opendaylight.restconf.common.errors.RestconfDocumentedException;
  23 import org.w3c.dom.Document;
  24 import org.xml.sax.InputSource;
  25
  26 /**
  27  * Features of query parameters part of both notifications.
  28  *
  29  */
  30 abstract class AbstractQueryParams extends AbstractNotificationsData {
  31     // FIXME: BUG-7956: switch to using UntrustedXML
  32     private static final DocumentBuilderFactory DBF;
  33
  34     static {
  35         final DocumentBuilderFactory f = DocumentBuilderFactory.newInstance();
  36         f.setCoalescing(true);
  37         f.setExpandEntityReferences(false);
  38         f.setIgnoringElementContentWhitespace(true);
  39         f.setIgnoringComments(true);
  40         f.setXIncludeAware(false);
  41         try {
  42             f.setFeature(XMLConstants.FEATURE_SECURE_PROCESSING, true);
  43             f.setFeature("http://apache.org/xml/features/disallow-doctype-decl", true);
  44             f.setFeature("http://xml.org/sax/features/external-general-entities", false);
  45             f.setFeature("http://xml.org/sax/features/external-parameter-entities", false);
  46         } catch (final ParserConfigurationException e) {
  47             throw new ExceptionInInitializerError(e);
  48         }
  49         DBF = f;
  50     }
  51
  52     // FIXME: these should be final
  53     private Instant start = null;
  54     private Instant stop = null;
  55     private String filter = null;
  56     private boolean leafNodesOnly = false;
  57
  58     @VisibleForTesting
  59     public final Instant getStart() {
  60         return start;
  61     }
  62
  63     /**
  64      * Set query parameters for listener.
  65      *
  66      * @param start
  67      *            start-time of getting notification
  68      * @param stop
  69      *            stop-time of getting notification
  70      * @param filter
  71      *            indicate which subset of all possible events are of interest
  72      * @param leafNodesOnly
  73      *            if true, notifications will contain changes to leaf nodes only
  74      */
  75     @SuppressWarnings("checkstyle:hiddenField")
  76     public void setQueryParams(final Instant start, final Optional<Instant> stop, final Optional<String> filter,
  77                                final boolean leafNodesOnly) {
  78         this.start = requireNonNull(start);
  79         this.stop = stop.orElse(null);
  80         this.filter = filter.orElse(null);
  81         this.leafNodesOnly = leafNodesOnly;
  82     }
  83
  84     /**
  85      * Check whether this query should only notify about leaf node changes.
  86      *
  87      * @return true if this query should only notify about leaf node changes
  88      */
  89     public boolean getLeafNodesOnly() {
  90         return leafNodesOnly;
  91     }
  92
  93     @SuppressWarnings("checkstyle:IllegalCatch")
  94     <T extends BaseListenerInterface> boolean checkStartStop(final Instant now, final T listener) {
  95         if (this.stop != null) {
  96             if (this.start.compareTo(now) < 0 && this.stop.compareTo(now) > 0) {
  97                 return true;
  98             }
  99             if (this.stop.compareTo(now) < 0) {
 100                 try {
 101                     listener.close();
 102                 } catch (final Exception e) {
 103                     throw new RestconfDocumentedException("Problem with unregister listener." + e);
 104                 }
 105             }
 106         } else if (this.start != null) {
 107             if (this.start.compareTo(now) < 0) {
 108                 this.start = null;
 109                 return true;
 110             }
 111         } else {
 112             return true;
 113         }
 114         return false;
 115     }
 116
 117     /**
 118      * Check if is filter used and then prepare and post data do client.
 119      *
 120      * @param xml   data of notification
 121      */
 122     @SuppressWarnings("checkstyle:IllegalCatch")
 123     boolean checkFilter(final String xml) {
 124         if (this.filter == null) {
 125             return true;
 126         }
 127
 128         try {
 129             return parseFilterParam(xml);
 130         } catch (final Exception e) {
 131             throw new RestconfDocumentedException("Problem while parsing filter.", e);
 132         }
 133     }
 134
 135     /**
 136      * Parse and evaluate filter value by xml.
 137      *
 138      * @return true or false - depends on filter expression and data of
 139      *         notifiaction
 140      * @throws Exception if operation fails
 141      */
 142     private boolean parseFilterParam(final String xml) throws Exception {
 143         final Document docOfXml = DBF.newDocumentBuilder().parse(new InputSource(new StringReader(xml)));
 144         final XPath xPath = XPathFactory.newInstance().newXPath();
 145         // FIXME: BUG-7956: xPath.setNamespaceContext(nsContext);
 146         return (boolean) xPath.compile(this.filter).evaluate(docOfXml, XPathConstants.BOOLEAN);
 147     }
 148 }