restconf/restconf-nb/src/main/java/org/opendaylight/restconf/nb/rfc8040/streams/listeners/AbstractCommonSubscriber.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 static com.google.common.base.Preconditions.checkArgument;
  11 import static com.google.common.base.Preconditions.checkState;
  12 import static java.util.Objects.requireNonNull;
  13
  14 import com.google.common.base.MoreObjects;
  15 import java.time.Instant;
  16 import java.time.format.DateTimeFormatter;
  17 import java.time.format.DateTimeFormatterBuilder;
  18 import java.time.format.DateTimeParseException;
  19 import java.time.temporal.ChronoField;
  20 import java.time.temporal.TemporalAccessor;
  21 import java.util.HashSet;
  22 import java.util.Iterator;
  23 import java.util.Set;
  24 import java.util.concurrent.ExecutionException;
  25 import javax.xml.xpath.XPathExpressionException;
  26 import org.checkerframework.checker.lock.qual.GuardedBy;
  27 import org.checkerframework.checker.lock.qual.Holding;
  28 import org.eclipse.jdt.annotation.NonNull;
  29 import org.opendaylight.restconf.common.errors.RestconfDocumentedException;
  30 import org.opendaylight.restconf.nb.rfc8040.NotificationQueryParams;
  31 import org.opendaylight.restconf.nb.rfc8040.streams.StreamSessionHandler;
  32 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.DateAndTime;
  33 import org.opendaylight.yang.gen.v1.urn.sal.restconf.event.subscription.rev140708.NotificationOutputTypeGrouping.NotificationOutputType;
  34 import org.opendaylight.yangtools.concepts.Registration;
  35 import org.opendaylight.yangtools.yang.common.QName;
  36 import org.slf4j.Logger;
  37 import org.slf4j.LoggerFactory;
  38
  39 /**
  40  * Features of subscribing part of both notifications.
  41  */
  42 abstract class AbstractCommonSubscriber<P, T> extends AbstractNotificationsData implements BaseListenerInterface {
  43     private static final Logger LOG = LoggerFactory.getLogger(AbstractCommonSubscriber.class);
  44     private static final DateTimeFormatter FORMATTER = new DateTimeFormatterBuilder()
  45         .appendValue(ChronoField.YEAR, 4).appendLiteral('-')
  46         .appendValue(ChronoField.MONTH_OF_YEAR, 2).appendLiteral('-')
  47         .appendValue(ChronoField.DAY_OF_MONTH, 2).appendLiteral('T')
  48         .appendValue(ChronoField.HOUR_OF_DAY, 2).appendLiteral(':')
  49         .appendValue(ChronoField.MINUTE_OF_HOUR, 2).appendLiteral(':')
  50         .appendValue(ChronoField.SECOND_OF_MINUTE, 2)
  51         .appendFraction(ChronoField.NANO_OF_SECOND, 0, 9, true)
  52         .appendOffset("+HH:MM", "Z").toFormatter();
  53
  54     private final EventFormatterFactory<T> formatterFactory;
  55     private final NotificationOutputType outputType;
  56     private final String streamName;
  57     private final P path;
  58
  59     @GuardedBy("this")
  60     private final Set<StreamSessionHandler> subscribers = new HashSet<>();
  61     @GuardedBy("this")
  62     private Registration registration;
  63
  64     // FIXME: these should be final
  65     private Instant start = null;
  66     private Instant stop = null;
  67     private boolean leafNodesOnly = false;
  68     private boolean skipNotificationData = false;
  69     private EventFormatter<T> formatter;
  70
  71     AbstractCommonSubscriber(final QName lastQName, final String streamName, final P path,
  72             final NotificationOutputType outputType, final EventFormatterFactory<T> formatterFactory) {
  73         super(lastQName);
  74         this.streamName = requireNonNull(streamName);
  75         checkArgument(!streamName.isEmpty());
  76         this.path = requireNonNull(path);
  77
  78         this.outputType = requireNonNull(outputType);
  79         this.formatterFactory = requireNonNull(formatterFactory);
  80         formatter = formatterFactory.getFormatter();
  81     }
  82
  83     @Override
  84     public final String getStreamName() {
  85         return streamName;
  86     }
  87
  88     @Override
  89     public final String getOutputType() {
  90         return outputType.getName();
  91     }
  92
  93     @Override
  94     public final synchronized boolean hasSubscribers() {
  95         return !subscribers.isEmpty();
  96     }
  97
  98     @Override
  99     public final synchronized Set<StreamSessionHandler> getSubscribers() {
 100         return new HashSet<>(subscribers);
 101     }
 102
 103     @Override
 104     public final synchronized void close() throws InterruptedException, ExecutionException {
 105         if (registration != null) {
 106             registration.close();
 107             registration = null;
 108         }
 109         deleteDataInDS().get();
 110         subscribers.clear();
 111     }
 112
 113     @Override
 114     public synchronized void addSubscriber(final StreamSessionHandler subscriber) {
 115         final boolean isConnected = subscriber.isConnected();
 116         checkState(isConnected);
 117         LOG.debug("Subscriber {} is added.", subscriber);
 118         subscribers.add(subscriber);
 119     }
 120
 121     @Override
 122     public synchronized void removeSubscriber(final StreamSessionHandler subscriber) {
 123         final boolean isConnected = subscriber.isConnected();
 124         checkState(isConnected);
 125         LOG.debug("Subscriber {} is removed", subscriber);
 126         subscribers.remove(subscriber);
 127         if (!hasSubscribers()) {
 128             ListenersBroker.getInstance().removeAndCloseListener(this);
 129         }
 130     }
 131
 132     public final Instant getStart() {
 133         return start;
 134     }
 135
 136     /**
 137      * Set query parameters for listener.
 138      *
 139      * @param params NotificationQueryParams to use.
 140      */
 141     public final void setQueryParams(final NotificationQueryParams params) {
 142         final var startTime = params.startTime();
 143         start = startTime == null ? Instant.now() : parseDateAndTime(startTime.value());
 144
 145         final var stopTime = params.stopTime();
 146         stop = stopTime == null ? null : parseDateAndTime(stopTime.value());
 147
 148         final var leafNodes = params.leafNodesOnly();
 149         leafNodesOnly = leafNodes == null ? false : leafNodes.value();
 150
 151         final var skipData = params.skipNotificationData();
 152         skipNotificationData = skipData == null ? false : skipData.value();
 153
 154         final var filter = params.filter();
 155         final String filterValue = filter == null ? null : filter.paramValue();
 156         if (filterValue != null && !filterValue.isEmpty()) {
 157             try {
 158                 formatter = formatterFactory.getFormatter(filterValue);
 159             } catch (XPathExpressionException e) {
 160                 throw new IllegalArgumentException("Failed to get filter", e);
 161             }
 162         } else {
 163             formatter = formatterFactory.getFormatter();
 164         }
 165     }
 166
 167     final P path() {
 168         return path;
 169     }
 170
 171     /**
 172      * Check whether this query should only notify about leaf node changes.
 173      *
 174      * @return true if this query should only notify about leaf node changes
 175      */
 176     final boolean getLeafNodesOnly() {
 177         return leafNodesOnly;
 178     }
 179
 180     /**
 181      * Check whether this query should notify changes without data.
 182      *
 183      * @return true if this query should notify about changes with  data
 184      */
 185     final boolean isSkipNotificationData() {
 186         return skipNotificationData;
 187     }
 188
 189     final EventFormatter<T> formatter() {
 190         return formatter;
 191     }
 192
 193     /**
 194      * Sets {@link Registration} registration.
 195      *
 196      * @param registration a listener registration registration.
 197      */
 198     @Holding("this")
 199     final void setRegistration(final Registration registration) {
 200         this.registration = requireNonNull(registration);
 201     }
 202
 203     /**
 204      * Checks if {@link Registration} registration exists.
 205      *
 206      * @return {@code true} if exists, {@code false} otherwise.
 207      */
 208     @Holding("this")
 209     final boolean isListening() {
 210         return registration != null;
 211     }
 212
 213     /**
 214      * Post data to subscribed SSE session handlers.
 215      *
 216      * @param data Data of incoming notifications.
 217      */
 218     synchronized void post(final String data) {
 219         final Iterator<StreamSessionHandler> iterator = subscribers.iterator();
 220         while (iterator.hasNext()) {
 221             final StreamSessionHandler subscriber = iterator.next();
 222             final boolean isConnected = subscriber.isConnected();
 223             if (isConnected) {
 224                 subscriber.sendDataMessage(data);
 225                 LOG.debug("Data was sent to subscriber {} on connection {}:", this, subscriber);
 226             } else {
 227                 // removal is probably not necessary, because it will be removed explicitly soon after invocation of
 228                 // onWebSocketClosed(..) in handler; but just to be sure ...
 229                 iterator.remove();
 230                 LOG.debug("Subscriber for {} was removed - web-socket session is not open.", this);
 231             }
 232         }
 233     }
 234
 235     @SuppressWarnings("checkstyle:IllegalCatch")
 236     final boolean checkStartStop(final Instant now) {
 237         if (stop != null) {
 238             if (start.compareTo(now) < 0 && stop.compareTo(now) > 0) {
 239                 return true;
 240             }
 241             if (stop.compareTo(now) < 0) {
 242                 try {
 243                     close();
 244                 } catch (final Exception e) {
 245                     throw new RestconfDocumentedException("Problem with unregister listener." + e);
 246                 }
 247             }
 248         } else if (start != null) {
 249             if (start.compareTo(now) < 0) {
 250                 start = null;
 251                 return true;
 252             }
 253         } else {
 254             return true;
 255         }
 256         return false;
 257     }
 258
 259     @Override
 260     public final String toString() {
 261         return MoreObjects.toStringHelper(this)
 262             .add("path", path)
 263             .add("stream-name", streamName)
 264             .add("output-type", getOutputType())
 265             .toString();
 266     }
 267
 268     /**
 269      * Parse input of query parameters - start-time or stop-time - from {@link DateAndTime} format
 270      * to {@link Instant} format.
 271      *
 272      * @param uriValue Start-time or stop-time as string in {@link DateAndTime} format.
 273      * @return Parsed {@link Instant} by entry.
 274      */
 275     private static @NonNull Instant parseDateAndTime(final DateAndTime dateAndTime) {
 276         final TemporalAccessor accessor;
 277         try {
 278             accessor = FORMATTER.parse(dateAndTime.getValue());
 279         } catch (final DateTimeParseException e) {
 280             throw new RestconfDocumentedException("Cannot parse of value in date: " + dateAndTime, e);
 281         }
 282         return Instant.from(accessor);
 283     }
 284 }