restconf/restconf-nb-rfc8040/src/main/java/org/opendaylight/restconf/nb/rfc8040/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.restconf.nb.rfc8040.streams.listeners;
   9
  10 import java.time.Instant;
  11 import java.time.format.DateTimeFormatter;
  12 import java.time.format.DateTimeFormatterBuilder;
  13 import java.time.format.DateTimeParseException;
  14 import java.time.temporal.ChronoField;
  15 import java.time.temporal.TemporalAccessor;
  16 import javax.xml.xpath.XPathExpressionException;
  17 import org.eclipse.jdt.annotation.NonNull;
  18 import org.eclipse.jdt.annotation.Nullable;
  19 import org.opendaylight.restconf.common.errors.RestconfDocumentedException;
  20 import org.opendaylight.restconf.nb.rfc8040.FilterParam;
  21 import org.opendaylight.restconf.nb.rfc8040.SkipNotificationDataParam;
  22 import org.opendaylight.restconf.nb.rfc8040.StartTimeParam;
  23 import org.opendaylight.restconf.nb.rfc8040.StopTimeParam;
  24 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.DateAndTime;
  25
  26 /**
  27  * Features of query parameters part of both notifications.
  28  */
  29 abstract class AbstractQueryParams extends AbstractNotificationsData {
  30     private static final DateTimeFormatter FORMATTER = new DateTimeFormatterBuilder()
  31         .appendValue(ChronoField.YEAR, 4).appendLiteral('-')
  32         .appendValue(ChronoField.MONTH_OF_YEAR, 2).appendLiteral('-')
  33         .appendValue(ChronoField.DAY_OF_MONTH, 2).appendLiteral('T')
  34         .appendValue(ChronoField.HOUR_OF_DAY, 2).appendLiteral(':')
  35         .appendValue(ChronoField.MINUTE_OF_HOUR, 2).appendLiteral(':')
  36         .appendValue(ChronoField.SECOND_OF_MINUTE, 2)
  37         .appendFraction(ChronoField.NANO_OF_SECOND, 0, 9, true)
  38         .appendOffset("+HH:MM", "Z").toFormatter();
  39
  40     // FIXME: these should be final
  41     private Instant start = null;
  42     private Instant stop = null;
  43     private boolean leafNodesOnly = false;
  44     private boolean skipNotificationData = false;
  45
  46     public final Instant getStart() {
  47         return start;
  48     }
  49
  50     /**
  51      * Set query parameters for listener.
  52      *
  53      * @param startTime     Start-time of getting notification.
  54      * @param stopTime      Stop-time of getting notification.
  55      * @param filter        Indicates which subset of all possible events are of interest.
  56      * @param leafNodesOnly If TRUE, notifications will contain changes of leaf nodes only.
  57      */
  58     @SuppressWarnings("checkstyle:hiddenField")
  59     public final void setQueryParams(final StartTimeParam startTime, final StopTimeParam stopTime,
  60             final FilterParam filter, final boolean leafNodesOnly,
  61             final SkipNotificationDataParam skipNotificationData) {
  62         start = startTime == null ? Instant.now() : parseDateAndTime(startTime.value());
  63         stop = stopTime == null ? null : parseDateAndTime(stopTime.value());
  64         this.leafNodesOnly = leafNodesOnly;
  65         this.skipNotificationData = skipNotificationData == null ? false : skipNotificationData.value();
  66
  67         if (filter != null) {
  68             try {
  69                 setFilter(filter.paramValue());
  70             } catch (XPathExpressionException e) {
  71                 throw new IllegalArgumentException("Failed to get filter", e);
  72             }
  73         }
  74     }
  75
  76     abstract void setFilter(@Nullable String xpathString) throws XPathExpressionException;
  77
  78     /**
  79      * Parse input of query parameters - start-time or stop-time - from {@link DateAndTime} format
  80      * to {@link Instant} format.
  81      *
  82      * @param uriValue Start-time or stop-time as string in {@link DateAndTime} format.
  83      * @return Parsed {@link Instant} by entry.
  84      */
  85     private static @NonNull Instant parseDateAndTime(final DateAndTime dateAndTime) {
  86         final TemporalAccessor accessor;
  87         try {
  88             accessor = FORMATTER.parse(dateAndTime.getValue());
  89         } catch (final DateTimeParseException e) {
  90             throw new RestconfDocumentedException("Cannot parse of value in date: " + dateAndTime, e);
  91         }
  92         return Instant.from(accessor);
  93     }
  94
  95     /**
  96      * Check whether this query should only notify about leaf node changes.
  97      *
  98      * @return true if this query should only notify about leaf node changes
  99      */
 100     boolean getLeafNodesOnly() {
 101         return leafNodesOnly;
 102     }
 103
 104     /**
 105      * Check whether this query should notify changes without data.
 106      *
 107      * @return true if this query should notify about changes with  data
 108      */
 109     public boolean isSkipNotificationData() {
 110         return skipNotificationData;
 111     }
 112
 113     @SuppressWarnings("checkstyle:IllegalCatch")
 114     <T extends BaseListenerInterface> boolean checkStartStop(final Instant now, final T listener) {
 115         if (stop != null) {
 116             if (start.compareTo(now) < 0 && stop.compareTo(now) > 0) {
 117                 return true;
 118             }
 119             if (stop.compareTo(now) < 0) {
 120                 try {
 121                     listener.close();
 122                 } catch (final Exception e) {
 123                     throw new RestconfDocumentedException("Problem with unregister listener." + e);
 124                 }
 125             }
 126         } else if (start != null) {
 127             if (start.compareTo(now) < 0) {
 128                 start = null;
 129                 return true;
 130             }
 131         } else {
 132             return true;
 133         }
 134         return false;
 135     }
 136 }